Struct Matrix 

pub struct Matrix {
    pub m11: f64,
    pub m12: f64,
    pub m13: f64,
    pub m21: f64,
    pub m22: f64,
    pub m23: f64,
    pub m31: f64,
    pub m32: f64,
    pub m33: f64,
}

A 3x3 matrix.

Matrix layout:

        | 1st col | 2nd col | 3rd col |
1st row | scaleX  | skewY   | perspX  |
2nd row | skewX   | scaleY  | perspY  |
3rd row | transX  | transY  | perspZ  |

Note: the default value is the all-zero matrix, not the identity.

Fields

m11: f64

The first element of the first row (scaleX).

m12: f64

The second element of the first row (skewY).

m13: f64

The third element of the first row (perspX).

m21: f64

The first element of the second row (skewX).

m22: f64

The second element of the second row (scaleY).

m23: f64

The third element of the second row (perspY).

m31: f64

The first element of the third row (offsetX/translateX).

m32: f64

The second element of the third row (offsetY/translateY).

m33: f64

The third element of the third row (perspZ).

Implementations

impl Matrix

pub const IDENTITY: Matrix

A multiplicative identity matrix.

pub const fn new( scale_x: f64, skew_y: f64, skew_x: f64, scale_y: f64, offset_x: f64, offset_y: f64, ) -> Self

Initializes an affine Matrix (the third column is 0, 0, 1).

pub const fn new_3x3( scale_x: f64, skew_y: f64, persp_x: f64, skew_x: f64, scale_y: f64, persp_y: f64, offset_x: f64, offset_y: f64, persp_z: f64, ) -> Self

Initializes a full 3x3 Matrix, given in row order.

pub fn is_identity(&self) -> bool

Returns whether the matrix is the multiplicative identity matrix or not.

pub fn has_inverse(&self) -> bool

Returns whether the matrix has an inverse.

pub fn create_rotation(radians: f64) -> Matrix

Creates a rotation matrix using the given rotation in radians.

pub fn create_rotation_at(radians: f64, center: Point) -> Matrix

Creates a rotation matrix using the given rotation in radians around a center point.

pub fn create_skew(x_angle: f64, y_angle: f64) -> Matrix

Creates a skew matrix from the given axis skew angles in radians.

pub const fn create_scale(x_scale: f64, y_scale: f64) -> Matrix

Creates a scale matrix from the given X and Y components.

pub const fn create_scale_vector(scales: Vector) -> Matrix

Creates a scale matrix from the given vector scale.

pub const fn create_translation_vector(position: Vector) -> Matrix

Creates a translation matrix from the given vector.

pub const fn create_translation(x_position: f64, y_position: f64) -> Matrix

Creates a translation matrix from the given X and Y components.

pub fn to_radians(angle: f64) -> f64

Converts an angle in degrees to radians.

pub fn append(&self, value: Matrix) -> Matrix

Appends another matrix as post-multiplication operation. Equivalent to self * value.

pub fn prepend(&self, value: Matrix) -> Matrix

Prepends another matrix as pre-multiplication operation. Equivalent to value * self.

pub fn get_determinant(&self) -> f64

Calculates the determinant for this matrix.

pub fn transform(&self, p: Point) -> Point

Transforms the point with the matrix.

pub fn equals(&self, other: Matrix) -> bool

Returns a boolean indicating whether the matrix is equal to the other given matrix (exact comparison of every element).

pub fn contains_perspective(&self) -> bool

Determines if the current matrix contains perspective (non-affine) transforms.

pub fn try_invert(&self) -> Option<Matrix>

Attempts to invert the matrix. Returns None when it is not invertible.

pub fn invert(&self) -> Matrix

Inverts the matrix.

Panics

Panics if the matrix is not invertible; use try_invert when that is a possibility.

pub fn parse(s: &str) -> Result<Self, FormatError>

Parses a Matrix string: six (affine) or nine comma/space separated values.

Nine values are given in the order m11, m12, m21, m22, m31, m32, m13, m23, m33.

pub fn try_decompose_transform(matrix: Matrix) -> Option<MatrixDecomposed>

Decomposes the given matrix into translation, rotation, scale and skew. Returns None for singular matrices and matrices containing perspective.

Trait Implementations

impl BatchValue for Matrix

fn write_to(&self, out: &mut Vec<u8>)

fn read_from(input: &mut BatchValueReader<'_>) -> Self

impl Clone for Matrix

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Matrix

impl Debug for Matrix

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

Formats the value using the given formatter.

impl Default for Matrix

fn default() -> Self

Returns the “default value” for a type.

impl Display for Matrix

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

Formats the value using the given formatter.

impl ExpressionVariantValue for Matrix

const FFI_VARIANT_TYPE: Option<VariantType> = None

The variant type a foreign function parameter of this type is matched against, or None when the type cannot be a foreign function parameter.

fn try_from_variant(v: &ExpressionVariant) -> Option<Self>

See ExpressionVariant::try_cast.

fn into_variant(self) -> ExpressionVariant

See ExpressionVariant::create.

impl From<Matrix> for ExpressionVariant

fn from(value: Matrix) -> ExpressionVariant

Converts to this type from the input type.

impl FromStr for Matrix

type Err = FormatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, FormatError>

Parses a string s to return a value of this type.

impl MarkupTyped for Matrix

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl Mul for Matrix

Multiplies two matrices together and returns the resulting matrix.

type Output = Matrix

The resulting type after applying the * operator.

fn mul(self, value2: Matrix) -> Matrix

Performs the * operation.

impl Mul<Matrix> for Point

Applies a matrix to a point.

type Output = Point

The resulting type after applying the * operator.

fn mul(self, matrix: Matrix) -> Point

Performs the * operation.

impl MulAssign for Matrix

fn mul_assign(&mut self, value: Matrix)

Performs the *= operation.

impl MulAssign<Matrix> for Point

fn mul_assign(&mut self, matrix: Matrix)

Performs the *= operation.

impl Neg for Matrix

Negation is defined as inversion of the matrix.

Panics

Panics if the matrix is not invertible.

type Output = Matrix

The resulting type after applying the - operator.

fn neg(self) -> Matrix

Performs the unary - operation.

impl PartialEq for Matrix

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

Equality operator ==.

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

Inequality operator !=.

impl ServerPropertyValue for Matrix

fn differs(&self, other: &Self) -> bool

fn default_equals(&self, other: &Self) -> bool

impl StructuralPartialEq for Matrix