Inheritance diagram for physx::NpArticulationTendonJoint:

Collaboration diagram for physx::NpArticulationTendonJoint:

Public Member Functions
	NpArticulationTendonJoint (PxBaseFlags baseFlags)

void	preExportDataReset ()

virtual void	exportExtraData (PxSerializationContext &)

void	importExtraData (PxDeserializationContext &)

void	resolveReferences (PxDeserializationContext &)

virtual void	requiresObjects (PxProcessPxBaseCallback &)

virtual bool	isSubordinate () const

	NpArticulationTendonJoint (PxArticulationTendonJoint parent, PxArticulationAxis::Enum axis, const PxReal coefficient, const PxReal recipCoefficient, PxArticulationLink link)

virtual PxArticulationLink *	getLink () const
	Gets the articulation link.

virtual PxArticulationTendonJoint *	getParent () const
	Gets the parent tendon joint.

virtual PxArticulationFixedTendon *	getTendon () const
	Gets the tendon that the joint is a part of.

virtual void	setCoefficient (const PxArticulationAxis::Enum axis, const PxReal coefficient, const PxReal recipCoefficient)
	Sets the tendon joint coefficient.

virtual void	getCoefficient (PxArticulationAxis::Enum &axis, PxReal &coefficient, PxReal &recipCoefficient) const
	Gets the tendon joint coefficient.

virtual void	release ()
	Releases a tendon joint.

PX_FORCE_INLINE NpArticulationTendonJoint **	getChildren ()

PX_FORCE_INLINE PxU32	getNumChildren ()

PX_FORCE_INLINE void	setTendon (NpArticulationFixedTendon *tendon)

PX_FORCE_INLINE NpArticulationFixedTendon &	getTendon ()

PX_FORCE_INLINE Sc::ArticulationTendonJointCore &	getCore ()

void	removeChild (NpArticulationTendonJoint *child)

Public Member Functions inherited from physx::PxArticulationTendonJoint
virtual const char *	getConcreteTypeName () const
	Returns the string name of the dynamic type.

Public Member Functions inherited from physx::PxBase
template<class T >
T *	is ()

template<class T >
const T *	is () const

PX_FORCE_INLINE PxType	getConcreteType () const
	Returns concrete type of object.

PX_FORCE_INLINE void	setBaseFlag (PxBaseFlag::Enum flag, bool value)
	Set PxBaseFlag

PX_FORCE_INLINE void	setBaseFlags (PxBaseFlags inFlags)
	Set PxBaseFlags

PX_FORCE_INLINE PxBaseFlags	getBaseFlags () const
	Returns PxBaseFlags.

virtual bool	isReleasable () const
	Whether the object is subordinate.

Public Member Functions inherited from physx::NpBase
	NpBase (const PxEMPTY)

	NpBase (NpType::Enum type)

PX_INLINE bool	isAPIWriteForbidden () const

PX_INLINE bool	isAPIWriteForbiddenExceptSplitSim () const

PX_FORCE_INLINE NpType::Enum	getNpType () const

PX_FORCE_INLINE void	setNpScene (NpScene *scene)

PX_FORCE_INLINE NpScene *	getNpScene () const

PX_FORCE_INLINE PxU32	getBaseIndex () const

PX_FORCE_INLINE void	setBaseIndex (PxU32 index)

Public Member Functions inherited from physx::PxUserAllocated
PX_INLINE void *	operator new (size_t, void *address)

PX_INLINE void	operator delete (void , void )

template<typename Alloc >
PX_INLINE void *	operator new (size_t size, Alloc alloc, const char *fileName, int line)

template<typename Alloc >
PX_INLINE void *	operator new (size_t size, size_t, Alloc alloc, const char *fileName, int line)

template<typename Alloc >
PX_INLINE void *	operator new[] (size_t size, Alloc alloc, const char *fileName, int line)

template<typename Alloc >
PX_INLINE void *	operator new[] (size_t size, size_t, Alloc alloc, const char *fileName, int line)

template<typename Alloc >
PX_INLINE void	operator delete (void ptr, Alloc alloc, const char fileName, int line)

template<typename Alloc >
PX_INLINE void	operator delete[] (void ptr, Alloc alloc, const char fileName, int line)

PX_INLINE void	operator delete (void *ptr)

PX_INLINE void	operator delete[] (void *ptr)

Static Public Member Functions
static NpArticulationTendonJoint *	createObject (PxU8 *&address, PxDeserializationContext &context)

static void	getBinaryMetaData (PxOutputStream &stream)

Static Public Member Functions inherited from physx::NpBase
static void	getBinaryMetaData (PxOutputStream &stream)

