pub struct Collider {
pub user_data: u128,
/* private fields */
}
Expand description
A geometric entity that can be attached to a body so it can be affected by contacts and proximity queries.
To build a new collider, use the ColliderBuilder
structure.
Fields§
§user_data: u128
User-defined data associated to this collider.
Implementations§
source§impl Collider
impl Collider
sourcepub fn parent(&self) -> Option<RigidBodyHandle>
pub fn parent(&self) -> Option<RigidBodyHandle>
The rigid body this collider is attached to.
sourcepub fn active_hooks(&self) -> ActiveHooks
pub fn active_hooks(&self) -> ActiveHooks
The physics hooks enabled for this collider.
sourcepub fn set_active_hooks(&mut self, active_hooks: ActiveHooks)
pub fn set_active_hooks(&mut self, active_hooks: ActiveHooks)
Sets the physics hooks enabled for this collider.
sourcepub fn active_events(&self) -> ActiveEvents
pub fn active_events(&self) -> ActiveEvents
The events enabled for this collider.
sourcepub fn set_active_events(&mut self, active_events: ActiveEvents)
pub fn set_active_events(&mut self, active_events: ActiveEvents)
Sets the events enabled for this collider.
sourcepub fn active_collision_types(&self) -> ActiveCollisionTypes
pub fn active_collision_types(&self) -> ActiveCollisionTypes
The collision types enabled for this collider.
sourcepub fn set_active_collision_types(
&mut self,
active_collision_types: ActiveCollisionTypes
)
pub fn set_active_collision_types( &mut self, active_collision_types: ActiveCollisionTypes )
Sets the collision types enabled for this collider.
sourcepub fn set_friction(&mut self, coefficient: Real)
pub fn set_friction(&mut self, coefficient: Real)
Sets the friction coefficient of this collider.
sourcepub fn friction_combine_rule(&self) -> CoefficientCombineRule
pub fn friction_combine_rule(&self) -> CoefficientCombineRule
The combine rule used by this collider to combine its friction coefficient with the friction coefficient of the other collider it is in contact with.
sourcepub fn set_friction_combine_rule(&mut self, rule: CoefficientCombineRule)
pub fn set_friction_combine_rule(&mut self, rule: CoefficientCombineRule)
Sets the combine rule used by this collider to combine its friction coefficient with the friction coefficient of the other collider it is in contact with.
sourcepub fn restitution(&self) -> Real
pub fn restitution(&self) -> Real
The restitution coefficient of this collider.
sourcepub fn set_restitution(&mut self, coefficient: Real)
pub fn set_restitution(&mut self, coefficient: Real)
Sets the restitution coefficient of this collider.
sourcepub fn restitution_combine_rule(&self) -> CoefficientCombineRule
pub fn restitution_combine_rule(&self) -> CoefficientCombineRule
The combine rule used by this collider to combine its restitution coefficient with the restitution coefficient of the other collider it is in contact with.
sourcepub fn set_restitution_combine_rule(&mut self, rule: CoefficientCombineRule)
pub fn set_restitution_combine_rule(&mut self, rule: CoefficientCombineRule)
Sets the combine rule used by this collider to combine its restitution coefficient with the restitution coefficient of the other collider it is in contact with.
sourcepub fn set_contact_force_event_threshold(&mut self, threshold: Real)
pub fn set_contact_force_event_threshold(&mut self, threshold: Real)
Sets the total force magnitude beyond which a contact force event can be emitted.
sourcepub fn set_sensor(&mut self, is_sensor: bool)
pub fn set_sensor(&mut self, is_sensor: bool)
Sets whether or not this is a sensor collider.
sourcepub fn is_enabled(&self) -> bool
pub fn is_enabled(&self) -> bool
Is this collider enabled?
sourcepub fn set_enabled(&mut self, enabled: bool)
pub fn set_enabled(&mut self, enabled: bool)
Sets whether or not this collider is enabled.
sourcepub fn set_translation(&mut self, translation: Vector<Real>)
pub fn set_translation(&mut self, translation: Vector<Real>)
Sets the translational part of this collider’s position.
sourcepub fn set_rotation(&mut self, rotation: Rotation<Real>)
pub fn set_rotation(&mut self, rotation: Rotation<Real>)
Sets the rotational part of this collider’s position.
sourcepub fn set_position(&mut self, position: Isometry<Real>)
pub fn set_position(&mut self, position: Isometry<Real>)
Sets the position of this collider.
sourcepub fn translation(&self) -> &Vector<Real>
pub fn translation(&self) -> &Vector<Real>
The translational part of this collider’s position.
sourcepub fn position_wrt_parent(&self) -> Option<&Isometry<Real>>
pub fn position_wrt_parent(&self) -> Option<&Isometry<Real>>
The position of this collider with respect to the body it is attached to.
sourcepub fn set_translation_wrt_parent(&mut self, translation: Vector<Real>)
pub fn set_translation_wrt_parent(&mut self, translation: Vector<Real>)
Sets the translational part of this collider’s translation relative to its parent rigid-body.
sourcepub fn set_rotation_wrt_parent(&mut self, rotation: AngVector<Real>)
pub fn set_rotation_wrt_parent(&mut self, rotation: AngVector<Real>)
Sets the rotational part of this collider’s rotaiton relative to its parent rigid-body.
sourcepub fn set_position_wrt_parent(&mut self, pos_wrt_parent: Isometry<Real>)
pub fn set_position_wrt_parent(&mut self, pos_wrt_parent: Isometry<Real>)
Sets the position of this collider with respect to its parent rigid-body.
Does nothing if the collider is not attached to a rigid-body.
sourcepub fn collision_groups(&self) -> InteractionGroups
pub fn collision_groups(&self) -> InteractionGroups
The collision groups used by this collider.
sourcepub fn set_collision_groups(&mut self, groups: InteractionGroups)
pub fn set_collision_groups(&mut self, groups: InteractionGroups)
Sets the collision groups of this collider.
sourcepub fn solver_groups(&self) -> InteractionGroups
pub fn solver_groups(&self) -> InteractionGroups
The solver groups used by this collider.
sourcepub fn set_solver_groups(&mut self, groups: InteractionGroups)
pub fn set_solver_groups(&mut self, groups: InteractionGroups)
Sets the solver groups of this collider.
sourcepub fn material(&self) -> &ColliderMaterial
pub fn material(&self) -> &ColliderMaterial
The material (friction and restitution properties) of this collider.
sourcepub fn set_density(&mut self, density: Real)
pub fn set_density(&mut self, density: Real)
Sets the uniform density of this collider.
This will override any previous mass-properties set by Self::set_density
,
Self::set_mass
, Self::set_mass_properties
, ColliderBuilder::density
,
ColliderBuilder::mass
, or ColliderBuilder::mass_properties
for this collider.
The mass and angular inertia of this collider will be computed automatically based on its shape.
sourcepub fn set_mass(&mut self, mass: Real)
pub fn set_mass(&mut self, mass: Real)
Sets the mass of this collider.
This will override any previous mass-properties set by Self::set_density
,
Self::set_mass
, Self::set_mass_properties
, ColliderBuilder::density
,
ColliderBuilder::mass
, or ColliderBuilder::mass_properties
for this collider.
The angular inertia of this collider will be computed automatically based on its shape and this mass value.
sourcepub fn set_mass_properties(&mut self, mass_properties: MassProperties)
pub fn set_mass_properties(&mut self, mass_properties: MassProperties)
Sets the mass properties of this collider.
This will override any previous mass-properties set by Self::set_density
,
Self::set_mass
, Self::set_mass_properties
, ColliderBuilder::density
,
ColliderBuilder::mass
, or ColliderBuilder::mass_properties
for this collider.
sourcepub fn shape_mut(&mut self) -> &mut dyn Shape
pub fn shape_mut(&mut self) -> &mut dyn Shape
A mutable reference to the geometric shape of this collider.
If that shape is shared by multiple colliders, it will be
cloned first so that self
contains a unique copy of that
shape that you can modify.
sourcepub fn set_shape(&mut self, shape: SharedShape)
pub fn set_shape(&mut self, shape: SharedShape)
Sets the shape of this collider.
Retrieve the SharedShape. Also see the shape()
function
sourcepub fn compute_aabb(&self) -> Aabb
pub fn compute_aabb(&self) -> Aabb
Compute the axis-aligned bounding box of this collider.
sourcepub fn compute_swept_aabb(&self, next_position: &Isometry<Real>) -> Aabb
pub fn compute_swept_aabb(&self, next_position: &Isometry<Real>) -> Aabb
Compute the axis-aligned bounding box of this collider moving from its current position
to the given next_position
sourcepub fn mass_properties(&self) -> MassProperties
pub fn mass_properties(&self) -> MassProperties
Compute the local-space mass properties of this collider.
sourcepub fn contact_force_event_threshold(&self) -> Real
pub fn contact_force_event_threshold(&self) -> Real
The total force magnitude beyond which a contact force event can be emitted.
Trait Implementations§
source§impl<'de> Deserialize<'de> for Collider
impl<'de> Deserialize<'de> for Collider
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl Into<Collider> for ColliderBuilder
impl Into<Collider> for ColliderBuilder
Auto Trait Implementations§
impl !RefUnwindSafe for Collider
impl Send for Collider
impl Sync for Collider
impl Unpin for Collider
impl !UnwindSafe for Collider
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.