Struct heron::rapier_plugin::rapier2d::dynamics::RigidBodyBuilder [−]
pub struct RigidBodyBuilder {
pub position: Isometry<f32, Unit<Complex<f32>>, 2_usize>,
pub linvel: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>,
pub angvel: f32,
pub gravity_scale: f32,
pub linear_damping: f32,
pub angular_damping: f32,
pub mass_properties: MassProperties,
pub can_sleep: bool,
pub sleeping: bool,
pub ccd_enabled: bool,
pub dominance_group: i8,
pub user_data: u128,
// some fields omitted
}
Expand description
A builder for rigid-bodies.
Fields
position: Isometry<f32, Unit<Complex<f32>>, 2_usize>
The initial position of the rigid-body to be built.
linvel: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>
The linear velocity of the rigid-body to be built.
angvel: f32
The angular velocity of the rigid-body to be built.
gravity_scale: f32
The scale factor applied to the gravity affecting the rigid-body to be built, 1.0
by default.
linear_damping: f32
Damping factor for gradually slowing down the translational motion of the rigid-body, 0.0
by default.
angular_damping: f32
Damping factor for gradually slowing down the angular motion of the rigid-body, 0.0
by default.
mass_properties: MassProperties
The additional mass properties of the rigid-body being built. See RigidBodyBuilder::additional_mass_properties
for more information.
can_sleep: bool
Whether or not the rigid-body to be created can sleep if it reaches a dynamic equilibrium.
sleeping: bool
Whether or not the rigid-body is to be created asleep.
ccd_enabled: bool
Whether continuous collision-detection is enabled for the rigid-body to be built.
dominance_group: i8
The dominance group of the rigid-body to be built.
user_data: u128
An arbitrary user-defined 128-bit integer associated to the rigid-bodies built by this builder.
Implementations
impl RigidBodyBuilder
impl RigidBodyBuilder
pub fn new(rb_type: RigidBodyType) -> RigidBodyBuilder
pub fn new(rb_type: RigidBodyType) -> RigidBodyBuilder
Initialize a new builder for a rigid body which is either static, dynamic, or kinematic.
pub fn new_static() -> RigidBodyBuilder
pub fn new_static() -> RigidBodyBuilder
Initializes the builder of a new static rigid body.
pub fn new_kinematic_velocity_based() -> RigidBodyBuilder
pub fn new_kinematic_velocity_based() -> RigidBodyBuilder
Initializes the builder of a new kinematic rigid body.
pub fn new_kinematic_position_based() -> RigidBodyBuilder
pub fn new_kinematic_position_based() -> RigidBodyBuilder
Initializes the builder of a new kinematic rigid body.
pub fn new_dynamic() -> RigidBodyBuilder
pub fn new_dynamic() -> RigidBodyBuilder
Initializes the builder of a new dynamic rigid body.
pub fn gravity_scale(self, scale_factor: f32) -> RigidBodyBuilder
pub fn gravity_scale(self, scale_factor: f32) -> RigidBodyBuilder
Sets the scale applied to the gravity force affecting the rigid-body to be created.
pub fn dominance_group(self, group: i8) -> RigidBodyBuilder
pub fn dominance_group(self, group: i8) -> RigidBodyBuilder
Sets the dominance group of this rigid-body.
pub fn translation(
self,
translation: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>
) -> RigidBodyBuilder
pub fn translation(
self,
translation: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>
) -> RigidBodyBuilder
Sets the initial translation of the rigid-body to be created.
pub fn rotation(self, angle: f32) -> RigidBodyBuilder
pub fn rotation(self, angle: f32) -> RigidBodyBuilder
Sets the initial orientation of the rigid-body to be created.
Sets the initial position (translation and orientation) of the rigid-body to be created.
pub fn user_data(self, data: u128) -> RigidBodyBuilder
pub fn user_data(self, data: u128) -> RigidBodyBuilder
An arbitrary user-defined 128-bit integer associated to the rigid-bodies built by this builder.
pub fn additional_mass_properties(
self,
props: MassProperties
) -> RigidBodyBuilder
pub fn additional_mass_properties(
self,
props: MassProperties
) -> RigidBodyBuilder
Sets the additional mass properties of the rigid-body being built.
Note that “additional” means that the final mass properties of the rigid-bodies depends on the initial mass-properties of the rigid-body (set by this method) to which is added the contributions of all the colliders with non-zero density attached to this rigid-body.
Therefore, if you want your provided mass properties to be the final mass properties of your rigid-body, don’t attach colliders to it, or only attach colliders with densities equal to zero.
pub fn lock_translations(self) -> RigidBodyBuilder
pub fn lock_translations(self) -> RigidBodyBuilder
Prevents this rigid-body from translating because of forces.
pub fn lock_rotations(self) -> RigidBodyBuilder
pub fn lock_rotations(self) -> RigidBodyBuilder
Prevents this rigid-body from rotating because of forces.
pub fn additional_mass(self, mass: f32) -> RigidBodyBuilder
pub fn additional_mass(self, mass: f32) -> RigidBodyBuilder
Sets the additional mass of the rigid-body being built.
This is only the “additional” mass because the total mass of the rigid-body is equal to the sum of this additional mass and the mass computed from the colliders (with non-zero densities) attached to this rigid-body.
pub fn mass(self, mass: f32) -> RigidBodyBuilder
👎 Deprecated: renamed to additional_mass
.
pub fn mass(self, mass: f32) -> RigidBodyBuilder
renamed to additional_mass
.
Sets the additional mass of the rigid-body being built.
This is only the “additional” mass because the total mass of the rigid-body is equal to the sum of this additional mass and the mass computed from the colliders (with non-zero densities) attached to this rigid-body.
pub fn additional_principal_angular_inertia(
self,
inertia: f32
) -> RigidBodyBuilder
pub fn additional_principal_angular_inertia(
self,
inertia: f32
) -> RigidBodyBuilder
Sets the additional angular inertia of this rigid-body.
This is only the “additional” angular inertia because the total angular inertia of the rigid-body is equal to the sum of this additional value and the angular inertia computed from the colliders (with non-zero densities) attached to this rigid-body.
pub fn principal_angular_inertia(self, inertia: f32) -> RigidBodyBuilder
👎 Deprecated: renamed to additional_principal_angular_inertia
.
pub fn principal_angular_inertia(self, inertia: f32) -> RigidBodyBuilder
renamed to additional_principal_angular_inertia
.
Sets the angular inertia of this rigid-body.
pub fn principal_inertia(self, inertia: f32) -> RigidBodyBuilder
👎 Deprecated: renamed to additional_principal_angular_inertia
.
pub fn principal_inertia(self, inertia: f32) -> RigidBodyBuilder
renamed to additional_principal_angular_inertia
.
Use self.principal_angular_inertia
instead.
pub fn linear_damping(self, factor: f32) -> RigidBodyBuilder
pub fn linear_damping(self, factor: f32) -> RigidBodyBuilder
Sets the damping factor for the linear part of the rigid-body motion.
The higher the linear damping factor is, the more quickly the rigid-body will slow-down its translational movement.
pub fn angular_damping(self, factor: f32) -> RigidBodyBuilder
pub fn angular_damping(self, factor: f32) -> RigidBodyBuilder
Sets the damping factor for the angular part of the rigid-body motion.
The higher the angular damping factor is, the more quickly the rigid-body will slow-down its rotational movement.
pub fn linvel(
self,
linvel: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>
) -> RigidBodyBuilder
pub fn linvel(
self,
linvel: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 2_usize, 1_usize>>
) -> RigidBodyBuilder
Sets the initial linear velocity of the rigid-body to be created.
pub fn angvel(self, angvel: f32) -> RigidBodyBuilder
pub fn angvel(self, angvel: f32) -> RigidBodyBuilder
Sets the initial angular velocity of the rigid-body to be created.
pub fn can_sleep(self, can_sleep: bool) -> RigidBodyBuilder
pub fn can_sleep(self, can_sleep: bool) -> RigidBodyBuilder
Sets whether or not the rigid-body to be created can sleep if it reaches a dynamic equilibrium.
pub fn ccd_enabled(self, enabled: bool) -> RigidBodyBuilder
pub fn ccd_enabled(self, enabled: bool) -> RigidBodyBuilder
Sets whether or not continuous collision-detection is enabled for this rigid-body.
pub fn sleeping(self, sleeping: bool) -> RigidBodyBuilder
pub fn sleeping(self, sleeping: bool) -> RigidBodyBuilder
Sets whether or not the rigid-body is to be created asleep.
Trait Implementations
impl Clone for RigidBodyBuilder
impl Clone for RigidBodyBuilder
pub fn clone(&self) -> RigidBodyBuilder
pub fn clone(&self) -> RigidBodyBuilder
Returns a copy of the value. Read more
Performs copy-assignment from source
. Read more
impl Debug for RigidBodyBuilder
impl Debug for RigidBodyBuilder
impl PartialEq<RigidBodyBuilder> for RigidBodyBuilder
impl PartialEq<RigidBodyBuilder> for RigidBodyBuilder
pub fn eq(&self, other: &RigidBodyBuilder) -> bool
pub fn eq(&self, other: &RigidBodyBuilder) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
pub fn ne(&self, other: &RigidBodyBuilder) -> bool
pub fn ne(&self, other: &RigidBodyBuilder) -> bool
This method tests for !=
.
impl StructuralPartialEq for RigidBodyBuilder
Auto Trait Implementations
impl RefUnwindSafe for RigidBodyBuilder
impl Send for RigidBodyBuilder
impl Sync for RigidBodyBuilder
impl Unpin for RigidBodyBuilder
impl UnwindSafe for RigidBodyBuilder
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert 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 more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more