Public Attributes
PxArticulationLink *	mLink

PxArticulationTendonJoint *	mParent

NpArticulationTendonJointArray	mChildren

NpArticulationFixedTendon *	mTendon

Sc::ArticulationTendonJointCore	mCore

PxU32	mHandle

Public Attributes inherited from physx::PxArticulationTendonJoint
void *	userData
	user can assign this to whatever, usually to create a 1:1 relationship with a user object.

Additional Inherited Members
Protected Member Functions inherited from physx::PxArticulationTendonJoint
PX_INLINE	PxArticulationTendonJoint (PxType concreteType, PxBaseFlags baseFlags)

PX_INLINE	PxArticulationTendonJoint (PxBaseFlags baseFlags)

Protected Member Functions inherited from physx::PxBase
PX_INLINE	PxBase (PxType concreteType, PxBaseFlags baseFlags)
	Constructor setting concrete type and base flags.

PX_INLINE	PxBase (PxBaseFlags baseFlags)
	Deserialization constructor setting base flags.

virtual	~PxBase ()
	Destructor.

virtual bool	isKindOf (const char *superClass) const
	Returns whether a given type name matches with the type of this instance.

template<class T >
bool	typeMatch () const

Protected Attributes inherited from physx::PxBase
PxType	mConcreteType

PxBaseFlags	mBaseFlags

PxU32	mBuiltInRefCount

Protected Attributes inherited from physx::NpBase
PxU32	mFreeSlot

Member Function Documentation

◆ getCoefficient()

void NpArticulationTendonJoint::getCoefficient	(	PxArticulationAxis::Enum &	axis,
		PxReal &	coefficient,
		PxReal &	recipCoefficient
	)		const

virtual

Gets the tendon joint coefficient.

Parameters

[out]	axis	The degree of freedom that the tendon joint operates on.
[out]	coefficient	The scale that the axis' joint position is multiplied by when summing up the fixed tendon's length.
[in]	recipCoefficient	The scale that the tendon's response is multiplied by when applying to this tendon joint.

See also: setCoefficient()

Implements physx::PxArticulationTendonJoint.

◆ getLink()

virtual PxArticulationLink * physx::NpArticulationTendonJoint::getLink ( ) const

inlinevirtual

Gets the articulation link.

Returns: The articulation link (and its incoming joint in particular) that this tendon joint is associated with.

Implements physx::PxArticulationTendonJoint.

◆ getParent()

virtual PxArticulationTendonJoint * physx::NpArticulationTendonJoint::getParent ( ) const

inlinevirtual

Gets the parent tendon joint.

Returns: The parent tendon joint.

Implements physx::PxArticulationTendonJoint.

◆ getTendon()

PxArticulationFixedTendon * physx::NpArticulationTendonJoint::getTendon ( ) const

virtual

Gets the tendon that the joint is a part of.

Returns: The tendon.

See also: PxArticulationFixedTendon

Implements physx::PxArticulationTendonJoint.

◆ release()

void NpArticulationTendonJoint::release ( )

virtual

Releases a tendon joint.

Note: Releasing a tendon joint is not allowed while the articulation is in a scene. In order to release the joint, remove and then re-add the articulation to the scene.

See also: PxArticulationFixedTendon::createTendonJoint()

Implements physx::PxArticulationTendonJoint.

◆ setCoefficient()

void NpArticulationTendonJoint::setCoefficient	(	const PxArticulationAxis::Enum	axis,
		const PxReal	coefficient,
		const PxReal	recipCoefficient
	)

virtual

Sets the tendon joint coefficient.

Parameters

[in]	axis	The degree of freedom that the tendon joint operates on (must correspond to a degree of freedom of the associated link's incoming joint).
[in]	coefficient	The scale that the axis' joint position is multiplied by when summing up the fixed tendon's length.
[in]	recipCoefficient	The scale that the tendon's response is multiplied by when applying to this tendon joint.

Note: RecipCoefficient is commonly expected to be 1/coefficient, but it can be set to different values to tune behavior; for example, zero can be used to have a joint axis only participate in the length computation of the tendon, but not have any tendon force applied to it.

See also: getCoefficient()

Implements physx::PxArticulationTendonJoint.

The documentation for this class was generated from the following files:

RavEngine/deps/physx/physx/source/physx/src/NpArticulationTendon.h
RavEngine/deps/physx/physx/source/physx/src/NpArticulationTendon.cpp
RavEngine/deps/physx/physx/source/physx/src/NpMetaData.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

◆ getCoefficient()

◆ getLink()

◆ getParent()

◆ getTendon()

◆ release()

◆ setCoefficient()