Public Member Functions | Protected Member Functions | List of all members
PxArticulationJointReducedCoordinate Class Referenceabstract
Physics

a joint between two links in an articulation. More...

#include <PxArticulationJointReducedCoordinate.h>

Inheritance diagram for PxArticulationJointReducedCoordinate:
Inheritance graph
PxArticulationJointBase PxBase
[legend]
Collaboration diagram for PxArticulationJointReducedCoordinate:
Collaboration graph
PxArticulationJointBase PxBase PxFlags\< PxBaseFlag::Enum, PxU16 \>
[legend]

Public Member Functions

virtual void setJointType (PxArticulationJointType::Enum jointType)=0
 
virtual PxArticulationJointType::Enum getJointType () const =0
 
virtual void setMotion (PxArticulationAxis::Enum axis, PxArticulationMotion::Enum motion)=0
 
virtual PxArticulationMotion::Enum getMotion (PxArticulationAxis::Enum axis) const =0
 
virtual void setLimit (PxArticulationAxis::Enum axis, const PxReal lowLimit, const PxReal highLimit)=0
 
virtual void getLimit (PxArticulationAxis::Enum axis, PxReal &lowLimit, PxReal &highLimit)=0
 
virtual void setDrive (PxArticulationAxis::Enum axis, const PxReal stiffness, const PxReal damping, const PxReal maxForce, bool isAccelerationDrive=false)=0
 
virtual void getDrive (PxArticulationAxis::Enum axis, PxReal &stiffness, PxReal &damping, PxReal &maxForce, bool &isAcceleration)=0
 
virtual void setDriveTarget (PxArticulationAxis::Enum axis, const PxReal target)=0
 
virtual void setDriveVelocity (PxArticulationAxis::Enum axis, const PxReal targetVel)=0
 
virtual PxReal getDriveTarget (PxArticulationAxis::Enum axis)=0
 
virtual PxReal getDriveVelocity (PxArticulationAxis::Enum axis)=0
 
virtual void setFrictionCoefficient (const PxReal coefficient)=0
 
virtual PxReal getFrictionCoefficient () const =0
 
virtual const char * getConcreteTypeName () const
 Returns string name of dynamic type. More...
 
virtual void setMaxJointVelocity (const PxReal maxJointV)=0
 
virtual PxReal getMaxJointVelocity () const =0
 
- Public Member Functions inherited from PxArticulationJointBase
virtual PxArticulationLink & getParentArticulationLink () const =0
 get the parent articulation link to which this articulation joint belongs More...
 
virtual void setParentPose (const PxTransform &pose)=0
 set the joint pose in the parent frame More...
 
virtual PxTransform getParentPose () const =0
 get the joint pose in the parent frame More...
 
virtual PxArticulationLink & getChildArticulationLink () const =0
 get the child articulation link to which this articulation joint belongs More...
 
virtual void setChildPose (const PxTransform &pose)=0
 set the joint pose in the child frame More...
 
virtual PxTransform getChildPose () const =0
 get the joint pose in the child frame More...
 
virtual PxArticulationJointImpl * getImpl ()=0
 
virtual const PxArticulationJointImpl * getImpl () const =0
 
virtual ~PxArticulationJointBase ()
 
- Public Member Functions inherited from PxBase
virtual void release ()=0
 Releases the PxBase instance, please check documentation of release in derived class. More...
 
template<class T >
T * is ()
 
template<class T >
const T * is () const
 
PX_FORCE_INLINE PxType getConcreteType () const
 Returns concrete type of object. More...
 
PX_FORCE_INLINE void setBaseFlag (PxBaseFlag::Enum flag, bool value)
 Set PxBaseFlag. More...
 
PX_FORCE_INLINE void setBaseFlags (PxBaseFlags inFlags)
 Set PxBaseFlags. More...
 
PX_FORCE_INLINE PxBaseFlags getBaseFlags () const
 Returns PxBaseFlags. More...
 
virtual bool isReleasable () const
 Whether the object is subordinate. More...
 

Protected Member Functions

PX_INLINE PxArticulationJointReducedCoordinate (PxType concreteType, PxBaseFlags baseFlags)
 
PX_INLINE PxArticulationJointReducedCoordinate (PxBaseFlags baseFlags)
 
virtual ~PxArticulationJointReducedCoordinate ()
 
virtual bool isKindOf (const char *name) const
 Returns whether a given type name matches with the type of this instance. More...
 
- Protected Member Functions inherited from PxArticulationJointBase
PX_INLINE PxArticulationJointBase (PxType concreteType, PxBaseFlags baseFlags)
 
PX_INLINE PxArticulationJointBase (PxBaseFlags baseFlags)
 
- Protected Member Functions inherited from PxBase
PX_INLINE PxBase (PxType concreteType, PxBaseFlags baseFlags)
 Constructor setting concrete type and base flags. More...
 
