Struct Affine3 

#[repr(C)]
pub struct Affine3 {
    pub matrix3: Mat3,
    pub translation: Vec3,
}

A 3D affine transform, which can represent translation, rotation, scaling and shear.

Fields

matrix3: Mat3

translation: Vec3

Implementations

impl Affine3

pub const ZERO: Affine3

The degenerate zero transform.

This transforms any finite vector and point to zero. The zero transform is non-invertible.

pub const IDENTITY: Affine3

The identity transform.

Multiplying a vector with this returns the same vector.

pub const NAN: Affine3

All NAN:s.

pub const fn from_cols( x_axis: Vec3, y_axis: Vec3, z_axis: Vec3, w_axis: Vec3, ) -> Affine3

Creates an affine transform from three column vectors.

pub fn from_cols_array(m: &[f32; 12]) -> Affine3

Creates an affine transform from a [f32; 12] array stored in column major order.

pub fn to_cols_array(&self) -> [f32; 12]

Creates a [f32; 12] array storing data in column major order.

pub fn from_cols_array_2d(m: &[[f32; 3]; 4]) -> Affine3

Creates an affine transform from a [[f32; 3]; 4] 3D 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) -> [[f32; 3]; 4]

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

pub fn from_cols_slice(slice: &[f32]) -> Affine3

Creates an affine transform from the first 12 values in slice.

Panics

Panics if slice is less than 12 elements long.

pub fn write_cols_to_slice(&self, slice: &mut [f32])

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

Panics

Panics if slice is less than 12 elements long.

pub fn from_scale(scale: Vec3) -> Affine3

Creates an affine transform that changes scale. Note that if any scale is zero the transform will be non-invertible.

pub fn from_quat(rotation: Quat) -> Affine3

Creates an affine transform from the given rotation quaternion.

pub fn from_axis_angle(axis: Vec3, angle: f32) -> Affine3

Creates an affine transform containing a 3D rotation around a normalized rotation axis of angle (in radians).

pub fn from_rotation_x(angle: f32) -> Affine3

Creates an affine transform containing a 3D rotation around the x axis of angle (in radians).

pub fn from_rotation_y(angle: f32) -> Affine3

Creates an affine transform containing a 3D rotation around the y axis of angle (in radians).

pub fn from_rotation_z(angle: f32) -> Affine3

Creates an affine transform containing a 3D rotation around the z axis of angle (in radians).

pub fn from_translation(translation: Vec3) -> Affine3

Creates an affine transformation from the given 3D translation.

pub fn from_mat3(mat3: Mat3) -> Affine3

Creates an affine transform from a 3x3 matrix (expressing scale, shear and rotation)

pub fn from_mat3_translation(mat3: Mat3, translation: Vec3) -> Affine3

Creates an affine transform from a 3x3 matrix (expressing scale, shear and rotation) and a translation vector.

Equivalent to Affine3::from_translation(translation) * Affine3::from_mat3(mat3)

pub fn from_scale_rotation_translation( scale: Vec3, rotation: Quat, translation: Vec3, ) -> Affine3

Creates an affine transform from the given 3D scale, rotation and translation.

Equivalent to Affine3::from_translation(translation) * Affine3::from_quat(rotation) * Affine3::from_scale(scale)

pub fn from_rotation_translation(rotation: Quat, translation: Vec3) -> Affine3

Creates an affine transform from the given 3D rotation and translation.

Equivalent to Affine3::from_translation(translation) * Affine3::from_quat(rotation)

pub fn from_mat4(m: Mat4) -> Affine3

The given Mat4 must be an affine transform, i.e. contain no perspective transform.

pub fn to_scale_rotation_translation(&self) -> (Vec3, Quat, Vec3)

Extracts scale, rotation and translation from self.

The transform is expected to be non-degenerate and without shearing, or the output will be invalid.

Panics

Will panic if the determinant self.matrix3 is zero or if the resulting scale vector contains any zero elements when glam_assert is enabled.

pub fn look_to_lh(eye: Vec3, dir: Vec3, up: Vec3) -> Affine3

Creates a left-handed view transform using a camera position, an up direction, and a facing direction.

For a view coordinate system with +X=right, +Y=up and +Z=forward.

pub fn look_to_rh(eye: Vec3, dir: Vec3, up: Vec3) -> Affine3

Creates a right-handed view transform using a camera position, an up direction, and a facing direction.

For a view coordinate system with +X=right, +Y=up and +Z=back.

pub fn look_at_lh(eye: Vec3, center: Vec3, up: Vec3) -> Affine3

Creates a left-handed view transform using a camera position, an up direction, and a focal point. For a view coordinate system with +X=right, +Y=up and +Z=forward.

Panics

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

pub fn look_at_rh(eye: Vec3, center: Vec3, up: Vec3) -> Affine3

Creates a right-handed view transform using a camera position, an up direction, and a focal point. For a view coordinate system with +X=right, +Y=up and +Z=back.

Panics

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

pub fn transform_point3(&self, rhs: Vec3) -> Vec3

Transforms the given 3D points, applying shear, scale, rotation and translation.

pub fn transform_vector3(&self, rhs: Vec3) -> Vec3

Transforms the given 3D vector, applying shear, scale and rotation (but NOT translation).

To also apply translation, use Self::transform_point3() instead.

pub fn is_finite(&self) -> bool

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

Returns true if any elements are NaN.

pub fn abs_diff_eq(&self, rhs: Affine3, max_abs_diff: f32) -> bool

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

This can be used to compare if two 3x4 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 inverse(&self) -> Affine3

