Skip to main content

Transform

Struct Transform 

Source
pub struct Transform {
    pub translation: Vec3,
    pub rotation: Quat,
    pub scale: Vec3,
}
Expand description

A translation, rotation, and scale transform.

Fields§

§translation: Vec3

Local translation.

§rotation: Quat

Local rotation.

§scale: Vec3

Local scale.

Implementations§

Source§

impl Transform

Source

pub const IDENTITY: Self

Identity transform.

Source

pub const fn new(translation: Vec3, rotation: Quat, scale: Vec3) -> Self

Creates a transform from translation, rotation, and scale.

Source

pub const fn from_translation(value: Vec3) -> Self

Creates a translation transform.

Source

pub const fn from_rotation(value: Quat) -> Self

Creates a rotation transform.

Source

pub const fn from_scale(value: Vec3) -> Self

Creates a scale transform.

Source

pub fn looking_at(eye: Vec3, target: Vec3, up: Vec3) -> Self

Creates a transform that looks from eye toward target.

Source

pub fn to_mat4(self) -> Mat4

Converts the transform to a column-major matrix.

Source

pub fn from_mat4(matrix: Mat4) -> Option<Self>

Creates a transform from a TRS matrix.

Source

pub fn mul_transform(self, rhs: Self) -> Self

Composes two transforms.

Source

pub fn inverse(self) -> Self

Returns the inverse transform.

Source

pub fn forward(self) -> Vec3

Returns the transformed forward direction (-Z).

Source

pub fn right(self) -> Vec3

Returns the transformed right direction (+X).

Source

pub fn up(self) -> Vec3

Returns the transformed up direction (+Y).

Source

pub fn translate_by(self, delta: Vec3) -> Self

Returns this transform translated by delta.

Source

pub fn rotate_by(self, rotation: Quat) -> Self

Returns this transform rotated by rotation.

Source

pub fn scale_by(self, scale: Vec3) -> Self

Returns this transform scaled component-wise by scale.

Trait Implementations§

Source§

impl Clone for Transform

Source§

fn clone(&self) -> Transform

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Transform

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Transform

Source§

fn default() -> Self

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

impl PartialEq for Transform

Source§

fn eq(&self, other: &Transform) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Copy for Transform

Source§

impl StructuralPartialEq for Transform

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.