PX_INLINE PxBase (PxBaseFlags baseFlags)
 Deserialization constructor setting base flags. More...
 
virtual ~PxBase ()
 Destructor. More...
 
template<class T >
bool typeMatch () const
 

Additional Inherited Members

- Protected Attributes inherited from PxBase
PxType mConcreteType
 
PxBaseFlags mBaseFlags
 

Detailed Description

a joint between two links in an articulation.

The joint model is very similar to a PxSphericalJoint with swing and twist limits, and an implicit drive model.

See also
PxArticulation PxArticulationLink

Constructor & Destructor Documentation

◆ PxArticulationJointReducedCoordinate() [1/2]

PX_INLINE PxArticulationJointReducedCoordinate::PxArticulationJointReducedCoordinate ( PxType  concreteType,
PxBaseFlags  baseFlags 
)
inlineprotected

◆ PxArticulationJointReducedCoordinate() [2/2]

PX_INLINE PxArticulationJointReducedCoordinate::PxArticulationJointReducedCoordinate ( PxBaseFlags  baseFlags)
inlineprotected

◆ ~PxArticulationJointReducedCoordinate()

virtual PxArticulationJointReducedCoordinate::~PxArticulationJointReducedCoordinate ( )
inlineprotectedvirtual

Member Function Documentation

◆ getConcreteTypeName()

virtual const char* PxArticulationJointReducedCoordinate::getConcreteTypeName ( ) const
inlinevirtual

Returns string name of dynamic type.

Returns
Class name of most derived type of this object.

Implements PxBase.

◆ getDrive()

virtual void PxArticulationJointReducedCoordinate::getDrive ( PxArticulationAxis::Enum  axis,
PxReal &  stiffness,
PxReal &  damping,
PxReal &  maxForce,
bool &  isAcceleration 
)
pure virtual

◆ getDriveTarget()

virtual PxReal PxArticulationJointReducedCoordinate::getDriveTarget ( PxArticulationAxis::Enum  axis)
pure virtual

◆ getDriveVelocity()

virtual PxReal PxArticulationJointReducedCoordinate::getDriveVelocity ( PxArticulationAxis::Enum  axis)
pure virtual

◆ getFrictionCoefficient()

virtual PxReal PxArticulationJointReducedCoordinate::getFrictionCoefficient ( ) const
pure virtual

◆ getJointType()

virtual PxArticulationJointType::Enum PxArticulationJointReducedCoordinate::getJointType ( ) const
pure virtual

◆ getLimit()

virtual void PxArticulationJointReducedCoordinate::getLimit ( PxArticulationAxis::Enum  axis,
PxReal &  lowLimit,
PxReal &  highLimit 
)
pure virtual

◆ getMaxJointVelocity()

virtual PxReal PxArticulationJointReducedCoordinate::getMaxJointVelocity ( ) const
pure virtual

◆ getMotion()

virtual PxArticulationMotion::Enum PxArticulationJointReducedCoordinate::getMotion ( PxArticulationAxis::Enum  axis) const
pure virtual

◆ isKindOf()

virtual bool PxArticulationJointReducedCoordinate::isKindOf ( const char *  superClass) const
inlineprotectedvirtual

Returns whether a given type name matches with the type of this instance.

Reimplemented from PxArticulationJointBase.

References PxBase::isKindOf().

◆ setDrive()

virtual void PxArticulationJointReducedCoordinate::setDrive ( PxArticulationAxis::Enum  axis,
const PxReal  stiffness,
const PxReal  damping,
const PxReal  maxForce,
bool  isAccelerationDrive = false 
)
pure virtual

◆ setDriveTarget()

virtual void PxArticulationJointReducedCoordinate::setDriveTarget ( PxArticulationAxis::Enum  axis,
const PxReal  target 
)
pure virtual

◆ setDriveVelocity()

virtual void PxArticulationJointReducedCoordinate::setDriveVelocity ( PxArticulationAxis::Enum  axis,
const PxReal  targetVel 
)
pure virtual

◆ setFrictionCoefficient()

virtual void PxArticulationJointReducedCoordinate::setFrictionCoefficient ( const PxReal  coefficient)
pure virtual

◆ setJointType()

virtual void PxArticulationJointReducedCoordinate::setJointType ( PxArticulationJointType::Enum  jointType)
pure virtual

◆ setLimit()

virtual void PxArticulationJointReducedCoordinate::setLimit ( PxArticulationAxis::Enum  axis,
const PxReal  lowLimit,
const PxReal  highLimit 
)
pure virtual

◆ setMaxJointVelocity()

virtual void PxArticulationJointReducedCoordinate::setMaxJointVelocity ( const PxReal  maxJointV)
pure virtual

◆ setMotion()

virtual void PxArticulationJointReducedCoordinate::setMotion ( PxArticulationAxis::Enum  axis,
PxArticulationMotion::Enum  motion 
)
pure virtual
The documentation for this class was generated from the following file: