orbtk_utils

Struct Constraint

Source
pub struct Constraint { /* private fields */ }
Expand description

Constraint describes the constraints properties of a box entity.

Implementations§

Source§

impl Constraint

The Constraint is used to manage the constraint porperties of an entity.

Constraints will provide properties that are used to determine the size requirements of an entity. It will store minimum and maximim values for its height and width, next to the current values.

Source

pub fn create() -> ConstraintBuilder

Returns a constraint builder.

Source

pub fn width(&self) -> f64

Gets width.

Source

pub fn set_width(&mut self, width: f64)

Sets width.

Source

pub fn height(&self) -> f64

Gets height.

Source

pub fn set_height(&mut self, height: f64)

Sets height.

Source

pub fn size(&self) -> (f64, f64)

Gets the size.

Source

pub fn set_size(&mut self, width: f64, height: f64)

Sets the size.

Source

pub fn min_width(&self) -> f64

Gets min_width.

Source

pub fn set_min_width(&mut self, min_width: f64)

Sets min_width and set width to 0.0.

Source

pub fn min_height(&self) -> f64

Gets min_height.

Source

pub fn set_min_height(&mut self, min_height: f64)

Sets min_height and set height to min_height if height < min_height.

Source

pub fn min_size(&self) -> (f64, f64)

Gets the min_size.

Source

pub fn set_min_size(&mut self, min_width: f64, min_height: f64)

Sets the min size.

Source

pub fn max_width(&self) -> f64

Gets max_width.

Source

pub fn set_max_width(&mut self, max_width: f64)

Sets max_width and set width to 0.0.

Source

pub fn max_height(&self) -> f64

Gets max_height.

Source

pub fn set_max_height(&mut self, max_height: f64)

Sets max_height and set height to 0.0.

Source

pub fn max_size(&self) -> (f64, f64)

Gets the max_size.

Source

pub fn set_max_size(&mut self, max_width: f64, max_height: f64)

Sets the max size.

Source

pub fn perform(&self, size: (f64, f64)) -> (f64, f64)

Adjust the given size.

Asures that size will respect the defined box values for min and max constraints. The value will be adapted if outside of a bound.

Trait Implementations§

Source§

impl Clone for Constraint

Source§

fn clone(&self) -> Constraint

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Constraint

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Constraint

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<ConstraintBuilder> for Constraint

Source§

fn from(builder: ConstraintBuilder) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Constraint

Source§

fn eq(&self, other: &Constraint) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Constraint

Source§

impl StructuralPartialEq for Constraint

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.