Struct TransformBundle

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

Available on crate feature bevy-support only.

A Bundle of the Transform and GlobalTransform [Component]s, 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 by systems in the system set TransformPropagate.

This system runs during [PostUpdate]. If you update the Transform of an entity in this schedule 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 IDENTITY: Self = _

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

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

Creates a new TransformBundle from a Transform.

This initializes GlobalTransform as identity, to be updated later by the [PostUpdate] schedule.

Trait Implementations

impl Bundle for TransformBundle

fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>), )

Gets this Bundle’s component ids. This will be None if the component has not been registered.

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

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) -> Self

Converts to this type from the input type.

impl Copy for TransformBundle

impl DynamicBundle for TransformBundle