Struct ux::ActorBox

pub struct ActorBox(_);

Implementations

impl ActorBox

pub fn new(x_1: f32, y_1: f32, x_2: f32, y_2: f32) -> ActorBox

Allocates a new ActorBox using the passed coordinates for the top left and bottom right points.

This function is the logical equivalent of:

  actor_box_init (actor_box_alloc (),
                          x_1, y_1,
                          x_2, y_2);

x_1

X coordinate of the top left point

y_1

Y coordinate of the top left point

x_2

X coordinate of the bottom right point

y_2

Y coordinate of the bottom right point

Returns

the newly allocated ActorBox. Use ActorBox::free to free the resources

pub fn contains(&self, x: f32, y: f32) -> bool

Checks whether a point with x, y coordinates is contained withing self

x

X coordinate of the point

y

Y coordinate of the point

Returns

true if the point is contained by the ActorBox

pub fn get_area(&self) -> f32

Retrieves the area of self

Returns

the area of a ActorBox, in pixels

pub fn get_height(&self) -> f32

Retrieves the height of the self

Returns

the height of the box

pub fn get_origin(&self) -> (f32, f32)

Retrieves the origin of self

x

return location for the X coordinate, or None

y

return location for the Y coordinate, or None

pub fn get_size(&self) -> (f32, f32)

Retrieves the size of self

width

return location for the width, or None

height

return location for the height, or None

pub fn get_width(&self) -> f32

Retrieves the width of the self

Returns

the width of the box

pub fn get_x(&self) -> f32

Retrieves the X coordinate of the origin of self

Returns

the X coordinate of the origin

pub fn get_y(&self) -> f32

Retrieves the Y coordinate of the origin of self

Returns

the Y coordinate of the origin

pub fn init(
    &mut self,
    x_1: f32,
    y_1: f32,
    x_2: f32,
    y_2: f32
) -> Option<ActorBox>

Initializes self with the given coordinates.

x_1

X coordinate of the top left point

y_1

Y coordinate of the top left point

x_2

X coordinate of the bottom right point

y_2

Y coordinate of the bottom right point

Returns

the initialized ActorBox

pub fn init_rect(&mut self, x: f32, y: f32, width: f32, height: f32)

Initializes self with the given origin and size.

x

X coordinate of the origin

y

Y coordinate of the origin

width

width of the box

height

height of the box

pub fn interpolate(&self, final_: &ActorBox, progress: f64) -> ActorBox

Interpolates between self and final_ ActorBoxes using progress

final_

the final ActorBox

progress

the interpolation progress

result

return location for the interpolation

pub fn set_origin(&mut self, x: f32, y: f32)

Changes the origin of self, maintaining the size of the ActorBox.

x

the X coordinate of the new origin

y

the Y coordinate of the new origin

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

Sets the size of self, maintaining the origin of the ActorBox.

width

the new width

height

the new height

pub fn union(&self, b: &ActorBox) -> ActorBox

Unions the two boxes self and b and stores the result in result.

b

the second ActorBox

result

the ActorBox representing a union of self and b

pub fn alloc() -> Option<ActorBox>

Allocates a new ActorBox.

Returns

the newly allocated ActorBox. Use ActorBox::free to free its resources

Trait Implementations

impl Clone for ActorBox

pub fn clone(&self) -> ActorBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActorBox

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

Formats the value using the given formatter.

impl Eq for ActorBox

impl Ord for ActorBox

pub fn cmp(&self, other: &ActorBox) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ActorBox> for ActorBox

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialOrd<ActorBox> for ActorBox

pub fn partial_cmp(&self, other: &ActorBox) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ActorBox

pub fn static_type() -> Type

Returns the type identifier of Self.