NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxArticulationLink Class Reference

NVIDIA PhysX SDK 3.4 API

PxArticulationLink Class Reference
[Physics]

a component of an articulation that represents a rigid body More...

#include <PxArticulationLink.h>

Inheritance diagram for PxArticulationLink:
Collaboration diagram for PxArticulationLink:

List of all members.


Public Member Functions

virtual void release ()=0
 Deletes the articulation link.
virtual PxArticulationgetArticulation () const =0
 get the articulation to which this articulation link belongs
virtual PxArticulationJointgetInboundJoint () const =0
 Get the joint which connects this link to its parent.
virtual PxU32 getNbChildren () const =0
 Get number of child links.
virtual PxU32 getChildren (PxArticulationLink **userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const =0
 Retrieve all the child links.
virtual const char * getConcreteTypeName () const
 Returns string name of dynamic type.

Protected Member Functions

PX_INLINE PxArticulationLink (PxType concreteType, PxBaseFlags baseFlags)
PX_INLINE PxArticulationLink (PxBaseFlags baseFlags)
virtual ~PxArticulationLink ()
virtual bool isKindOf (const char *name) const
 Returns whether a given type name matches with the type of this instance.

Detailed Description

a component of an articulation that represents a rigid body

A limited subset of the properties of PxRigidDynamic are supported. In particular, sleep properties are attributes of the articulation rather than each individual body, damping and velocity limits are not supported, and links may not be kinematic.

See also:
PxArticulation PxArticulation.createLink PxArticulationJoint PxRigidBody

Constructor & Destructor Documentation

PX_INLINE PxArticulationLink::PxArticulationLink ( PxType  concreteType,
PxBaseFlags  baseFlags 
) [inline, protected]

PX_INLINE PxArticulationLink::PxArticulationLink ( PxBaseFlags  baseFlags  )  [inline, protected]

virtual PxArticulationLink::~PxArticulationLink (  )  [inline, protected, virtual]


Member Function Documentation

virtual PxArticulation& PxArticulationLink::getArticulation (  )  const [pure virtual]

get the articulation to which this articulation link belongs

Returns:
the articulation to which this link belongs

virtual PxU32 PxArticulationLink::getChildren ( PxArticulationLink **  userBuffer,
PxU32  bufferSize,
PxU32  startIndex = 0 
) const [pure virtual]

Retrieve all the child links.

Parameters:
[out] userBuffer The buffer to receive articulation link pointers.
[in] bufferSize Size of provided user buffer.
Returns:
Number of articulation links written to the buffer.
Parameters:
[in] startIndex Index of first child pointer to be retrieved
See also:
getNbChildren()

virtual const char* PxArticulationLink::getConcreteTypeName (  )  const [inline, virtual]

Returns string name of dynamic type.

Returns:
Class name of most derived type of this object.

Implements PxBase.

virtual PxArticulationJoint* PxArticulationLink::getInboundJoint (  )  const [pure virtual]

Get the joint which connects this link to its parent.

Returns:
The joint connecting the link to the parent. NULL for the root link.
See also:
PxArticulationJoint

virtual PxU32 PxArticulationLink::getNbChildren (  )  const [pure virtual]

Get number of child links.

Returns:
the number of child links
See also:
getChildren()

virtual bool PxArticulationLink::isKindOf ( const char *  superClass  )  const [inline, protected, virtual]

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

Reimplemented from PxRigidBody.

References PxRigidBody::isKindOf().

virtual void PxArticulationLink::release (  )  [pure virtual]

Deletes the articulation link.

Note:
Only a leaf articulation link can be released
Do not keep a reference to the deleted instance.

See also:
PxArticulation::createLink()

Implements PxRigidActor.


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



Copyright © 2008-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com