Struct ShapeCommands 

pub struct ShapeCommands<'w, 's> { /* private fields */ }

A system param that allows ergonomic spawning of shape entities.

The ShapeConfig used is initially extracted from the BaseShapeConfig resource. Subsequent calls to reset() will reset the config back to whatever is currently stored within the BaseShapeConfig resource.

Shapes will be spawned with commands during the next instance of [apply_deferred]

Implementations

impl<'w, 's> ShapeCommands<'w, 's>

pub fn reset(&mut self)

Set the painter’s ShapeConfig to the current value of the BaseShapeConfig resource.

Methods from Deref<Target = ShapeConfig>

pub fn translate(&mut self, dir: Vec3)

Helper method to modify the configs transform taking into account rotation and scale.

pub fn set_translation(&mut self, translation: Vec3)

Helper method to set the configs transform.

pub fn rotate(&mut self, quat: Quat)

Helper method to rotate the configs transform by a given Quat.

pub fn set_rotation(&mut self, rotation: Quat)

Helper method to set the configs rotation.

pub fn rotate_x(&mut self, angle: f32)

Helper method to rotate the configs transform around the x axis.

pub fn rotate_y(&mut self, angle: f32)

Helper method to rotate the configs transform around the y axis.

pub fn rotate_z(&mut self, angle: f32)

Helper method to rotate the configs transform around the z axis.

pub fn scale(&mut self, scale: Vec3)

Helper method to scale the configs transform.

pub fn set_scale(&mut self, scale: Vec3)

Helper method to set the configs scale.

pub fn set_canvas(&mut self, canvas: Entity)

Helper method to change shape render target to a canvas.

Also sets pipeline to Shape2d.

pub fn set_3d(&mut self)

Helper method to change the target pipeline to the 3d pipeline.

pub fn set_2d(&mut self)

Helper method to change the target pipeline to the 2d pipeline.

pub fn without_transform(&self) -> Self

Helper method to clone the config without it’s transform, useful when parenting.

pub fn set_color(&mut self, color: impl Into<Color>)

Trait Implementations

impl<'w, 's> Deref for ShapeCommands<'w, 's>

type Target = ShapeConfig

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'w, 's> DerefMut for ShapeCommands<'w, 's>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'w, 's> ShapeSpawner<'w> for ShapeCommands<'w, 's>

fn spawn_shape(&mut self, bundle: impl Bundle) -> ShapeEntityCommands<'_, '_>

Note: ShapeBundle does not include RenderLayers as there is no support for optional components so instead it is inserted in this function conditionally depending on the ShapeConfig in self Prefer the function for the shape you want over ShapeSpawner::spawn_shape, e.g. commands.rect(...)

fn config(&self) -> &ShapeConfig

fn set_config(&mut self, config: ShapeConfig)

impl SystemParam for ShapeCommands<'_, '_>

type State = FetchState

Used to store data which persists across invocations of a system.

type Item<'w, 's> = ShapeCommands<'w, 's>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World) -> Self::State

Creates a new instance of this param’s State.

fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn validate_param<'w, 's>( state: &'s mut Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's> ReadOnlySystemParam for ShapeCommands<'w, 's>

where &'s mut ShapeConfig: ReadOnlySystemParam, Commands<'w, 's>: ReadOnlySystemParam, Res<'w, BaseShapeConfig>: ReadOnlySystemParam,