Struct rfw_math::Mat3A[][src]

#[repr(C)]
pub struct Mat3A(_);
Expand description

A 3x3 column major matrix.

This 3x3 matrix type features convenience methods for creating and using linear and affine transformations. If you are primarily dealing with 2D affine transformations the Affine2 type is much faster and more space efficient than using a 3x3 matrix.

Linear transformations including 3D rotation and scale can be created using methods such as Self::from_diagonal(), Self::from_quat(), Self::from_axis_angle(), Self::from_rotation_x(), Self::from_rotation_y(), or Self::from_rotation_z().

The resulting matrices can be use to transform 3D vectors using regular vector multiplication.

Affine transformations including 2D translation, rotation and scale can be created using methods such as Self::from_translation(), Self::from_angle(), Self::from_scale() and Self::from_scale_angle_translation().

The Self::transform_point2() and Self::transform_vector2() convenience methods are provided for performing affine transforms on 2D vectors and points. These multiply 2D inputs as 3D vectors with an implicit z value of 1 for points and 0 for vectors respectively. These methods assume that Self contains a valid affine transform.

Implementations

A 3x3 matrix with all elements set to 0.0.

A 3x3 identity matrix, where all diagonal elements are 1, and all off-diagonal elements are 0.

Creates a 3x3 matrix from three column vectors.

Creates a 3x3 matrix from a [S; 9] array stored in column major order. If your data is stored in row major you will need to transpose the returned matrix.

Creates a [S; 9] array storing data in column major order. If you require data in row major order transpose the matrix first.

Creates a 3x3 matrix from a [[S; 3]; 3] 2D array stored in column major order. If your data is in row major order you will need to transpose the returned matrix.

Creates a [[S; 3]; 3] 2D array storing data in column major order. If you require data in row major order transpose the matrix first.

Creates a 3x3 matrix with its diagonal set to diagonal and all other entries set to 0. The resulting matrix is a 3D scale transfom.

Creates a 3x3 matrix from a 4x4 matrix, discarding the 3rd row and column.

Creates a 3D rotation matrix from the given quaternion.

Panics

Will panic if rotation is not normalized when glam_assert is enabled.

Creates a 3D rotation matrix from a normalized rotation axis and angle (in radians).

Panics

Will panic if axis is not normalized when glam_assert is enabled.

Creates a 3D rotation matrix from the given euler rotation sequence and the angles (in radians).

Creates a 3D rotation matrix from angle (in radians) around the x axis.

Creates a 3D rotation matrix from angle (in radians) around the y axis.

Creates a 3D rotation matrix from angle (in radians) around the z axis.

Creates an affine transformation matrix from the given 2D translation.

The resulting matrix can be used to transform 2D points and vectors. See Self::transform_point2() and Self::transform_vector2().

Creates an affine transformation matrix from the given 2D rotation angle (in radians).

The resulting matrix can be used to transform 2D points and vectors. See Self::transform_point2() and Self::transform_vector2().

Creates an affine transformation matrix from the given 2D scale, rotation angle (in radians) and translation.

The resulting matrix can be used to transform 2D points and vectors. See Self::transform_point2() and Self::transform_vector2().

Creates an affine transformation matrix from the given non-uniform 2D scale.

The resulting matrix can be used to transform 2D points and vectors. See Self::transform_point2() and Self::transform_vector2().

Panics

Will panic if all elements of scale are zero when glam_assert is enabled.

Creates an affine transformation matrix from the given 2x2 matrix.

The resulting matrix can be used to transform 2D points and vectors. See Self::transform_point2() and Self::transform_vector2().

Creates a 3x3 matrix from the first 9 values in slice.

Panics

Panics if slice is less than 9 elements long.

Writes the columns of self to the first 9 elements in slice.

Panics

Panics if slice is less than 9 elements long.

Returns the matrix column for the given index.

Panics

Panics if index is greater than 2.

Returns a mutable reference to the matrix column for the given index.

Panics

Panics if index is greater than 2.

Returns the matrix row for the given index.

Panics

Panics if index is greater than 2.

Returns true if, and only if, all elements are finite. If any element is either NaN, positive or negative infinity, this will return false.

Returns true if any elements are NaN.

Returns the transpose of self.

Returns the determinant of self.

Returns the inverse of self.

If the matrix is not invertible the returned matrix will be invalid.

Panics

Will panic if the determinant of self is zero when glam_assert is enabled.

Transforms a 3D vector.

Multiplies two 3x3 matrices.

Adds two 3x3 matrices.

Subtracts two 3x3 matrices.

Multiplies a 3x3 matrix by a scalar.

Transforms the given 2D vector as a point.

This is the equivalent of multiplying other as a 3D vector where z is 1.

This method assumes that self contains a valid affine transform.

Rotates the given 2D vector.

This is the equivalent of multiplying other as a 3D vector where z is 0.

This method assumes that self contains a valid affine transform.

Returns true if the absolute difference of all elements between self and other is less than or equal to max_abs_diff.

This can be used to compare if two matrices contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more see comparing floating point numbers.

Transforms a Vec3A.

Trait Implementations

The resulting type after applying the + operator.

Performs the + operation. Read more

Performs the += operation. Read more

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

Formats the value using the given formatter. Read more

Performs the conversion.

Performs the conversion.

Performs the conversion.

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

Performs the *= operation. Read more

Performs the *= operation. Read more

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

This method tests for !=.

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

Performs the -= operation. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.