Struct bevy::transform::TransformBundle

pub struct TransformBundle {
    pub local: Transform,
    pub global: GlobalTransform,
}

A Bundle of the Transform and GlobalTransform Components, which describe the position of an entity.

• To place or move an entity, you should set its Transform.
• To get the global transform 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 the Transform of an entity in this stage or after, you will notice a 1 frame lag before the GlobalTransform is updated.

Fields

local: Transform

The transform of the entity.

global: GlobalTransform

The global transform of the entity.

Implementations

impl TransformBundle

pub const fn from_transform(transform: Transform) -> TransformBundle

Creates a new TransformBundle from a Transform.

This initializes GlobalTransform as identity, to be updated later by the CoreStage::PostUpdate stage.

pub const fn identity() -> TransformBundle

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

Trait Implementations

impl Bundle for TransformBundle

SAFETY: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

Gets this Bundle’s component ids, in the order of this bundle’s Components

unsafe fn from_components<__T, __F>(ctx: &mut __T, func: __F) -> TransformBundle where
    __F: FnMut(&mut __T) -> OwningPtr<'_>, 

Calls func, which should return data for each component in the bundle, in the order of this bundle’s Components

fn get_components(self, func: impl FnMut(OwningPtr<'_>))

Calls func on each value, in the order of this bundle’s Components. This will std::mem::forget the bundle fields, so callers are responsible for dropping the fields if that is desirable.

impl Clone for TransformBundle

fn clone(&self) -> TransformBundle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransformBundle

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

Formats the value using the given formatter.

impl Default for TransformBundle

fn default() -> TransformBundle

Returns the “default value” for a type.

impl From<Transform> for TransformBundle

fn from(transform: Transform) -> TransformBundle

Converts to this type from the input type.

impl Copy for TransformBundle