Struct bevy::transform::components::GlobalTransform

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

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.

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

Performs copy-assignment from source.

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.

impl Default for GlobalTransform

fn default() -> GlobalTransform

Returns the “default value” for a type.

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.

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.

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.

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 ==.

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.

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.

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.

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

Applies a reflected value to this value.

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

Returns an enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

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

Returns a serializable version of the value.

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

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

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

Returns a “partial equality” comparison result.

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.

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.

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.

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.

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