Struct glam::f64::DMat3[−][src]

#[repr(C)]
pub struct DMat3(_);

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

`impl DMat3`[src]

`pub const ZERO: Self`[src]

A 3x3 matrix with all elements set to 0.0.

`pub const IDENTITY: Self`[src]

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

`pub fn from_cols(x_axis: DVec3, y_axis: DVec3, z_axis: DVec3) -> Self`[src]

Creates a 3x3 matrix from three column vectors.

`pub fn from_cols_array(m: &[f64; 9]) -> Self`[src]

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.

`pub fn to_cols_array(&self) -> [f64; 9]`[src]

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

`pub fn from_cols_array_2d(m: &[[f64; 3]; 3]) -> Self`[src]

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.

`pub fn to_cols_array_2d(&self) -> [[f64; 3]; 3]`[src]

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.

`pub fn from_diagonal(diagonal: DVec3) -> Self`[src]

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.

`pub fn from_quat(rotation: DQuat) -> Self`[src]

Creates a 3D rotation matrix from the given quaternion.

`pub fn from_axis_angle(axis: DVec3, angle: f64) -> Self`[src]

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

`pub fn from_rotation_ypr(yaw: f64, pitch: f64, roll: f64) -> Self`[src]

👎 Deprecated since 0.15.0:

Please use from_euler(EulerRot::YXZ, yaw, pitch, roll) instead

`pub fn from_euler(order: EulerRot, a: f64, b: f64, c: f64) -> Self`[src]

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

`pub fn from_rotation_x(angle: f64) -> Self`[src]

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

`pub fn from_rotation_y(angle: f64) -> Self`[src]

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

`pub fn from_rotation_z(angle: f64) -> Self`[src]

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

`pub fn from_translation(translation: DVec2) -> Self`[src]

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().

`pub fn from_angle(angle: f64) -> Self`[src]

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().

`pub fn from_scale_angle_translation( scale: DVec2, angle: f64, translation: DVec2 ) -> Self`[src]

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().

`pub fn from_scale(scale: DVec2) -> Self`[src]

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().

`pub fn from_cols_slice(slice: &[f64]) -> Self`[src]

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

Panics

Panics if slice is less than 9 elements long.

`pub fn write_cols_to_slice(self, slice: &mut [f64])`[src]

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

Panics

Panics if slice is less than 9 elements long.

`pub fn col(&self, index: usize) -> DVec3`[src]

Returns the matrix column for the given index.

Panics

Panics if index is greater than 2.

`pub fn row(&self, index: usize) -> DVec3`[src]

Returns the matrix row for the given index.

Panics

Panics if index is greater than 2.

`pub fn is_finite(&self) -> bool`[src]

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

`pub fn is_nan(&self) -> bool`[src]

Returns true if any elements are NaN.

`pub fn transpose(&self) -> Self`[src]

Returns the transpose of self.

`pub fn determinant(&self) -> f64`[src]

Returns the determinant of self.

`pub fn inverse(&self) -> Self`[src]

Returns the inverse of self.

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

`pub fn mul_vec3(&self, other: DVec3) -> DVec3`[src]

Transforms a 3D vector.

`pub fn mul_mat3(&self, other: &Self) -> Self`[src]

Multiplies two 3x3 matrices.

`pub fn add_mat3(&self, other: &Self) -> Self`[src]

Adds two 3x3 matrices.

`pub fn sub_mat3(&self, other: &Self) -> Self`[src]

Subtracts two 3x3 matrices.

`pub fn mul_scalar(&self, other: f64) -> Self`[src]

Multiplies a 3x3 matrix by a scalar.

`pub fn transform_point2(&self, other: DVec2) -> DVec2`[src]

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.

`pub fn transform_vector2(&self, other: DVec2) -> DVec2`[src]

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.

`pub fn abs_diff_eq(&self, other: Self, max_abs_diff: f64) -> bool`[src]

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.

`pub fn as_f32(&self) -> Mat3`[src]

Trait Implementations

`impl Add<DMat3> for DMat3`[src]

`type Output = Self`

The resulting type after applying the + operator.

`fn add(self, other: Self) -> Self`[src]

Performs the + operation. Read more

`impl AsMut<[f64; 9]> for DMat3`[src]

`fn as_mut(&mut self) -> &mut [f64; 9]`[src]

Performs the conversion.

`impl AsRef<[f64; 9]> for DMat3`[src]

`fn as_ref(&self) -> &[f64; 9]`[src]

Performs the conversion.

`impl Clone for DMat3`[src]

`fn clone(&self) -> DMat3`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl Debug for DMat3`[src]

`fn fmt(&self, fmt: &mut Formatter<'_>) -> Result`[src]

Formats the value using the given formatter. Read more

`impl Default for DMat3`[src]

`fn default() -> Self`[src]

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

`impl Deref for DMat3`[src]

`type Target = Columns3<DVec3>`

The resulting type after dereferencing.

`fn deref(&self) -> &Self::Target`[src]

Dereferences the value.

`impl DerefMut for DMat3`[src]

`fn deref_mut(&mut self) -> &mut Self::Target`[src]

Mutably dereferences the value.

`impl Display for DMat3`[src]

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

Formats the value using the given formatter. Read more

`impl From<DAffine2> for DMat3`[src]

`fn from(m: DAffine2) -> DMat3`[src]

Performs the conversion.

`impl From<DMat3> for DMat2`[src]

`fn from(m: DMat3) -> DMat2`[src]

Creates a 2x2 matrix from the top left submatrix of the given 3x3 matrix.

`impl From<DMat4> for DMat3`[src]

`fn from(m: DMat4) -> DMat3`[src]

Creates a 3x3 matrix from the top left submatrix of the given 4x4 matrix.