Struct PhysicsTransformHelper

pub struct PhysicsTransformHelper<'w, 's> {
    pub transform_helper: TransformHelper<'w, 's>,
    pub query: Query<'w, 's, (Write<Position>, Write<Rotation>)>,
}

A system parameter for computing up-to-date Position and Rotation components of entities based on their Transforms.

This can be useful to ensure that physics transforms are immediately updated after changes to the Transform, before transform propagation systems are run.

Computing the global transform of each entity individually can be expensive, so it is recommended to only use this for specific entities that require immediate updates, such as right after teleporting an entity.

Fields

transform_helper: TransformHelper<'w, 's>

The TransformHelper used to compute the global transform.

query: Query<'w, 's, (Write<Position>, Write<Rotation>)>

A query for the Position and Rotation components.

Implementations

impl PhysicsTransformHelper<'_, '_>

pub fn compute_global_transform( &self, entity: Entity, ) -> Result<GlobalTransform, ComputeGlobalTransformError>

Computes the GlobalTransform of the given entity from its Transform and ancestors.

pub fn update_physics_transform( &mut self, entity: Entity, ) -> Result<(Mut<'_, Position>, Mut<'_, Rotation>), UpdatePhysicsTransformError>

Updates the Position and Rotation components of the given entity based on its Transform and ancestors.

Returns a mutable reference to the updated Position and Rotation components.

Trait Implementations

impl SystemParam for PhysicsTransformHelper<'_, '_>

type State = FetchState

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

type Item<'w, 's> = PhysicsTransformHelper<'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 PhysicsTransformHelper<'w, 's>

where TransformHelper<'w, 's>: ReadOnlySystemParam, Query<'w, 's, (Write<Position>, Write<Rotation>)>: ReadOnlySystemParam,