Struct rapier3d::dynamics::PrismaticJoint [−][src]
pub struct PrismaticJoint {}Show fields
pub local_anchor1: Point<Real>, pub local_anchor2: Point<Real>, pub impulse: Vector5<Real>, pub limits_enabled: bool, pub limits: [Real; 2], pub limits_impulse: Real, pub motor_target_vel: Real, pub motor_target_pos: Real, pub motor_stiffness: Real, pub motor_damping: Real, pub motor_max_impulse: Real, pub motor_impulse: Real, pub motor_model: SpringModel, // some fields omitted
Expand description
A joint that removes all relative motion between two bodies, except for the translations along one axis.
Fields
local_anchor1: Point<Real>
Where the prismatic joint is attached on the first body, expressed in the local space of the first attached body.
local_anchor2: Point<Real>
Where the prismatic joint is attached on the second body, expressed in the local space of the second attached body.
impulse: Vector5<Real>
The impulse applied by this joint on the first body.
The impulse applied to the second body is given by -impulse
.
limits_enabled: bool
Whether or not this joint should enforce translational limits along its axis.
limits: [Real; 2]
The min an max relative position of the attached bodies along this joint’s axis.
limits_impulse: Real
The impulse applied by this joint on the first body to enforce the position limit along this joint’s axis.
The impulse applied to the second body is given by -impulse
.
motor_target_vel: Real
The target relative angular velocity the motor will attempt to reach.
motor_target_pos: Real
The target relative angle along the joint axis the motor will attempt to reach.
motor_stiffness: Real
The motor’s stiffness.
See the documentation of SpringModel
for more information on this parameter.
motor_damping: Real
The motor’s damping.
See the documentation of SpringModel
for more information on this parameter.
motor_max_impulse: Real
The maximal impulse the motor is able to deliver.
motor_impulse: Real
The angular impulse applied by the motor.
motor_model: SpringModel
The spring-like model used by the motor to reach the target velocity and .
Implementations
impl PrismaticJoint
[src]
impl PrismaticJoint
[src]pub fn new(
local_anchor1: Point<Real>,
local_axis1: Unit<Vector<Real>>,
local_tangent1: Vector<Real>,
local_anchor2: Point<Real>,
local_axis2: Unit<Vector<Real>>,
local_tangent2: Vector<Real>
) -> Self
[src]
pub fn new(
local_anchor1: Point<Real>,
local_axis1: Unit<Vector<Real>>,
local_tangent1: Vector<Real>,
local_anchor2: Point<Real>,
local_axis2: Unit<Vector<Real>>,
local_tangent2: Vector<Real>
) -> Self
[src]Creates a new prismatic joint with the given point of applications and axis, all expressed in the local-space of the affected bodies.
The local tangent are vector orthogonal to the local axis. It is used to compute a basis orthonormal to the joint’s axis. If this tangent is set to zero, te orthonormal basis will be automatically computed arbitrarily.
pub fn local_axis1(&self) -> Unit<Vector<Real>>
[src]
pub fn local_axis1(&self) -> Unit<Vector<Real>>
[src]The local axis of this joint, expressed in the local-space of the first attached body.
pub fn local_axis2(&self) -> Unit<Vector<Real>>
[src]
pub fn local_axis2(&self) -> Unit<Vector<Real>>
[src]The local axis of this joint, expressed in the local-space of the second attached body.
pub fn supports_simd_constraints(&self) -> bool
[src]
pub fn supports_simd_constraints(&self) -> bool
[src]Can a SIMD constraint be used for resolving this joint?
pub fn configure_motor_model(&mut self, model: SpringModel)
[src]
pub fn configure_motor_model(&mut self, model: SpringModel)
[src]Set the spring-like model used by the motor to reach the desired target velocity and position.
pub fn configure_motor_velocity(&mut self, target_vel: Real, factor: Real)
[src]
pub fn configure_motor_velocity(&mut self, target_vel: Real, factor: Real)
[src]Sets the target velocity this motor needs to reach.
pub fn configure_motor_position(
&mut self,
target_pos: Real,
stiffness: Real,
damping: Real
)
[src]
pub fn configure_motor_position(
&mut self,
target_pos: Real,
stiffness: Real,
damping: Real
)
[src]Sets the target position this motor needs to reach.
Trait Implementations
impl Clone for PrismaticJoint
[src]
impl Clone for PrismaticJoint
[src]fn clone(&self) -> PrismaticJoint
[src]
fn clone(&self) -> PrismaticJoint
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl From<PrismaticJoint> for JointParams
[src]
impl From<PrismaticJoint> for JointParams
[src]fn from(j: PrismaticJoint) -> Self
[src]
fn from(j: PrismaticJoint) -> Self
[src]Performs the conversion.
impl Copy for PrismaticJoint
[src]
Auto Trait Implementations
impl RefUnwindSafe for PrismaticJoint
impl Send for PrismaticJoint
impl Sync for PrismaticJoint
impl Unpin for PrismaticJoint
impl UnwindSafe for PrismaticJoint
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
[src]
impl<T> Downcast for T where
T: Any,
[src]pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
[src]
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
[src]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>
[src]
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
[src]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
pub fn as_any(&self) -> &(dyn Any + 'static)
[src]
pub fn as_any(&self) -> &(dyn Any + 'static)
[src]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)
[src]
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
[src]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> DowncastSync for T where
T: Any + Send + Sync,
[src]
impl<T> DowncastSync for T where
T: Any + Send + Sync,
[src]impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]pub fn to_subset(&self) -> Option<SS>
[src]
pub fn to_subset(&self) -> Option<SS>
[src]The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
[src]
pub fn is_in_subset(&self) -> bool
[src]Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
[src]
pub fn to_subset_unchecked(&self) -> SS
[src]Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
[src]
pub fn from_subset(element: &SS) -> SP
[src]The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more