pub struct Transform<P, O, S> {
pub position: Vec3<P>,
pub orientation: Quaternion<O>,
pub scale: Vec3<S>,
}
Expand description
A convenient position + orientation + scale container, backed by two Vec3
and a Quaternion.
It can be easily interpolated and converted to a Mat4
of any layout.
let (p, rz, s) = (Vec3::unit_x(), 3.0_f32, 5.0_f32);
let a = Mat4::scaling_3d(s).rotated_z(rz).translated_3d(p);
let b = Mat4::from(Transform {
position: p,
orientation: Quaternion::rotation_z(rz),
scale: Vec3::broadcast(s),
});
assert_relative_eq!(a, b);
Fields
position: Vec3<P>
Local position.
orientation: Quaternion<O>
Local orientation; It is not named rotation
because rotation
denotes an
operation, but not a current state.
scale: Vec3<S>
Local scale.
Trait Implementations
sourceimpl<P: Zero, O: Zero + One, S: One> Default for Transform<P, O, S>
impl<P: Zero, O: Zero + One, S: One> Default for Transform<P, O, S>
The default Transform
has a zero position, identity orientation and unit scale.
let a = Transform {
position: Vec3::<f32>::zero(),
orientation: Quaternion::<f32>::identity(),
scale: Vec3::<f32>::one(),
};
assert_eq!(a, Transform::default());
sourceimpl<'de, P, O, S> Deserialize<'de> for Transform<P, O, S> where
P: Deserialize<'de>,
O: Deserialize<'de>,
S: Deserialize<'de>,
impl<'de, P, O, S> Deserialize<'de> for Transform<P, O, S> where
P: Deserialize<'de>,
O: Deserialize<'de>,
S: Deserialize<'de>,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<T> From<Transform<T, T, T>> for Mat4<T> where
T: Real + MulAdd<T, T, Output = T>,
impl<T> From<Transform<T, T, T>> for Mat4<T> where
T: Real + MulAdd<T, T, Output = T>,
A Mat4
can be obtained from a Transform
, by rotating, then scaling, then
translating.
sourceimpl<T> From<Transform<T, T, T>> for Mat4<T> where
T: Real + MulAdd<T, T, Output = T>,
impl<T> From<Transform<T, T, T>> for Mat4<T> where
T: Real + MulAdd<T, T, Output = T>,
A Mat4
can be obtained from a Transform
, by rotating, then scaling, then
translating.
sourceimpl<P, O, S, Factor> Lerp<Factor> for Transform<P, O, S> where
Factor: Copy + Into<O>,
P: Lerp<Factor, Output = P>,
S: Lerp<Factor, Output = S>,
O: Lerp<O, Output = O> + Real + Add<Output = O>,
impl<P, O, S, Factor> Lerp<Factor> for Transform<P, O, S> where
Factor: Copy + Into<O>,
P: Lerp<Factor, Output = P>,
S: Lerp<Factor, Output = S>,
O: Lerp<O, Output = O> + Real + Add<Output = O>,
LERP on a Transform
is defined as LERP-ing between the positions and scales,
and performing SLERP between the orientations.
sourcefn lerp_unclamped(a: Self, b: Self, t: Factor) -> Self
fn lerp_unclamped(a: Self, b: Self, t: Factor) -> Self
Returns the linear interpolation of from
to to
with factor
unconstrained,
using the supposedly fastest but less precise implementation. Read more
sourcefn lerp_unclamped_precise(a: Self, b: Self, t: Factor) -> Self
fn lerp_unclamped_precise(a: Self, b: Self, t: Factor) -> Self
Returns the linear interpolation of from
to to
with factor
unconstrained,
using a possibly slower but more precise operation. Read more
sourcefn lerp_unclamped_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output
fn lerp_unclamped_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output
Version of lerp_unclamped()
that used a single RangeInclusive
parameter instead of two values.
sourcefn lerp_unclamped_precise_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output
fn lerp_unclamped_precise_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output
Version of lerp_unclamped_precise()
that used a single RangeInclusive
parameter instead of two values.
sourcefn lerp(from: Self, to: Self, factor: Factor) -> Self::Output where
Factor: Clamp + Zero + One,
fn lerp(from: Self, to: Self, factor: Factor) -> Self::Output where
Factor: Clamp + Zero + One,
Alias to lerp_unclamped
which constrains factor
to be between 0 and 1
(inclusive). Read more
sourcefn lerp_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output where
Factor: Clamp + Zero + One,
fn lerp_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output where
Factor: Clamp + Zero + One,
Version of lerp()
that used a single RangeInclusive
parameter instead of two values.
sourcefn lerp_precise(from: Self, to: Self, factor: Factor) -> Self::Output where
Factor: Clamp + Zero + One,
fn lerp_precise(from: Self, to: Self, factor: Factor) -> Self::Output where
Factor: Clamp + Zero + One,
Alias to lerp_unclamped_precise
which constrains factor
to be between 0 and 1
(inclusive). Read more
sourcefn lerp_precise_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output where
Factor: Clamp + Zero + One,
fn lerp_precise_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output where
Factor: Clamp + Zero + One,
Version of lerp_precise()
that used a single RangeInclusive
parameter instead of two values.
sourceimpl<'a, P, O, S, Factor> Lerp<Factor> for &'a Transform<P, O, S> where
Factor: Copy + Into<O>,
&'a P: Lerp<Factor, Output = P>,
&'a S: Lerp<Factor, Output = S>,
O: Lerp<O, Output = O> + Real + Add<Output = O>,
impl<'a, P, O, S, Factor> Lerp<Factor> for &'a Transform<P, O, S> where
Factor: Copy + Into<O>,
&'a P: Lerp<Factor, Output = P>,
&'a S: Lerp<Factor, Output = S>,
O: Lerp<O, Output = O> + Real + Add<Output = O>,
LERP on a Transform
is defined as LERP-ing between the positions and scales,
and performing SLERP between the orientations.
sourcefn lerp_unclamped(a: Self, b: Self, t: Factor) -> Self::Output
fn lerp_unclamped(a: Self, b: Self, t: Factor) -> Self::Output
Returns the linear interpolation of from
to to
with factor
unconstrained,
using the supposedly fastest but less precise implementation. Read more
sourcefn lerp_unclamped_precise(a: Self, b: Self, t: Factor) -> Self::Output
fn lerp_unclamped_precise(a: Self, b: Self, t: Factor) -> Self::Output
Returns the linear interpolation of from
to to
with factor
unconstrained,
using a possibly slower but more precise operation. Read more
sourcefn lerp_unclamped_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output
fn lerp_unclamped_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output
Version of lerp_unclamped()
that used a single RangeInclusive
parameter instead of two values.
sourcefn lerp_unclamped_precise_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output
fn lerp_unclamped_precise_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output
Version of lerp_unclamped_precise()
that used a single RangeInclusive
parameter instead of two values.
sourcefn lerp(from: Self, to: Self, factor: Factor) -> Self::Output where
Factor: Clamp + Zero + One,
fn lerp(from: Self, to: Self, factor: Factor) -> Self::Output where
Factor: Clamp + Zero + One,
Alias to lerp_unclamped
which constrains factor
to be between 0 and 1
(inclusive). Read more
sourcefn lerp_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output where
Factor: Clamp + Zero + One,
fn lerp_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output where
Factor: Clamp + Zero + One,
Version of lerp()
that used a single RangeInclusive
parameter instead of two values.
sourcefn lerp_precise(from: Self, to: Self, factor: Factor) -> Self::Output where
Factor: Clamp + Zero + One,
fn lerp_precise(from: Self, to: Self, factor: Factor) -> Self::Output where
Factor: Clamp + Zero + One,
Alias to lerp_unclamped_precise
which constrains factor
to be between 0 and 1
(inclusive). Read more
sourcefn lerp_precise_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output where
Factor: Clamp + Zero + One,
fn lerp_precise_inclusive_range(
range: RangeInclusive<Self>,
factor: Factor
) -> Self::Output where
Factor: Clamp + Zero + One,
Version of lerp_precise()
that used a single RangeInclusive
parameter instead of two values.
sourceimpl<P: PartialEq, O: PartialEq, S: PartialEq> PartialEq<Transform<P, O, S>> for Transform<P, O, S>
impl<P: PartialEq, O: PartialEq, S: PartialEq> PartialEq<Transform<P, O, S>> for Transform<P, O, S>
sourceimpl<P, O, S> Serialize for Transform<P, O, S> where
P: Serialize,
O: Serialize,
S: Serialize,
impl<P, O, S> Serialize for Transform<P, O, S> where
P: Serialize,
O: Serialize,
S: Serialize,
impl<P: Copy, O: Copy, S: Copy> Copy for Transform<P, O, S>
impl<P: Eq, O: Eq, S: Eq> Eq for Transform<P, O, S>
impl<P, O, S> StructuralEq for Transform<P, O, S>
impl<P, O, S> StructuralPartialEq for Transform<P, O, S>
Auto Trait Implementations
impl<P, O, S> RefUnwindSafe for Transform<P, O, S> where
O: RefUnwindSafe,
P: RefUnwindSafe,
S: RefUnwindSafe,
impl<P, O, S> Send for Transform<P, O, S> where
O: Send,
P: Send,
S: Send,
impl<P, O, S> Sync for Transform<P, O, S> where
O: Sync,
P: Sync,
S: Sync,
impl<P, O, S> Unpin for Transform<P, O, S> where
O: Unpin,
P: Unpin,
S: Unpin,
impl<P, O, S> UnwindSafe for Transform<P, O, S> where
O: UnwindSafe,
P: UnwindSafe,
S: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more