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 be displayed, an entity must have both a Transform and a GlobalTransform.
• To get the global position of an entity, you should get its GlobalTransform.

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.

In pseudo code:

for entity in entities_without_parent:
    set entity.global_transform to entity.transform
    recursively:
        set parent to current entity
        for child in parent.children:
            set child.global_transform to parent.global_transform * child.transform

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

rotation: Quat

scale: Vec3

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 local_x(&self) -> Vec3

Get the unit vector in the local x direction

pub fn local_y(&self) -> Vec3

Get the unit vector in the local y direction

pub fn local_z(&self) -> Vec3

Get the unit vector in the local z direction

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

pub fn clone(&self) -> GlobalTransform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for GlobalTransform

impl Debug for GlobalTransform

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

Formats the value using the given formatter.

impl Default for GlobalTransform

pub fn default() -> GlobalTransform

Returns the “default value” for a type.

impl From<GlobalTransform> for Transform

pub fn from(transform: GlobalTransform) -> Transform

Performs the conversion.

impl From<Transform> for GlobalTransform

pub fn from(transform: Transform) -> GlobalTransform

Performs the conversion.

impl GetTypeRegistration for GlobalTransform

pub fn get_type_registration() -> TypeRegistration

impl Mul<GlobalTransform> for GlobalTransform

type Output = GlobalTransform

The resulting type after applying the * operator.

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

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

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

Performs the * operation.

impl PartialEq<GlobalTransform> for GlobalTransform

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

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

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

This method tests for !=.

impl Reflect for GlobalTransform

pub fn type_name(&self) -> &str

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

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

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

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

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

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

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

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

Returns a serializable value, if serialization is supported. Otherwise None will be returned.

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

Returns a hash of the value (which includes the type) if hashing is supported. Otherwise None will be returned.

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

Returns a “partial equal” comparison result if comparison is supported. Otherwise None will be returned.

impl RenderResource for GlobalTransform

pub fn resource_type(&self) -> Option<RenderResourceType>

pub fn write_buffer_bytes(&self, buffer: &mut [u8])

pub fn buffer_byte_len(&self) -> Option<usize>

pub fn texture(&self) -> Option<&Handle<Texture>>

impl RenderResources for GlobalTransform

pub fn render_resources_len(&self) -> usize

pub fn get_render_resource(&self, index: usize) -> Option<&dyn RenderResource>

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

pub fn iter(&self) -> RenderResourceIterator<'_>

pub fn get_render_resource_hints(
    &self,
    _index: usize
) -> Option<RenderResourceHints>

impl Struct for GlobalTransform

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

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

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

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

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

pub fn field_len(&self) -> usize

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

pub fn clone_dynamic(&self) -> DynamicStruct

impl StructuralPartialEq for GlobalTransform