Struct bevy::prelude::Mat3 [−][src]
A 3x3 column major matrix.
This 3x3 matrix type features convenience methods for creating and using linear and affine transformations.
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 Mat3
[src]
pub const ZERO: Mat3
[src]
A 3x3 matrix with all elements set to 0.0
.
pub const IDENTITY: Mat3
[src]
A 3x3 identity matrix, where all diagonal elements are 1
, and all off-diagonal
elements are 0
.
pub const fn zero() -> Mat3
[src]
use Mat3::ZERO instead
Creates a 3x3 matrix with all elements set to 0.0
.
pub const fn identity() -> Mat3
[src]
use Mat3::IDENTITY instead
Creates a 3x3 identity matrix.
pub fn from_cols(x_axis: Vec3, y_axis: Vec3, z_axis: Vec3) -> Mat3
[src]
Creates a 3x3 matrix from three column vectors.
pub fn from_cols_array(m: &[f32; 9]) -> Mat3
[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) -> [f32; 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: &[[f32; 3]; 3]) -> Mat3
[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) -> [[f32; 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: Vec3) -> Mat3
[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: Quat) -> Mat3
[src]
Creates a 3D rotation matrix from the given quaternion.
pub fn from_axis_angle(axis: Vec3, angle: f32) -> Mat3
[src]
Creates a 3D rotation matrix from a normalized rotation axis
and angle
(in
radians).
pub fn from_rotation_ypr(yaw: f32, pitch: f32, roll: f32) -> Mat3
[src]
Creates a 3D rotation matrix from the given Euler angles (in radians).
pub fn from_rotation_x(angle: f32) -> Mat3
[src]
Creates a 3D rotation matrix from angle
(in radians) around the x axis.
pub fn from_rotation_y(angle: f32) -> Mat3
[src]
Creates a 3D rotation matrix from angle
(in radians) around the y axis.
pub fn from_rotation_z(angle: f32) -> Mat3
[src]
Creates a 3D rotation matrix from angle
(in radians) around the z axis.
pub fn from_translation(translation: Vec2) -> Mat3
[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_point3()
] and [Self::transform_vector3()
].
pub fn from_angle(angle: f32) -> Mat3
[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: Vec2,
angle: f32,
translation: Vec2
) -> Mat3
[src]
scale: Vec2,
angle: f32,
translation: Vec2
) -> Mat3
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: Vec2) -> Mat3
[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 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) -> Mat3
[src]
Returns the transpose of self
.
pub fn determinant(&self) -> f32
[src]
Returns the determinant of self
.
pub fn inverse(&self) -> Mat3
[src]
Returns the inverse of self
.
If the matrix is not invertible the returned matrix will be invalid.
pub fn mul_vec3(&self, other: Vec3) -> Vec3
[src]
Transforms a 3D vector.
pub fn mul_mat3(&self, other: &Mat3) -> Mat3
[src]
Multiplies two 3x3 matrices.
pub fn add_mat3(&self, other: &Mat3) -> Mat3
[src]
Adds two 3x3 matrices.
pub fn sub_mat3(&self, other: &Mat3) -> Mat3
[src]
Subtracts two 3x3 matrices.
pub fn mul_scalar(&self, other: f32) -> Mat3
[src]
Multiplies a 3x3 matrix by a scalar.
pub fn transform_point2(&self, other: Vec2) -> Vec2
[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: Vec2) -> Vec2
[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: Mat3, max_abs_diff: f32) -> 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 mul_vec3a(&self, other: Vec3A) -> Vec3A
[src]
Transforms a Vec3A
.
pub fn as_f64(&self) -> DMat3
[src]
Trait Implementations
impl Add<Mat3> for Mat3
[src]
type Output = Mat3
The resulting type after applying the +
operator.
pub fn add(self, other: Mat3) -> Mat3
[src]
impl AsMut<[f32; 9]> for Mat3
[src]
impl AsRef<[f32; 9]> for Mat3
[src]
impl Clone for Mat3
[src]
impl Copy for Mat3
[src]
impl Debug for Mat3
[src]
impl Default for Mat3
[src]
impl Deref for Mat3
[src]
type Target = Vector3x3<Vec3>
The resulting type after dereferencing.
pub fn deref(&self) -> &<Mat3 as Deref>::Target
[src]
impl DerefMut for Mat3
[src]
impl<'de> Deserialize<'de> for Mat3
[src]
pub fn deserialize<D>(
deserializer: D
) -> Result<Mat3, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
[src]
deserializer: D
) -> Result<Mat3, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
impl Display for Mat3
[src]
impl GetTypeRegistration for Mat3
pub fn get_type_registration() -> TypeRegistration
impl Mul<Mat3> for Mat3
[src]
type Output = Mat3
The resulting type after applying the *
operator.
pub fn mul(self, other: Mat3) -> Mat3
[src]
impl Mul<Vec3> for Mat3
[src]
type Output = Vec3
The resulting type after applying the *
operator.
pub fn mul(self, other: Vec3) -> Vec3
[src]
impl Mul<Vec3A> for Mat3
[src]
type Output = Vec3A
The resulting type after applying the *
operator.
pub fn mul(self, other: Vec3A) -> Vec3A
[src]
impl Mul<f32> for Mat3
[src]
type Output = Mat3
The resulting type after applying the *
operator.
pub fn mul(self, other: f32) -> Mat3
[src]
impl PartialEq<Mat3> for Mat3
[src]
pub fn eq(&self, other: &Mat3) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<Mat3> for Mat3
[src]
pub fn partial_cmp(&self, other: &Mat3) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a> Product<&'a Mat3> for Mat3
[src]
impl Reflect for Mat3
pub fn type_name(&self) -> &str
pub fn any(&self) -> &(dyn Any + 'static)
pub fn any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
pub fn apply(&mut self, value: &(dyn Reflect + 'static))
pub fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
pub fn reflect_ref(&self) -> ReflectRef<'_>
pub fn reflect_mut(&mut self) -> ReflectMut<'_>
pub fn reflect_hash(&self) -> Option<u64>
pub fn reflect_partial_eq(
&self,
value: &(dyn Reflect + 'static)
) -> Option<bool>
&self,
value: &(dyn Reflect + 'static)
) -> Option<bool>
pub fn serializable(&self) -> Option<Serializable<'_>>
impl Serialize for Mat3
[src]
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
[src]
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
impl Sub<Mat3> for Mat3
[src]
type Output = Mat3
The resulting type after applying the -
operator.
pub fn sub(self, other: Mat3) -> Mat3
[src]
impl<'a> Sum<&'a Mat3> for Mat3
[src]
Auto Trait Implementations
impl RefUnwindSafe for Mat3
impl Send for Mat3
impl Sync for Mat3
impl Unpin for Mat3
impl UnwindSafe for Mat3
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Any for T where
T: Any,
T: Any,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> CloneAny for T where
T: Any + Clone,
T: Any + Clone,
impl<T> Component for T where
T: 'static + Send + Sync,
T: 'static + Send + Sync,
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> Downcast for T where
T: Any,
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
impl<T> Downcast<T> for T
impl<T> DowncastSync for T where
T: Any + Send + Sync,
T: Any + Send + Sync,
impl<T> From<T> for T
[src]
impl<T> FromWorld for T where
T: Default,
T: Default,
pub fn from_world(_world: &mut World) -> T
impl<T> GetPath for T where
T: Reflect,
T: Reflect,
pub fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
pub fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
pub fn get_path<T>(
&'r self,
path: &'p str
) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,
&'r self,
path: &'p str
) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,
pub fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,
impl<T> Instrument for T
[src]
pub 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;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
pub 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;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<M> Measure for M where
M: Debug + PartialOrd<M> + Add<M, Output = M> + Default + Clone,
[src]
M: Debug + PartialOrd<M> + Add<M, Output = M> + Default + Clone,
impl<T> Serialize for T where
T: Serialize + ?Sized,
[src]
T: Serialize + ?Sized,
pub fn erased_serialize(
&self,
serializer: &mut dyn Serializer
) -> Result<Ok, Error>
[src]
&self,
serializer: &mut dyn Serializer
) -> Result<Ok, Error>
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
T: 'static + Send + Sync + Clone,
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
impl<T> Upcast<T> for T
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,