Struct nphysics2d::object::Collider

#[repr(transparent)]
pub struct Collider<N: RealField, Handle: BodyHandle>(_);

A geometric entity that can be attached to a body so it can be affected by contacts and proximity queries.

Methods

impl<N: RealField, Handle: BodyHandle> Collider<N, Handle>

pub fn removal_data(&self) -> Option<ColliderRemovalData<N, Handle>>

Computes the data that needs to be returned once this collider has been removed from a collider set.

pub fn user_data(&self) -> Option<&(dyn Any + Send + Sync)>

The user-data attached to this collider.

pub fn user_data_mut(&mut self) -> Option<&mut (dyn Any + Send + Sync)>

Mutable reference to the user-data attached to this collider.

pub fn set_user_data(
    &mut self,
    data: Option<Box<dyn Any + Send + Sync>>
) -> Option<Box<dyn Any + Send + Sync>>

Sets the user-data attached to this collider.

pub fn take_user_data(&mut self) -> Option<Box<dyn Any + Send + Sync>>

Replaces the user-data of this collider by None and returns the old value.

pub fn margin(&self) -> N

The collision margin surrounding this collider.

pub fn set_margin(&mut self, margin: N)

Sets the marging on this collider's shapes.

pub fn clear_update_flags(&mut self)

Clears all the internal flags tracking changes made to this collider.

pub fn density(&self) -> N

The density of this collider.

pub fn body(&self) -> Handle

Handle to the body this collider is attached to.

pub fn anchor(&self) -> &ColliderAnchor<N, Handle>

The anchor attaching this collider with a body part or deformable body.

pub fn position_wrt_body(&self) -> Isometry<N>

The position of this collider geometry wrt. the body it is attached to.

pub fn body_part(&self, subshape_id: usize) -> BodyPartHandle<Handle>

Handle to the body part containing the given subshape of this collider's shape.

pub fn material(&self) -> &dyn Material<N>

The material of this collider.

pub fn material_mut(&mut self) -> &mut dyn Material<N>

A mutable reference to this collider's material.

If the material is shared, then an internal clone is performed before returning the mutable reference (this effectively calls the Arc::make_mut method to get a copy-on-write behavior).

pub fn is_sensor(&self) -> bool

Returns true if this collider is a sensor.

pub fn is_ccd_enabled(&self) -> bool

Returns true if this collider is subjected to Continuous Collision Detection (CCD).

pub fn enable_ccd(&mut self, enabled: bool)

Enables or disables Continuous Collision Detection (CCD) for this collider.

pub fn graph_index(&self) -> Option<CollisionObjectGraphIndex>

This collider's non-stable graph index.

This index may change whenever a collider is removed from the world.

pub fn set_graph_index(&mut self, index: Option<CollisionObjectGraphIndex>)

Sets the collider unique but non-stable graph index.

pub fn proxy_handle(&self) -> Option<BroadPhaseProxyHandle>

The collider's broad phase proxy unique identifier.

pub fn set_proxy_handle(&mut self, handle: Option<BroadPhaseProxyHandle>)

Sets the collider's broad phase proxy unique identifier.

pub fn position(&self) -> &Isometry<N>

The collider position.

pub fn set_position(&mut self, pos: Isometry<N>)

Sets the position of the collider.

pub fn set_position_with_prediction(
    &mut self,
    position: Isometry<N>,
    prediction: Isometry<N>
)

Sets the position of the collider.

pub fn set_deformations(&mut self, coords: &[N])

Deforms the underlying shape if possible.

Panics if the shape is not deformable.

pub fn shape(&self) -> &dyn Shape<N>

This collider's shape.

pub fn shape_handle(&self) -> &ShapeHandle<N>

This collider's shape.

pub fn set_shape(&mut self, shape: ShapeHandle<N>)

Sets this collider's shape.

pub fn collision_groups(&self) -> &CollisionGroups

The collision groups of the collider.

pub fn set_collision_groups(&mut self, groups: CollisionGroups)

Sets the collision groups of this collider.

pub fn query_type(&self) -> GeometricQueryType<N>

Returns the kind of queries this collider is expected to emit.

pub fn set_query_type(&mut self, query_type: GeometricQueryType<N>)

Sets the GeometricQueryType of the collider. Use CollisionWorld::set_query_type to use this method.

Trait Implementations

impl<N: RealField, Handle: BodyHandle> CollisionObjectRef<N> for Collider<N, Handle>

fn graph_index(&self) -> Option<CollisionObjectGraphIndex>

The interaction graph index of this collision object, if it has been registered into an interaction graph.

fn proxy_handle(&self) -> Option<BroadPhaseProxyHandle>

The broad-phase proxy handle of this collision object, if it has been registered into a broad-phase.

fn position(&self) -> &Isometry<N>

The position of this collision object.

fn predicted_position(&self) -> Option<&Isometry<N>>

The expected position of this collision object in the next updates.

fn shape(&self) -> &dyn Shape<N>

The shape of this collision object.

fn collision_groups(&self) -> &CollisionGroups

The collision groups of this collision object.

fn query_type(&self) -> GeometricQueryType<N>

The type of geometric queries this collision object is subjected to.

fn update_flags(&self) -> CollisionObjectUpdateFlags

Flags indicating what changed in this collision object.

fn compute_aabb(&self) -> AABB<N>

Computes the AABB of this collision object, ignoring self.predicted_position().

fn compute_swept_aabb(&self) -> AABB<N>

Computes the swept AABB of this collision object, taking self.predict_position() into account.