Struct bevy::math::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
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 a mutable reference to the matrix column 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 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.
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.
Trait Implementations
Performs the +=
operation. Read more
Convert this value into the std140
version of itself.
pub fn from_std140(value: <DMat3 as AsStd140>::Output) -> DMat3
pub fn from_std140(value: <DMat3 as AsStd140>::Output) -> DMat3
Converts from std140
version of self to self.
fn std140_size_static() -> usize
fn std140_size_static() -> usize
Returns the size of the std140
version of this type. Useful for
pre-sizing buffers. Read more
Convert this value into the std430
version of itself.
pub fn from_std430(value: <DMat3 as AsStd430>::Output) -> DMat3
pub fn from_std430(value: <DMat3 as AsStd430>::Output) -> DMat3
Converts from std430
version of self to self.
fn std430_size_static() -> usize
fn std430_size_static() -> usize
Returns the size of the std430
version of this type. Useful for
pre-sizing buffers. Read more
pub fn deserialize<D>(
deserializer: D
) -> Result<DMat3, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
pub fn deserialize<D>(
deserializer: D
) -> Result<DMat3, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Performs the *=
operation. Read more
Performs the *=
operation. Read more
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
pub 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. Read more
Performs the -=
operation. Read more
Auto Trait Implementations
impl RefUnwindSafe for DMat3
impl UnwindSafe for DMat3
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert 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 more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
pub fn from_world(_world: &mut World) -> T
pub fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
type ArraySize = DimensionNil
type ArraySize = DimensionNil
Type-level linked list of array dimensions, ordered outer to inner.
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>ⓘ
pub fn vzip(self) -> V
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
impl<T> WriteStd140 for T where
T: AsStd140,
impl<T> WriteStd140 for T where
T: AsStd140,
pub fn std140_size(&self) -> usize
pub fn std140_size(&self) -> usize
The space required to write this value using std140
layout rules. This
does not include alignment padding that may be needed before or after
this type when written as part of a larger buffer. Read more
impl<T> WriteStd430 for T where
T: AsStd430,
impl<T> WriteStd430 for T where
T: AsStd430,
pub fn std430_size(&self) -> usize
pub fn std430_size(&self) -> usize
The space required to write this value using std430
layout rules. This
does not include alignment padding that may be needed before or after
this type when written as part of a larger buffer. Read more