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

#include <PxArticulationJoint.h>

Inheritance diagram for PxArticulationJointBase:
Inheritance graph
[legend]
Collaboration diagram for PxArticulationJointBase:
Collaboration graph
[legend]

Public Member Functions

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...
 
virtual const char * getConcreteTypeName () const =0
 Returns string name of dynamic type. 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 PxArticulationJointBase (PxType concreteType, PxBaseFlags baseFlags)
 
PX_INLINE PxArticulationJointBase (PxBaseFlags baseFlags)
 
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 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
 

Constructor & Destructor Documentation

◆ ~PxArticulationJointBase()

virtual PxArticulationJointBase::~PxArticulationJointBase ( )
inlinevirtual

◆ PxArticulationJointBase() [1/2]

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

◆ PxArticulationJointBase() [2/2]

PX_INLINE PxArticulationJointBase::PxArticulationJointBase ( PxBaseFlags  baseFlags)
inlineprotected

Member Function Documentation

◆ getChildArticulationLink()

virtual PxArticulationLink& PxArticulationJointBase::getChildArticulationLink ( ) const
pure virtual

get the child articulation link to which this articulation joint belongs

Returns
the articulation link to which this joint belongs

◆ getChildPose()

virtual PxTransform PxArticulationJointBase::getChildPose ( ) const
pure virtual

get the joint pose in the child frame

Returns
the joint pose in the child frame
See also
setChildPose()

◆ getImpl() [1/2]

virtual PxArticulationJointImpl* PxArticulationJointBase::getImpl ( )
pure virtual

◆ getImpl() [2/2]

virtual const PxArticulationJointImpl* PxArticulationJointBase::getImpl ( ) const
pure virtual

◆ getParentArticulationLink()

virtual PxArticulationLink& PxArticulationJointBase::getParentArticulationLink ( ) const
pure virtual

get the parent articulation link to which this articulation joint belongs

Returns
the articulation link to which this joint belongs

◆ getParentPose()

virtual PxTransform PxArticulationJointBase::getParentPose ( ) const
pure virtual

get the joint pose in the parent frame

Returns
the joint pose in the parent frame
See also
setParentPose()

◆ isKindOf()

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

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

Reimplemented from PxBase.

Reimplemented in PxArticulationJoint, and PxArticulationJointReducedCoordinate.

References PxBase::isKindOf().

Referenced by PxArticulationJoint::isKindOf().

◆ setChildPose()

virtual void PxArticulationJointBase::setChildPose ( const PxTransform &  pose)
pure virtual

set the joint pose in the child frame

Parameters
[in]posethe joint pose in the child frame Default: the identity matrix
See also
getChildPose()

◆ setParentPose()

virtual void PxArticulationJointBase::setParentPose ( const PxTransform &  pose)
pure virtual

set the joint pose in the parent frame

Parameters
[in]posethe joint pose in the parent frame Default: the identity matrix
See also
getParentPose()
The documentation for this class was generated from the following file: