Inheritance diagram for physx::NpArticulationAttachment:

Collaboration diagram for physx::NpArticulationAttachment:

Public Member Functions
	NpArticulationAttachment (PxBaseFlags baseFlags)

void	preExportDataReset ()

virtual void	exportExtraData (PxSerializationContext &)

void	importExtraData (PxDeserializationContext &)

void	resolveReferences (PxDeserializationContext &)

virtual void	requiresObjects (PxProcessPxBaseCallback &)

virtual bool	isSubordinate () const

	NpArticulationAttachment (PxArticulationAttachment parent, const PxReal coefficient, const PxVec3 relativeOffset, PxArticulationLink link)

virtual void	setRestLength (const PxReal restLength)
	Sets the spring rest length for the sub-tendon from the root to this leaf attachment.

virtual PxReal	getRestLength () const
	Gets the spring rest length for the sub-tendon from the root to this leaf attachment.

virtual void	setLimitParameters (const PxArticulationTendonLimit &paramters)
	Sets the low and high limit on the length of the sub-tendon from the root to this leaf attachment.

virtual PxArticulationTendonLimit	getLimitParameters () const
	Gets the low and high limit on the length of the sub-tendon from the root to this leaf attachment.

virtual void	setRelativeOffset (const PxVec3 &offset)
	Sets the attachment's relative offset in the link actor frame.

virtual PxVec3	getRelativeOffset () const
	Gets the attachment's relative offset in the link actor frame.

virtual void	setCoefficient (const PxReal coefficient)
	Sets the attachment coefficient.

virtual PxReal	getCoefficient () const
	Gets the attachment coefficient.

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

virtual PxArticulationAttachment *	getParent () const
	Gets the parent attachment.

virtual PxArticulationSpatialTendon *	getTendon () const
	Gets the spatial tendon that the attachment is a part of.

virtual bool	isLeaf () const
	Indicates that this attachment is a leaf, and thus defines a sub-tendon from the root to this attachment.

virtual void	release ()
	Releases the attachment.

PX_FORCE_INLINE NpArticulationAttachment **	getChildren ()

PX_FORCE_INLINE PxU32	getNumChildren ()

PX_FORCE_INLINE void	setTendon (NpArticulationSpatialTendon *tendon)

PX_FORCE_INLINE NpArticulationSpatialTendon &	getTendon ()

PX_FORCE_INLINE Sc::ArticulationAttachmentCore &	getCore ()

void	removeChild (NpArticulationAttachment *child)

Public Member Functions inherited from physx::PxArticulationAttachment
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 NpArticulationAttachment *	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

PxArticulationAttachment *	mParent

ArticulationAttachmentHandle	mHandle

NpArticulationAttachmentArray	mChildren

NpArticulationSpatialTendon *	mTendon

Sc::ArticulationAttachmentCore	mCore

Public Attributes inherited from physx::PxArticulationAttachment
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::PxArticulationAttachment
PX_INLINE	PxArticulationAttachment (PxType concreteType, PxBaseFlags baseFlags)

PX_INLINE	PxArticulationAttachment (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()

PxReal NpArticulationAttachment::getCoefficient ( ) const

virtual

Gets the attachment coefficient.

Returns: The scale that the distance between this attachment and its parent is multiplied by when summing up the spatial tendon's length.

See also: setCoefficient()

Implements physx::PxArticulationAttachment.

◆ getLimitParameters()

PxArticulationTendonLimit NpArticulationAttachment::getLimitParameters ( ) const

virtual

Gets the low and high limit on the length of the sub-tendon from the root to this leaf attachment.

Returns: Struct with the low and high limit.

See also: PxArticulationTendonLimit, setLimitParameters()

Implements physx::PxArticulationAttachment.

◆ getLink()

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

inlinevirtual

Gets the articulation link.

Returns: The articulation link that this attachment is attached to.

Implements physx::PxArticulationAttachment.

◆ getParent()

virtual PxArticulationAttachment * physx::NpArticulationAttachment::getParent ( ) const

inlinevirtual

Gets the parent attachment.

Returns: The parent attachment.

Implements physx::PxArticulationAttachment.

◆ getRelativeOffset()

PxVec3 NpArticulationAttachment::getRelativeOffset ( ) const

virtual

Gets the attachment's relative offset in the link actor frame.

Returns: The relative offset in the link actor frame.

See also: setRelativeOffset()

Implements physx::PxArticulationAttachment.

◆ getRestLength()

PxReal NpArticulationAttachment::getRestLength ( ) const

virtual

Gets the spring rest length for the sub-tendon from the root to this leaf attachment.

Returns: The rest length.

See also: setRestLength()

Implements physx::PxArticulationAttachment.

◆ getTendon()

PxArticulationSpatialTendon * NpArticulationAttachment::getTendon ( ) const

virtual

Gets the spatial tendon that the attachment is a part of.

Returns: The tendon.

See also: PxArticulationSpatialTendon

Implements physx::PxArticulationAttachment.

◆ isLeaf()

virtual bool physx::NpArticulationAttachment::isLeaf ( ) const

inlinevirtual

Indicates that this attachment is a leaf, and thus defines a sub-tendon from the root to this attachment.

Returns: True: This attachment is a leaf and has zero children; False: Not a leaf.

Implements physx::PxArticulationAttachment.

◆ release()

void NpArticulationAttachment::release ( )

virtual

Releases the attachment.

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

See also: PxArticulationSpatialTendon::createAttachment()

Implements physx::PxArticulationAttachment.

◆ setCoefficient()

void NpArticulationAttachment::setCoefficient ( const PxReal coefficient )

virtual

Sets the attachment coefficient.

Parameters

[in] coefficient The scale that the distance between this attachment and its parent is multiplied by when summing up the spatial tendon's length.

See also: getCoefficient()

Implements physx::PxArticulationAttachment.

◆ setLimitParameters()

void NpArticulationAttachment::setLimitParameters ( const PxArticulationTendonLimit & parameters )

virtual

Sets the low and high limit on the length of the sub-tendon from the root to this leaf attachment.

Setting this on non-leaf attachments has no effect.

Parameters

[in] parameters Struct with the low and high limit. Default: (PX_MAX_F32, -PX_MAX_F32) (i.e. an invalid configuration that can only work if stiffness is zero)