Struct TnuaRadarBlipLens 

pub struct TnuaRadarBlipLens<'a, X: TnuaSpatialExt> {
    pub collider_data: X::ColliderData<'a>,
    /* private fields */
}

Fields

collider_data: X::ColliderData<'a>

Physical properties of the collider from the physics backend.

This is typically a tuple of the collider, the position, and the rotation - but these are different types in each physics backend.

Implementations

impl<X: TnuaSpatialExt> TnuaRadarBlipLens<'_, X>

pub fn entity(&self) -> Entity

The entity that generated the blip.

pub fn is_interactable(&self) -> bool

Check if the physics engine is solving interaction between the controller entity and the blip entity.

pub fn closest_point(&self) -> TnuaPointProjectionResult

Closest point (to the controller entity) on the surface of the collider that generated the blip.

pub fn closest_point_from( &self, point: Vector3, solid: bool, ) -> TnuaPointProjectionResult

Closest point (to some provided point) on the surface of the collider that generated the blip.

pub fn closest_point_from_offset( &self, offset: Vector3, solid: bool, ) -> TnuaPointProjectionResult

Closest point (to an offset from the controller entity) on the surface of the collider that generated the blip.

pub fn flat_wall_score(&self, up: Dir3, offsets: &[Float]) -> Float

A number between 0.0 (floor) and 1.0 (wall) indicating how close the blip is to a perfectly vertical wall.

pub fn probe_extent_from_closest_point( &self, direction: Dir3, probe_at_distance: Float, ) -> Float

Try traversing the geometry from the closest_point along direction until reaching probe_at_distance.

If the geometry reaches that distance (and behind), that distance will be returned.

If the geometry does not reach the desired distance, and it ends in a right angle or acute angle, the distance to that point will be returned.

If the geometry does not reach the desired distance, and it “ends” in an obtuse angle, the returned value will be between that point and probe_at_distance.

This is useful to detect when the character is near the top of a wall or of a climbable object.

Maybe have weird results if used on concave colliders, and the distance may not be accurate in genral, so always use a threshold

pub fn direction_to_closest_point(&self) -> Result<Dir3, InvalidDirectionError>

The direction from the controller entity to the blip’s surface.

If the controller entity is inside the blip surface (possible when the physics engine is set to not solve contacts between them), this will still point into the insdie of the blip entity.

pub fn normal_from_closest_point(&self) -> Vector3

The normal on the surface of the blip collider at the closest point.

pub fn spatial_relation(&self, threshold: Float) -> TnuaBlipSpatialRelation

Where is the blip collider located relative to the controller entity.