Expand description
A 3D affine transform, which can represent translation, rotation, scaling and shear.
Fields
matrix3: DMat3
translation: DVec3
Implementations
sourceimpl DAffine3
impl DAffine3
sourcepub const ZERO: DAffine3 = Self{ matrix3: DMat3::ZERO, translation: DVec3::ZERO,}
pub const ZERO: DAffine3 = Self{ matrix3: DMat3::ZERO, translation: DVec3::ZERO,}
The degenerate zero transform.
This transforms any finite vector and point to zero. The zero transform is non-invertible.
sourcepub const IDENTITY: DAffine3 = Self{ matrix3: DMat3::IDENTITY, translation: DVec3::ZERO,}
pub const IDENTITY: DAffine3 = Self{ matrix3: DMat3::IDENTITY, translation: DVec3::ZERO,}
The identity transform.
Multiplying a vector with this returns the same vector.
sourcepub const fn from_cols(
x_axis: DVec3,
y_axis: DVec3,
z_axis: DVec3,
w_axis: DVec3
) -> DAffine3
pub const fn from_cols(
x_axis: DVec3,
y_axis: DVec3,
z_axis: DVec3,
w_axis: DVec3
) -> DAffine3
Creates an affine transform from three column vectors.
sourcepub fn from_cols_array(m: &[f64; 12]) -> DAffine3
pub fn from_cols_array(m: &[f64; 12]) -> DAffine3
Creates an affine transform from a [f64; 12]
array stored in column major order.
sourcepub fn to_cols_array(&self) -> [f64; 12]
pub fn to_cols_array(&self) -> [f64; 12]
Creates a [f64; 12]
array storing data in column major order.
sourcepub fn from_cols_array_2d(m: &[[f64; 3]; 4]) -> DAffine3
pub fn from_cols_array_2d(m: &[[f64; 3]; 4]) -> DAffine3
Creates an affine transform from a [[f64; 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.
sourcepub fn to_cols_array_2d(&self) -> [[f64; 3]; 4]
pub fn to_cols_array_2d(&self) -> [[f64; 3]; 4]
Creates a [[f64; 3]; 4]
3D array storing data in
column major order.
If you require data in row major order transpose
the matrix first.
sourcepub fn from_cols_slice(slice: &[f64]) -> DAffine3
pub fn from_cols_slice(slice: &[f64]) -> DAffine3
Creates an affine transform from the first 12 values in slice
.
Panics
Panics if slice
is less than 12 elements long.
sourcepub fn write_cols_to_slice(self, slice: &mut [f64])
pub fn write_cols_to_slice(self, slice: &mut [f64])
Writes the columns of self
to the first 12 elements in slice
.
Panics
Panics if slice
is less than 12 elements long.
sourcepub fn from_scale(scale: DVec3) -> DAffine3
pub fn from_scale(scale: DVec3) -> DAffine3
Creates an affine transform that changes scale. Note that if any scale is zero the transform will be non-invertible.
sourcepub fn from_quat(rotation: DQuat) -> DAffine3
pub fn from_quat(rotation: DQuat) -> DAffine3
Creates an affine transform from the given rotation
quaternion.
sourcepub fn from_axis_angle(axis: DVec3, angle: f64) -> DAffine3
pub fn from_axis_angle(axis: DVec3, angle: f64) -> DAffine3
Creates an affine transform containing a 3D rotation around a normalized
rotation axis
of angle
(in radians).
sourcepub fn from_rotation_x(angle: f64) -> DAffine3
pub fn from_rotation_x(angle: f64) -> DAffine3
Creates an affine transform containing a 3D rotation around the x axis of
angle
(in radians).
sourcepub fn from_rotation_y(angle: f64) -> DAffine3
pub fn from_rotation_y(angle: f64) -> DAffine3
Creates an affine transform containing a 3D rotation around the y axis of
angle
(in radians).
sourcepub fn from_rotation_z(angle: f64) -> DAffine3
pub fn from_rotation_z(angle: f64) -> DAffine3
Creates an affine transform containing a 3D rotation around the z axis of
angle
(in radians).
sourcepub fn from_translation(translation: DVec3) -> DAffine3
pub fn from_translation(translation: DVec3) -> DAffine3
Creates an affine transformation from the given 3D translation
.
sourcepub fn from_mat3(mat3: DMat3) -> DAffine3
pub fn from_mat3(mat3: DMat3) -> DAffine3
Creates an affine transform from a 3x3 matrix (expressing scale, shear and rotation)
sourcepub fn from_mat3_translation(mat3: DMat3, translation: DVec3) -> DAffine3
pub fn from_mat3_translation(mat3: DMat3, translation: DVec3) -> DAffine3
Creates an affine transform from a 3x3 matrix (expressing scale, shear and rotation) and a translation vector.
Equivalent to DAffine3::from_translation(translation) * DAffine3::from_mat3(mat3)
sourcepub fn from_scale_rotation_translation(
scale: DVec3,
rotation: DQuat,
translation: DVec3
) -> DAffine3
pub fn from_scale_rotation_translation(
scale: DVec3,
rotation: DQuat,
translation: DVec3
) -> DAffine3
Creates an affine transform from the given 3D scale
, rotation
and
translation
.
Equivalent to DAffine3::from_translation(translation) * DAffine3::from_quat(rotation) * DAffine3::from_scale(scale)
sourcepub fn from_rotation_translation(rotation: DQuat, translation: DVec3) -> DAffine3
pub fn from_rotation_translation(rotation: DQuat, translation: DVec3) -> DAffine3
Creates an affine transform from the given 3D rotation
and translation
.
Equivalent to DAffine3::from_translation(translation) * DAffine3::from_quat(rotation)
sourcepub fn from_mat4(m: DMat4) -> DAffine3
pub fn from_mat4(m: DMat4) -> DAffine3
The given DMat4
must be an affine transform,
i.e. contain no perspective transform.
sourcepub fn to_scale_rotation_translation(&self) -> (DVec3, DQuat, DVec3)
pub fn to_scale_rotation_translation(&self) -> (DVec3, DQuat, DVec3)
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.
sourcepub fn look_to_lh(eye: DVec3, dir: DVec3, up: DVec3) -> DAffine3
pub fn look_to_lh(eye: DVec3, dir: DVec3, up: DVec3) -> DAffine3
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
.
sourcepub fn look_to_rh(eye: DVec3, dir: DVec3, up: DVec3) -> DAffine3
pub fn look_to_rh(eye: DVec3, dir: DVec3, up: DVec3) -> DAffine3
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
.
sourcepub fn look_at_lh(eye: DVec3, center: DVec3, up: DVec3) -> DAffine3
pub fn look_at_lh(eye: DVec3, center: DVec3, up: DVec3) -> DAffine3
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.
sourcepub fn look_at_rh(eye: DVec3, center: DVec3, up: DVec3) -> DAffine3
pub fn look_at_rh(eye: DVec3, center: DVec3, up: DVec3) -> DAffine3
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.
sourcepub fn transform_point3(&self, rhs: DVec3) -> DVec3
pub fn transform_point3(&self, rhs: DVec3) -> DVec3
Transforms the given 3D points, applying shear, scale, rotation and translation.
sourcepub fn transform_vector3(&self, rhs: DVec3) -> DVec3
pub fn transform_vector3(&self, rhs: DVec3) -> DVec3
Transforms the given 3D vector, applying shear, scale and rotation (but NOT translation).
To also apply translation, use Self::transform_point3
instead.
sourcepub fn is_finite(&self) -> bool
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
.
sourcepub fn abs_diff_eq(&self, rhs: DAffine3, max_abs_diff: f64) -> bool
pub fn abs_diff_eq(&self, rhs: DAffine3, max_abs_diff: f64) -> 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.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for DAffine3
impl<'de> Deserialize<'de> for DAffine3
sourcefn deserialize<D>(
deserializer: D
) -> Result<DAffine3, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<DAffine3, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
impl FromReflect for DAffine3where
DMat3: FromReflect,
DVec3: FromReflect,
impl FromReflect for DAffine3where
DMat3: FromReflect,
DVec3: FromReflect,
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<DAffine3>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<DAffine3>
Self
from a reflected value.impl GetTypeRegistration for DAffine3
impl GetTypeRegistration for DAffine3
impl Reflect for DAffine3
impl Reflect for DAffine3
fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
fn into_any(self: Box<DAffine3, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<DAffine3, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Any>
.fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut dyn Any
.fn into_reflect(
self: Box<DAffine3, Global>
) -> Box<dyn Reflect + 'static, Global>
fn into_reflect(
self: Box<DAffine3, Global>
) -> Box<dyn Reflect + 'static, Global>
fn as_reflect(&self) -> &(dyn Reflect + 'static)
fn as_reflect(&self) -> &(dyn Reflect + 'static)
fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
Reflect
trait object. Read morefn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_owned(self: Box<DAffine3, Global>) -> ReflectOwned
fn reflect_owned(self: Box<DAffine3, Global>) -> ReflectOwned
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
sourceimpl Serialize for DAffine3
impl Serialize for DAffine3
sourcefn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
impl Struct for DAffine3
impl Struct for DAffine3
fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
index
as a &mut dyn Reflect
. Read morefn iter_fields(&self) -> FieldIter<'_>ⓘ
fn iter_fields(&self) -> FieldIter<'_>ⓘ
fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.impl Copy for DAffine3
Auto Trait Implementations
impl RefUnwindSafe for DAffine3
impl Send for DAffine3
impl Sync for DAffine3
impl Unpin for DAffine3
impl UnwindSafe for DAffine3
Blanket Implementations
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist. Read moresourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read morefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read morefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read morefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read moreimpl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given Worldimpl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
impl<T> GetPath for Twhere
T: Reflect,
impl<T> GetPath for Twhere
T: Reflect,
fn path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read morefn path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read morefn get_path<T, 'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r T, ReflectPathError<'p>>where
T: Reflect,
fn get_path<T, 'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r T, ReflectPathError<'p>>where
T: Reflect,
path
.fn get_path_mut<T, 'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>>where
T: Reflect,
fn get_path_mut<T, 'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read more