Struct bvy::GlobalTransform

[−]

pub struct GlobalTransform {
    pub translation: Vec3,
    pub rotation: Quat,
    pub scale: Vec3,
}

Expand description

Describe the position of an entity relative to the reference frame.

To place or move an entity, you should set its Transform.
To get the global position of an entity, you should get its GlobalTransform.
For transform hierarchies to work correctly, you must have both a Transform and a GlobalTransform.
- You may use the TransformBundle to guarantee this.

`Transform` and `GlobalTransform`

Transform is the position of an entity relative to its parent position, or the reference frame if it doesn’t have a Parent.

GlobalTransform is the position of an entity relative to the reference frame.

GlobalTransform is updated from Transform in the system transform_propagate_system.

This system runs in stage CoreStage::PostUpdate. If you update theTransform of an entity in this stage or after, you will notice a 1 frame lag before the GlobalTransform is updated.

Fields

translation: Vec3

The position of the global transform

rotation: Quat

The rotation of the global transform

scale: Vec3

The scale of the global transform

Implementations

impl GlobalTransform

pub const fn identity() -> GlobalTransform

Creates a new identity GlobalTransform, with no translation, rotation, and a scale of 1 on all axes.

pub fn compute_matrix(&self) -> Mat4

Returns the 3d affine transformation matrix from this transforms translation, rotation, and scale.

pub fn compute_affine(&self) -> Affine3A

Returns the 3d affine transformation from this transforms translation, rotation, and scale.

pub fn local_x(&self) -> Vec3

Get the unit vector in the local x direction

pub fn left(&self) -> Vec3

Equivalent to -local_x()

pub fn right(&self) -> Vec3

Equivalent to local_x()

pub fn local_y(&self) -> Vec3

Get the unit vector in the local y direction

pub fn up(&self) -> Vec3

Equivalent to local_y()

pub fn down(&self) -> Vec3

Equivalent to -local_y()

pub fn local_z(&self) -> Vec3

Get the unit vector in the local z direction

pub fn forward(&self) -> Vec3

Equivalent to -local_z()

pub fn back(&self) -> Vec3

Equivalent to local_z()

pub fn mul_transform(&self, transform: Transform) -> GlobalTransform

Multiplies self with transform component by component, returning the resulting GlobalTransform

pub fn mul_vec3(&self, value: Vec3) -> Vec3

Returns a Vec3 of this Transform applied to value.

Trait Implementations

impl Clone for GlobalTransform

fn clone(&self) -> GlobalTransform

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Component for GlobalTransform where
    GlobalTransform: 'static,
    GlobalTransform: Send,
    GlobalTransform: Sync,

type Storage = TableStorage

impl Debug for GlobalTransform

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

Formats the value using the given formatter. Read more

impl Default for GlobalTransform

fn default() -> GlobalTransform

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

impl From<GlobalTransform> for Transform

fn from(transform: GlobalTransform) -> Transform

Converts to this type from the input type.

impl From<Transform> for GlobalTransform

fn from(transform: Transform) -> GlobalTransform

Converts to this type from the input type.

impl GetTypeRegistration for GlobalTransform

fn get_type_registration() -> TypeRegistration

impl Mul<GlobalTransform> for GlobalTransform

type Output = GlobalTransform

The resulting type after applying the * operator.

fn mul(
self,
global_transform: GlobalTransform
) -> <GlobalTransform as Mul<GlobalTransform>>::Output

Performs the * operation. Read more

impl Mul<Transform> for GlobalTransform

type Output = GlobalTransform

The resulting type after applying the * operator.

fn mul(
self,
transform: Transform
) -> <GlobalTransform as Mul<Transform>>::Output

Performs the * operation. Read more

impl Mul<Vec3> for GlobalTransform

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, value: Vec3) -> <GlobalTransform as Mul<Vec3>>::Output

Performs the * operation. Read more

impl PartialEq<GlobalTransform> for GlobalTransform

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl Reflect for GlobalTransform

fn type_name(&self) -> &str

Returns the type name of the underlying type. Read more

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object. Read more

fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>

Performs a type-checked assignment of a reflected value to this value. Read more

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value. Read more

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type. Read more

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type. Read more

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value. Read more

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type). Read more

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result. Read more

impl Struct for GlobalTransform

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect. Read more

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect. Read more

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect. Read more

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect. Read more

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the struct’s fields.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl Copy for GlobalTransform

impl StructuralPartialEq for GlobalTransform

Auto Trait Implementations

impl RefUnwindSafe for GlobalTransform

impl Send for GlobalTransform

impl Sync for GlobalTransform

impl Unpin for GlobalTransform

