Struct heron::rapier_plugin::rapier2d::dynamics::RigidBody
pub struct RigidBody {
pub user_data: u128,
/* private fields */
}
Expand description
A rigid body.
To create a new rigid-body, use the RigidBodyBuilder
structure.
Fields
user_data: u128
User-defined data associated to this rigid-body.
Implementations
impl RigidBody
impl RigidBody
pub fn activation(&self) -> &RigidBodyActivation
pub fn activation(&self) -> &RigidBodyActivation
The activation status of this rigid-body.
pub fn activation_mut(&mut self) -> &mut RigidBodyActivation
pub fn activation_mut(&mut self) -> &mut RigidBodyActivation
Mutable reference to the activation status of this rigid-body.
pub fn linear_damping(&self) -> f32
pub fn linear_damping(&self) -> f32
The linear damping coefficient of this rigid-body.
pub fn set_linear_damping(&mut self, damping: f32)
pub fn set_linear_damping(&mut self, damping: f32)
Sets the linear damping coefficient of this rigid-body.
pub fn angular_damping(&self) -> f32
pub fn angular_damping(&self) -> f32
The angular damping coefficient of this rigid-body.
pub fn set_angular_damping(&mut self, damping: f32)
pub fn set_angular_damping(&mut self, damping: f32)
Sets the angular damping coefficient of this rigid-body.
pub fn body_type(&self) -> RigidBodyType
pub fn body_type(&self) -> RigidBodyType
The type of this rigid-body.
pub fn set_body_type(&mut self, status: RigidBodyType)
pub fn set_body_type(&mut self, status: RigidBodyType)
Sets the type of this rigid-body.
pub fn mass_properties(&self) -> &MassProperties
pub fn mass_properties(&self) -> &MassProperties
The mass properties of this rigid-body.
pub fn effective_dominance_group(&self) -> i16
pub fn effective_dominance_group(&self) -> i16
The dominance group of this rigid-body.
This method always returns i8::MAX + 1
for non-dynamic
rigid-bodies.
pub fn set_locked_axes(&mut self, locked_axes: LockedAxes, wake_up: bool)
pub fn set_locked_axes(&mut self, locked_axes: LockedAxes, wake_up: bool)
Sets the axes along which this rigid-body cannot translate or rotate.
pub fn lock_rotations(&mut self, locked: bool, wake_up: bool)
pub fn lock_rotations(&mut self, locked: bool, wake_up: bool)
Locks or unlocks all the rotations of this rigid-body.
pub fn restrict_rotations(
&mut self,
allow_rotations_x: bool,
allow_rotations_y: bool,
allow_rotations_z: bool,
wake_up: bool
)
pub fn restrict_rotations(
&mut self,
allow_rotations_x: bool,
allow_rotations_y: bool,
allow_rotations_z: bool,
wake_up: bool
)
Locks or unlocks rotations of this rigid-body along each cartesian axes.
pub fn lock_translations(&mut self, locked: bool, wake_up: bool)
pub fn lock_translations(&mut self, locked: bool, wake_up: bool)
Locks or unlocks all the rotations of this rigid-body.
pub fn restrict_translations(
&mut self,
allow_translation_x: bool,
allow_translation_y: bool,
wake_up: bool
)
pub fn restrict_translations(
&mut self,
allow_translation_x: bool,
allow_translation_y: bool,
wake_up: bool
)
Locks or unlocks rotations of this rigid-body along each cartesian axes.
pub fn is_translation_locked(&self) -> bool
pub fn is_translation_locked(&self) -> bool
Are the translations of this rigid-body locked?
pub fn is_rotation_locked(&self) -> bool
pub fn is_rotation_locked(&self) -> bool
Are the rotations of this rigid-body locked?
pub fn enable_ccd(&mut self, enabled: bool)
pub fn enable_ccd(&mut self, enabled: bool)
Enables of disable CCD (continuous collision-detection) for this rigid-body.
CCD prevents tunneling, but may still allow limited interpenetration of colliders.
pub fn is_ccd_enabled(&self) -> bool
pub fn is_ccd_enabled(&self) -> bool
Is CCD (continous collision-detection) enabled for this rigid-body?
pub fn is_ccd_active(&self) -> bool
pub fn is_ccd_active(&self) -> bool
Is CCD active for this rigid-body?
The CCD is considered active if the rigid-body is moving at a velocity greater than an automatically-computed threshold.
This is not the same as self.is_ccd_enabled
which only
checks if CCD is allowed to run for this rigid-body or if
it is completely disabled (independently from its velocity).
pub fn set_additional_mass_properties(
&mut self,
props: MassProperties,
wake_up: bool
)
pub fn set_additional_mass_properties(
&mut self,
props: MassProperties,
wake_up: bool
)
Sets the rigid-body’s additional mass properties.
If wake_up
is true
then the rigid-body will be woken up if it was
put to sleep because it did not move for a while.
pub fn colliders(&self) -> &[ColliderHandle]
pub fn colliders(&self) -> &[ColliderHandle]
The handles of colliders attached to this rigid body.
pub fn is_dynamic(&self) -> bool
pub fn is_dynamic(&self) -> bool
Is this rigid body dynamic?
A dynamic body can move freely and is affected by forces.
pub fn is_kinematic(&self) -> bool
pub fn is_kinematic(&self) -> bool
Is this rigid body kinematic?
A kinematic body can move freely but is not affected by forces.
pub fn is_fixed(&self) -> bool
pub fn is_fixed(&self) -> bool
Is this rigid body fixed?
A fixed body cannot move and is not affected by forces.
pub fn mass(&self) -> f32
pub fn mass(&self) -> f32
The mass of this rigid body.
Returns zero if this rigid body has an infinite mass.
pub fn next_position(&self) -> &Isometry<f32, Unit<Complex<f32>>, 2>
pub fn next_position(&self) -> &Isometry<f32, Unit<Complex<f32>>, 2>
The predicted position of this rigid-body.
If this rigid-body is kinematic this value is set by the set_next_kinematic_position
method and is used for estimating the kinematic body velocity at the next timestep.
For non-kinematic bodies, this value is currently unspecified.
pub fn gravity_scale(&self) -> f32
pub fn gravity_scale(&self) -> f32
The scale factor applied to the gravity affecting this rigid-body.
pub fn set_gravity_scale(&mut self, scale: f32, wake_up: bool)
pub fn set_gravity_scale(&mut self, scale: f32, wake_up: bool)
Sets the gravity scale facter for this rigid-body.
pub fn dominance_group(&self) -> i8
pub fn dominance_group(&self) -> i8
The dominance group of this rigid-body.
pub fn set_dominance_group(&mut self, dominance: i8)
pub fn set_dominance_group(&mut self, dominance: i8)
The dominance group of this rigid-body.
pub fn add_collider(
&mut self,
co_handle: ColliderHandle,
co_parent: &ColliderParent,
co_pos: &mut ColliderPosition,
co_shape: &SharedShape,
co_mprops: &ColliderMassProps
)
pub fn add_collider(
&mut self,
co_handle: ColliderHandle,
co_parent: &ColliderParent,
co_pos: &mut ColliderPosition,
co_shape: &SharedShape,
co_mprops: &ColliderMassProps
)
Adds a collider to this rigid-body.
pub fn sleep(&mut self)
pub fn sleep(&mut self)
Put this rigid body to sleep.
A sleeping body no longer moves and is no longer simulated by the physics engine unless
it is waken up. It can be woken manually with self.wake_up
or automatically due to
external forces like contacts.
pub fn wake_up(&mut self, strong: bool)
pub fn wake_up(&mut self, strong: bool)
Wakes up this rigid body if it is sleeping.
If strong
is true
then it is assured that the rigid-body will
remain awake during multiple subsequent timesteps.
pub fn is_sleeping(&self) -> bool
pub fn is_sleeping(&self) -> bool
Is this rigid body sleeping?
pub fn linvel(
&self
) -> &Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
pub fn linvel(
&self
) -> &Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
The linear velocity of this rigid-body.
pub fn set_linvel(
&mut self,
linvel: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
wake_up: bool
)
pub fn set_linvel(
&mut self,
linvel: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
wake_up: bool
)
The linear velocity of this rigid-body.
If wake_up
is true
then the rigid-body will be woken up if it was
put to sleep because it did not move for a while.
pub fn set_angvel(&mut self, angvel: f32, wake_up: bool)
pub fn set_angvel(&mut self, angvel: f32, wake_up: bool)
The angular velocity of this rigid-body.
If wake_up
is true
then the rigid-body will be woken up if it was
put to sleep because it did not move for a while.
pub fn position(&self) -> &Isometry<f32, Unit<Complex<f32>>, 2>
pub fn position(&self) -> &Isometry<f32, Unit<Complex<f32>>, 2>
The world-space position of this rigid-body.
pub fn translation(
&self
) -> &Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
pub fn translation(
&self
) -> &Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
The translational part of this rigid-body’s position.
pub fn set_translation(
&mut self,
translation: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
wake_up: bool
)
pub fn set_translation(
&mut self,
translation: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
wake_up: bool
)
Sets the translational part of this rigid-body’s position.
pub fn set_rotation(&mut self, rotation: f32, wake_up: bool)
pub fn set_rotation(&mut self, rotation: f32, wake_up: bool)
Sets the rotational part of this rigid-body’s position.
pub fn set_position(
&mut self,
pos: Isometry<f32, Unit<Complex<f32>>, 2>,
wake_up: bool
)
pub fn set_position(
&mut self,
pos: Isometry<f32, Unit<Complex<f32>>, 2>,
wake_up: bool
)
Sets the position and next_kinematic_position
of this rigid body.
This will teleport the rigid-body to the specified position/orientation, completely ignoring any physics rule. If this body is kinematic, this will also set the next kinematic position to the same value, effectively resetting to zero the next interpolated velocity of the kinematic body.
If wake_up
is true
then the rigid-body will be woken up if it was
put to sleep because it did not move for a while.
pub fn set_next_kinematic_rotation(&mut self, rotation: f32)
pub fn set_next_kinematic_rotation(&mut self, rotation: f32)
If this rigid body is kinematic, sets its future translation after the next timestep integration.
pub fn set_next_kinematic_translation(
&mut self,
translation: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
)
pub fn set_next_kinematic_translation(
&mut self,
translation: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
)
If this rigid body is kinematic, sets its future orientation after the next timestep integration.
impl RigidBody
impl RigidBody
pub fn reset_forces(&mut self, wake_up: bool)
pub fn reset_forces(&mut self, wake_up: bool)
Resets to zero all the constant (linear) forces manually applied to this rigid-body.
pub fn reset_torques(&mut self, wake_up: bool)
pub fn reset_torques(&mut self, wake_up: bool)
Resets to zero all the constant torques manually applied to this rigid-body.
pub fn add_force(
&mut self,
force: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
wake_up: bool
)
pub fn add_force(
&mut self,
force: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
wake_up: bool
)
Adds to this rigid-body a constant force applied at its center-of-mass.ç
This does nothing on non-dynamic bodies.
pub fn add_torque(&mut self, torque: f32, wake_up: bool)
pub fn add_torque(&mut self, torque: f32, wake_up: bool)
Adds to this rigid-body a constant torque at its center-of-mass.
This does nothing on non-dynamic bodies.
impl RigidBody
impl RigidBody
pub fn apply_impulse(
&mut self,
impulse: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
wake_up: bool
)
pub fn apply_impulse(
&mut self,
impulse: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
wake_up: bool
)
Applies an impulse at the center-of-mass of this rigid-body. The impulse is applied right away, changing the linear velocity. This does nothing on non-dynamic bodies.
pub fn apply_torque_impulse(&mut self, torque_impulse: f32, wake_up: bool)
pub fn apply_torque_impulse(&mut self, torque_impulse: f32, wake_up: bool)
Applies an angular impulse at the center-of-mass of this rigid-body. The impulse is applied right away, changing the angular velocity. This does nothing on non-dynamic bodies.
pub fn apply_impulse_at_point(
&mut self,
impulse: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
point: OPoint<f32, Const<2>>,
wake_up: bool
)
pub fn apply_impulse_at_point(
&mut self,
impulse: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
point: OPoint<f32, Const<2>>,
wake_up: bool
)
Applies an impulse at the given world-space point of this rigid-body. The impulse is applied right away, changing the linear and/or angular velocities. This does nothing on non-dynamic bodies.
impl RigidBody
impl RigidBody
pub fn velocity_at_point(
&self,
point: &OPoint<f32, Const<2>>
) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
pub fn velocity_at_point(
&self,
point: &OPoint<f32, Const<2>>
) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
The velocity of the given world-space point on this rigid-body.
pub fn kinetic_energy(&self) -> f32
pub fn kinetic_energy(&self) -> f32
The kinetic energy of this body.
pub fn gravitational_potential_energy(
&self,
dt: f32,
gravity: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
) -> f32
pub fn gravitational_potential_energy(
&self,
dt: f32,
gravity: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>
) -> f32
The potential energy of this body in a gravity field.
Trait Implementations
impl Into<RigidBody> for RigidBodyBuilder
impl Into<RigidBody> for RigidBodyBuilder
Auto Trait Implementations
impl RefUnwindSafe for RigidBody
impl Send for RigidBody
impl Sync for RigidBody
impl Unpin for RigidBody
impl UnwindSafe for RigidBody
Blanket Implementations
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
T
[ShaderType
] for self
. When used in [AsBindGroup
]
derives, it is safe to assume that all images in self
exist. Read moresourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
. Read morefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read morefn 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. Read morefn 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. Read moreimpl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given [World]sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read morefn 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).fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.