Skip to main content

Transform

Struct Transform 

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

Local translation, Euler rotation and scale relative to the parent.

Units: metres, degrees and dimensionless scale. Rotations use Y-X-Z order, +Y is up and -Z is forward. Scale defaults to one. Shear is not representable.

use kvas_engine::components::Transform;
use glam::Vec3;
let mut pose = Transform::at(Vec3::new(0.0, 1.0, 0.0));
assert!(pose.look_at(Vec3::new(0.0, 1.0, -1.0), Vec3::Y));
assert!((pose.forward() - Vec3::NEG_Z).length() < 1e-5);

Fields§

§position: Vec3

Translation in parent-local metres.

§rotation: Vec3

Euler angles in degrees.

§scale: Vec3

Per-axis local scale, one for an unscaled object.

Implementations§

Source§

impl Transform

Source

pub fn at(position: Vec3) -> Self

Identity orientation/scale positioned at a parent-local point.

Source

pub fn quat(&self) -> Quat

Converts stored Euler degrees to a quaternion using Y-X-Z rotation order.

Source

pub fn set_quat(&mut self, q: Quat)

Stores a unit quaternion as Euler degrees; equivalent angles may wrap. The caller must supply a finite normalized quaternion.

Source

pub fn matrix(&self) -> Mat4

Local TRS matrix for column-vector multiplication (translation * rotation * scale).

Source

pub fn from_matrix(m: Mat4) -> Self

Decomposes a finite, non-singular TRS matrix. Shear cannot be retained. Use Self::try_from_matrix for unchecked input.

Source

pub fn forward(&self) -> Vec3

Local -Z rotated into parent space, ignoring scale.

Source

pub fn right(&self) -> Vec3

Local +X rotated into parent space, ignoring scale.

Source

pub fn up(&self) -> Vec3

Local +Y rotated into parent space, ignoring scale.

Source

pub fn is_finite(&self) -> bool

Checks that every stored scalar is finite; zero scale remains valid data.

Source

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

Decomposes a finite non-singular matrix, returning None for invalid data. Perspective and shear matrices are rejected by checking the reconstructed TRS.

Source

pub fn transform_point(&self, point: Vec3) -> Vec3

Transforms a local point into parent space, including translation and scale.

Source

pub fn transform_direction(&self, direction: Vec3) -> Vec3

Rotates a direction into parent space, ignoring translation and scale.

Source

pub fn inverse_transform_point(&self, point: Vec3) -> Option<Vec3>

Converts a parent-space point to local space, or None for a singular/invalid pose.

Source

pub fn look_at(&mut self, target: Vec3, up: Vec3) -> bool

Orients local -Z toward a parent-space target while keeping position/scale. Returns false without mutation for coincident points, non-finite data, a zero up vector or an up vector parallel to the viewing direction.

Source

pub fn interpolate(&self, other: &Self, t: f32) -> Self

Interpolates translation/scale linearly and orientation along the shortest quaternion arc. t is clamped to [0, 1]; non-finite t selects self.

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 Component for Transform

Source§

const REMOVABLE: bool = false

Whether the user may remove it in the inspector.
Source§

fn fields(&mut self) -> Vec<Field<'_>>

Mutable field descriptors used by the Inspector and script property serialization.
Source§

impl Component for Transform

Source§

const NAME: &'static str = "Transform"

Stable, globally unique name; keep it identical in the host and script library.
§

const KEY: u64 = _

Storage key derived from [Self::NAME]. Normally should not be overridden.
Source§

impl Copy for Transform

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<'de> Deserialize<'de> for Transform

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Transform

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Downcast for T
where T: Any,

§

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

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

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

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

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

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> MaybeSync for T
where T: Sync + ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.