Struct ux::prelude::dx::MatrixEntry

pub struct MatrixEntry(_);

Implementations

impl MatrixEntry

pub fn calculate_translation(
    &self,
    other: &MatrixEntry
) -> (bool, f32, f32, f32)

Determines if the only difference between two transforms is a translation and if so returns what the x, y, and z components of the translation are.

If the difference between the two translations involves anything other than a translation then the function returns false.

other

A second reference transform

x

The destination for the x-component of the translation

y

The destination for the y-component of the translation

z

The destination for the z-component of the translation

Returns

true if the only difference between the transform of self and the transform of other is a translation, otherwise false.

pub fn get(&self) -> (Matrix, Matrix)

Resolves the current self transform into a Matrix by combining the sequence of operations that have been applied to build up the current transform.

There are two possible ways that this function may return its result depending on whether it’s possible to directly point to an internal Matrix or whether the result needs to be composed of multiple operations.

If an internal matrix contains the required result then this function will directly return a pointer to that matrix, otherwise if the function returns None then matrix will be initialized to match the transform of self.

<note>``matrix will be left untouched if a direct pointer is returned.</note>

matrix

The potential destination for the transform as a matrix

Returns

A direct pointer to a Matrix transform or None and in that case matrix will be initialized with the effective transform represented by self.

pub fn is_identity(&self) -> bool

Determines whether self is known to represent an identity transform.

If this returns true then the entry is definitely the identity matrix. If it returns false it may or may not be the identity matrix but no expensive comparison is performed to verify it.

Returns

true if self is definitely an identity transform, otherwise false.

Trait Implementations

impl Clone for MatrixEntry

pub fn clone(&self) -> MatrixEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MatrixEntry

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

Formats the value using the given formatter.

impl Eq for MatrixEntry

impl Ord for MatrixEntry

pub fn cmp(&self, other: &MatrixEntry) -> 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<MatrixEntry> for MatrixEntry

pub fn eq(&self, other: &MatrixEntry) -> 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<MatrixEntry> for MatrixEntry

pub fn partial_cmp(&self, other: &MatrixEntry) -> 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 MatrixEntry

pub fn static_type() -> Type

Returns the type identifier of Self.