Return the inverse of this transform.

Note that if the transform is not invertible the result will be invalid.

pub fn as_daffine3(&self) -> DAffine3

Casts all elements of self to f64.

Trait Implementations

impl AbsDiffEq for Affine3

type Epsilon = <f32 as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <Affine3 as AbsDiffEq>::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq( &self, other: &Affine3, epsilon: <Affine3 as AbsDiffEq>::Epsilon, ) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Affine3Ext for Affine3

fn from_transpose(transposed: [Vec4; 3]) -> Self

Generates an Affine3 from a transposed 3x4 matrix.

fn to_transpose(self) -> [Vec4; 3]

Calculates the transpose of the affine 4x3 matrix to a 3x4 and formats it for packing into GPU buffers

fn inverse_transpose_3x3(self) -> ([Vec4; 2], f32)

Calculates the inverse transpose of the 3x3 matrix and formats it for packing into GPU buffers

impl Clone for Affine3

fn clone(&self) -> Affine3

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Affine3

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

Formats the value using the given formatter.

impl Default for Affine3

fn default() -> Affine3

Returns the “default value” for a type.

impl Deref for Affine3

type Target = Cols4<Vec3>

The resulting type after dereferencing.

fn deref(&self) -> &<Affine3 as Deref>::Target

Dereferences the value.

impl DerefMut for Affine3

fn deref_mut(&mut self) -> &mut <Affine3 as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Affine3

Deserialize expects a sequence of 12 values.

fn deserialize<D>( deserializer: D, ) -> Result<Affine3, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Affine3

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

Formats the value using the given formatter.

impl From<Affine3> for Affine3A

fn from(a: Affine3) -> Affine3A

Converts to this type from the input type.

impl From<Affine3> for Mat4

fn from(m: Affine3) -> Mat4

Converts to this type from the input type.

impl From<Affine3A> for Affine3

fn from(a: Affine3A) -> Affine3

Converts to this type from the input type.

impl From<Isometry3d> for Affine3

fn from(iso: Isometry3d) -> Self

Converts to this type from the input type.

impl FromReflect for Affine3

fn from_reflect(reflect: &(dyn PartialReflect + 'static)) -> Option<Affine3>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Affine3

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Mul<&Affine3> for &Affine3

type Output = Affine3

The resulting type after applying the * operator.

fn mul(self, rhs: &Affine3) -> Affine3

Performs the * operation.

impl Mul<&Affine3> for &Mat4

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: &Affine3) -> Mat4

Performs the * operation.

impl Mul<&Affine3> for Affine3

type Output = Affine3

The resulting type after applying the * operator.

fn mul(self, rhs: &Affine3) -> Affine3

Performs the * operation.

impl Mul<&Affine3> for Mat4

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: &Affine3) -> Mat4

Performs the * operation.

impl Mul<&Mat4> for &Affine3

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: &Mat4) -> Mat4

Performs the * operation.

impl Mul<&Mat4> for Affine3

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: &Mat4) -> Mat4

Performs the * operation.

impl Mul<Affine3> for &Affine3

type Output = Affine3

The resulting type after applying the * operator.

fn mul(self, rhs: Affine3) -> Affine3

Performs the * operation.

impl Mul<Affine3> for &Mat4

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: Affine3) -> Mat4

Performs the * operation.

impl Mul<Affine3> for Mat4

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: Affine3) -> Mat4

Performs the * operation.

impl Mul<Mat4> for &Affine3

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: Mat4) -> Mat4

Performs the * operation.

impl Mul<Mat4> for Affine3

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: Mat4) -> <Affine3 as Mul<Mat4>>::Output

Performs the * operation.

impl Mul for Affine3

type Output = Affine3

The resulting type after applying the * operator.

fn mul(self, rhs: Affine3) -> Affine3

Performs the * operation.

impl MulAssign<&Affine3> for Affine3

fn mul_assign(&mut self, rhs: &Affine3)

Performs the *= operation.

impl MulAssign<&Affine3> for Mat4

fn mul_assign(&mut self, rhs: &Affine3)

Performs the *= operation.

impl MulAssign<Affine3> for Mat4

fn mul_assign(&mut self, rhs: Affine3)

Performs the *= operation.

impl MulAssign for Affine3

fn mul_assign(&mut self, rhs: Affine3)

Performs the *= operation.

impl PartialEq for Affine3

fn eq(&self, rhs: &Affine3) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for Affine3

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Affine3>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Affine3>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Affine3>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

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

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<'a> Product<&'a Affine3> for Affine3

fn product<I>(iter: I) -> Affine3

where I: Iterator<Item = &'a Affine3>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl Reflect for Affine3

fn into_any(self: Box<Affine3>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Affine3>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl RelativeEq for Affine3

fn default_max_relative() -> <Affine3 as AbsDiffEq>::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Affine3, epsilon: <Affine3 as AbsDiffEq>::Epsilon, max_relative: <Affine3 as AbsDiffEq>::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl Serialize for Affine3

Serialize as a sequence of 12 values.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for Affine3

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Gets the name of the field with index index.

fn index_of_name(&self, name: &str) -> Option<usize>

Gets the index of the field with the given name.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for Affine3

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Affine3

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UlpsEq for Affine3

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq( &self, other: &Affine3, epsilon: <Affine3 as AbsDiffEq>::Epsilon, max_ulps: u32, ) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl Zeroable for Affine3

fn zeroed() -> Self

Calls zeroed.

impl Copy for Affine3

impl Pod for Affine3