Struct bevy_tnua_physics_integration_layer::data_for_backends::TnuaProximitySensor

pub struct TnuaProximitySensor {
    pub cast_origin: Vector3,
    pub cast_direction: Dir3,
    pub cast_range: Float,
    pub output: Option<TnuaProximitySensorOutput>,
    pub intersection_match_prevention_cutoff: Float,
}

Distance from another collider in a certain direction, and information on that collider.

The physics backend is responsible for updating this component from the physics engine during TnuaPipelineStages::Sensors, usually by casting a ray or a shape in the cast_direction.

Fields

cast_origin: Vector3

The cast origin in the entity’s coord system.

cast_direction: Dir3

The direction in world coord system (unmodified by the entity’s transform)

cast_range: Float

Tnua will update this field according to its need. The backend only needs to read it.

output: Option<TnuaProximitySensorOutput>

intersection_match_prevention_cutoff: Float

Used to prevent collision with obstacles the character squeezed into sideways.

This is used to prevent https://github.com/idanarye/bevy-tnua/issues/14. When casting, Tnua checks if the entity the ray(/shape)cast hits is also in contact with the owner collider. If so, Tnua compares the contact normal with the cast direction.

For legitimate hits, these two directions should be opposite. If Tnua casts downwards and hits the actual floor, the normal of the contact with it should point upward. Opposite directions means the dot product is closer to -1.0.

Illigitimage hits hits would have perpendicular directions - hitting a wall (sideways) when casting downwards - which should give a dot product closer to 0.0.

This field is compared to the dot product to determine if the hit is valid or not, and can usually be left at the default value of -0.5.

Positive dot products should not happen (hitting the ceiling?), but it’s trivial to consider them as invalid.

Trait Implementations

impl Component for TnuaProximitySensor

where Self: Send + Sync + 'static,

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

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

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

impl Debug for TnuaProximitySensor

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

Formats the value using the given formatter.

impl Default for TnuaProximitySensor

fn default() -> Self

Returns the “default value” for a type.