Struct Layer

pub struct Layer;

A Layer represents a distinct editing plane within a crate::Level, allowing elements to be grouped by function or intent (e.g., “Walls”, “Objects”, “Lighting”).

Layers are most commonly used for selective visibility, per-layer export, and to control edit interactions (such as locking or isolating layers during drawing or object placement).

Implementations

impl Layer

pub fn new( name: impl Into<Cow<'static, str>>, transform: Transform, ) -> impl Bundle

Generates a new [Bundle] with a layer under which graphic items can be grouped. The transform determines how the layer is positioned relative to other layers.

Examples

Here’s how to spawn a simple Layer for the Walls.

    commands.spawn((
        Project::new("Roadside Inn"),
        children![
            Level::new("Ground Floor"),
            children![
                Layer::new("Walls", Transform::IDENTITY),
            ]
        ]
    ));

Trait Implementations

impl Component for Layer

where Self: Send + Sync + 'static,

Required Components: [Visibility].

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Immutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its [ComponentHooks].

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl Default for Layer

fn default() -> Layer

Returns the “default value” for a type.