Struct bevy_rapier2d::dynamics::SpringJoint
source · #[repr(transparent)]pub struct SpringJoint {
pub data: GenericJoint,
}
Expand description
A spring-damper joint, applies a force proportional to the distance between two objects.
The spring is integrated implicitly, implying that even an undamped spring will be subject to some amount of numerical damping (so it will eventually come to a rest). More solver iterations, or smaller timesteps, will lower the effect of numerical damping, providing a more realistic result.
Fields§
§data: GenericJoint
The underlying joint data.
Implementations§
source§impl SpringJoint
impl SpringJoint
sourcepub fn new(rest_length: Real, stiffness: Real, damping: Real) -> Self
pub fn new(rest_length: Real, stiffness: Real, damping: Real) -> Self
Creates a new spring joint limiting the max distance between two bodies.
The max_dist
must be strictly greater than 0.0.
sourcepub fn data(&self) -> &GenericJoint
pub fn data(&self) -> &GenericJoint
The underlying generic joint.
sourcepub fn contacts_enabled(&self) -> bool
pub fn contacts_enabled(&self) -> bool
Are contacts between the attached rigid-bodies enabled?
sourcepub fn set_contacts_enabled(&mut self, enabled: bool) -> &mut Self
pub fn set_contacts_enabled(&mut self, enabled: bool) -> &mut Self
Sets whether contacts between the attached rigid-bodies are enabled.
sourcepub fn local_anchor1(&self) -> Vect
pub fn local_anchor1(&self) -> Vect
The joint’s anchor, expressed in the local-space of the first rigid-body.
sourcepub fn set_local_anchor1(&mut self, anchor1: Vect) -> &mut Self
pub fn set_local_anchor1(&mut self, anchor1: Vect) -> &mut Self
Sets the joint’s anchor, expressed in the local-space of the first rigid-body.
sourcepub fn local_anchor2(&self) -> Vect
pub fn local_anchor2(&self) -> Vect
The joint’s anchor, expressed in the local-space of the second rigid-body.
sourcepub fn set_local_anchor2(&mut self, anchor2: Vect) -> &mut Self
pub fn set_local_anchor2(&mut self, anchor2: Vect) -> &mut Self
Sets the joint’s anchor, expressed in the local-space of the second rigid-body.
sourcepub fn set_spring_model(&mut self, model: MotorModel) -> &mut Self
pub fn set_spring_model(&mut self, model: MotorModel) -> &mut Self
Set the spring model used by this joint to reach the desired target velocity and position.
Setting this to MotorModel::ForceBased
(which is the default value for this joint) makes the spring constants
(stiffness and damping) parameter understood as in the regular spring-mass-damper system. With
MotorModel::AccelerationBased
, the spring constants will be automatically scaled by the attached masses,
making the spring more mass-independent.
Trait Implementations§
source§impl Clone for SpringJoint
impl Clone for SpringJoint
source§fn clone(&self) -> SpringJoint
fn clone(&self) -> SpringJoint
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SpringJoint
impl Debug for SpringJoint
source§impl<'de> Deserialize<'de> for SpringJoint
impl<'de> Deserialize<'de> for SpringJoint
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 From<SpringJoint> for GenericJoint
impl From<SpringJoint> for GenericJoint
source§fn from(val: SpringJoint) -> GenericJoint
fn from(val: SpringJoint) -> GenericJoint
source§impl PartialEq for SpringJoint
impl PartialEq for SpringJoint
source§fn eq(&self, other: &SpringJoint) -> bool
fn eq(&self, other: &SpringJoint) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for SpringJoint
impl Serialize for SpringJoint
impl Copy for SpringJoint
impl StructuralPartialEq for SpringJoint
Auto Trait Implementations§
impl RefUnwindSafe for SpringJoint
impl Send for SpringJoint
impl Sync for SpringJoint
impl Unpin for SpringJoint
impl UnwindSafe for SpringJoint
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
[ShaderType
] for self
. When used in [AsBindGroup
]
derives, it is safe to assume that all images in self
exist.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
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§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
.§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
.§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.§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.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> Serialize for T
impl<T> Serialize for T
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>
fn do_erased_serialize( &self, serializer: &mut dyn Serializer ) -> Result<(), ErrorImpl>
§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 more§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).§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.