impl UnwindSafe for GlobalTransform

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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

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

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

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

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

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

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

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

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromWorld for T where
T: Default,

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World

impl<S> GetField for S where
S: Struct,

fn get_field<T>(&self, name: &str) -> Option<&T> where
T: Reflect,

Returns a reference to the value of the field named name, downcast to T. Read more

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T> where
T: Reflect,

Returns a mutable reference to the value of the field named name, downcast to T. Read more

impl<T> GetPath for T where
T: Reflect,

fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a reference to the value specified by path. Read more

fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a mutable reference to the value specified by path. Read more

fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,

Returns a statically typed reference to the value specified by path.

fn get_path_mut<T>(
 &'r mut self,
 path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
 T: Reflect,

Returns a statically typed mutable reference to the value specified by path. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · 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,

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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct bvy::GlobalTransform

Fields

Implementations

impl GlobalTransform

pub const fn identity() -> GlobalTransform

pub fn compute_matrix(&self) -> Mat4

pub fn compute_affine(&self) -> Affine3A

pub fn local_x(&self) -> Vec3

pub fn left(&self) -> Vec3

pub fn right(&self) -> Vec3

pub fn local_y(&self) -> Vec3

pub fn up(&self) -> Vec3

pub fn down(&self) -> Vec3

pub fn local_z(&self) -> Vec3

pub fn forward(&self) -> Vec3

pub fn back(&self) -> Vec3

pub fn mul_transform(&self, transform: Transform) -> GlobalTransform

pub fn mul_vec3(&self, value: Vec3) -> Vec3

Trait Implementations

impl Clone for GlobalTransform

fn clone(&self) -> GlobalTransform

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

impl Component for GlobalTransform where GlobalTransform: 'static, GlobalTransform: Send, GlobalTransform: Sync,

type Storage = TableStorage

impl Debug for GlobalTransform

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

impl Default for GlobalTransform

fn default() -> GlobalTransform

impl From<GlobalTransform> for Transform

fn from(transform: GlobalTransform) -> Transform

impl From<Transform> for GlobalTransform

fn from(transform: Transform) -> GlobalTransform

impl GetTypeRegistration for GlobalTransform

fn get_type_registration() -> TypeRegistration

impl Mul<GlobalTransform> for GlobalTransform

type Output = GlobalTransform

fn mul( self, global_transform: GlobalTransform) -> <GlobalTransform as Mul<GlobalTransform>>::Output

impl Mul<Transform> for GlobalTransform

type Output = GlobalTransform

fn mul( self, transform: Transform) -> <GlobalTransform as Mul<Transform>>::Output

impl Mul<Vec3> for GlobalTransform

type Output = Vec3

fn mul(self, value: Vec3) -> <GlobalTransform as Mul<Vec3>>::Output

impl PartialEq<GlobalTransform> for GlobalTransform

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

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

impl Reflect for GlobalTransform

fn type_name(&self) -> &str

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

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

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

fn set( &mut self, value: Box<dyn Reflect + 'static, Global>) -> Result<(), Box<dyn Reflect + 'static, Global>>

fn apply(&mut self, value: &(dyn Reflect + 'static))

fn reflect_ref(&self) -> ReflectRef<'_>

fn reflect_mut(&mut self) -> ReflectMut<'_>

fn serializable(&self) -> Option<Serializable<'_>>

fn reflect_hash(&self) -> Option<u64>

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

impl Struct for GlobalTransform

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

fn name_at(&self, index: usize) -> Option<&str>

fn field_len(&self) -> usize

fn iter_fields(&self) -> FieldIter<'_>

fn clone_dynamic(&self) -> DynamicStruct

impl Copy for GlobalTransform

impl StructuralPartialEq for GlobalTransform

Auto Trait Implementations

impl RefUnwindSafe for GlobalTransform

impl Send for GlobalTransform

impl Sync for GlobalTransform

impl Unpin for GlobalTransform

impl UnwindSafe for GlobalTransform

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

impl Component for GlobalTransform where
GlobalTransform: 'static,
GlobalTransform: Send,
GlobalTransform: Sync,

fn mul(
self,
global_transform: GlobalTransform
) -> <GlobalTransform as Mul<GlobalTransform>>::Output

fn mul(
self,
transform: Transform
) -> <GlobalTransform as Mul<Transform>>::Output

fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>

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

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

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

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

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

impl<T> FromWorld for T where
T: Default,

impl<S> GetField for S where
S: Struct,

fn get_field<T>(&self, name: &str) -> Option<&T> where
T: Reflect,

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T> where
T: Reflect,

impl<T> GetPath for T where
T: Reflect,

fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,

fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,

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

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

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

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

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Resource for T where
T: 'static + Send + Sync,