Struct bevy::render::prelude::SpatialBundle

pub struct SpatialBundle {
    pub visibility: Visibility,
    pub computed: ComputedVisibility,
    pub transform: Transform,
    pub global_transform: GlobalTransform,
}

A Bundle with the following Components:

• Visibility and ComputedVisibility, which describe the visibility of an entity

• Transform and GlobalTransform, which describe the position of an entity

• To show or hide an entity, you should set its Visibility.

• To get the computed visibility of an entity, you should get its ComputedVisibility.

• 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 hierarchies to work correctly, you must have all four components.

  • You may use the SpatialBundle to guarantee this.

Fields

visibility: Visibility

The visibility of the entity.

computed: ComputedVisibility

The computed visibility of the entity.

transform: Transform

The transform of the entity.

global_transform: GlobalTransform

The global transform of the entity.

Implementations

impl SpatialBundle

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

Creates a new SpatialBundle from a Transform.

This initializes GlobalTransform as identity, and visibility as visible

pub const INHERITED_IDENTITY: SpatialBundle = SpatialBundle{ visibility: Visibility::Inherited, computed: ComputedVisibility::HIDDEN, transform: Transform::IDENTITY, global_transform: GlobalTransform::IDENTITY,}

A visible SpatialBundle, with no translation, rotation, and a scale of 1 on all axes.

pub const HIDDEN_IDENTITY: SpatialBundle = SpatialBundle{ visibility: Visibility::Hidden, ..Self::INHERITED_IDENTITY}

An invisible SpatialBundle, with no translation, rotation, and a scale of 1 on all axes.

Trait Implementations

impl Debug for SpatialBundle

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

Formats the value using the given formatter.

impl Default for SpatialBundle

fn default() -> SpatialBundle

Returns the “default value” for a type.

impl From<Transform> for SpatialBundle

fn from(transform: Transform) -> SpatialBundle

Converts to this type from the input type.

impl Bundle for SpatialBundle

impl DynamicBundle for SpatialBundle