PhysX SDK 3.2 API Reference: Character

PhysX SDK 3.2 API

Character


Classes

class  PxBoxControllerDesc
 Descriptor for a box character controller. More...
class  PxBoxController
 Box character controller. More...
struct  PxCapsuleClimbingMode
class  PxCapsuleControllerDesc
 A descriptor for a capsule character controller. More...
class  PxCapsuleController
 A capsule character controller. More...
struct  PxControllerShapeType
 The type of controller, eg box, sphere or capsule. More...
struct  PxCCTInteractionMode
 specifies how a CCT interacts with other CCTs. More...
struct  PxCCTNonWalkableMode
 specifies how a CCT interacts with non-walkable parts. More...
struct  PxControllerFlag
 specifies which sides a character is colliding with. More...
struct  PxControllerState
 Describes a controller's internal state. More...
struct  PxControllerStats
 Describes a controller's internal statistics. More...
struct  PxCCTHit
 Describes a generic CCT hit. More...
struct  PxControllerShapeHit
 Describes a hit between a CCT and a shape. Passed to onShapeHit(). More...
struct  PxControllersHit
 Describes a hit between a CCT and another CCT. Passed to onControllerHit(). More...
struct  PxControllerObstacleHit
 Describes a hit between a CCT and a user-defined obstacle. Passed to onObstacleHit(). More...
class  PxUserControllerHitReport
 User callback class for character controller events. More...
class  PxControllerFilters
 Filtering data for "move" call. More...
class  PxControllerDesc
 Descriptor class for a character controller. More...
class  PxController
 Base class for character controllers. More...
struct  PxControllerBehaviorFlag
 specifies controller behavior More...
class  PxControllerBehaviorCallback
 User behavior callback. More...
struct  PxControllerDebugRenderFlags
 specifies debug-rendering flags More...
class  PxControllerManager
 Manages an array of character controllers. More...
class  PxObstacle
 Base class for obstacles. More...
class  PxBoxObstacle
 A box obstacle. More...
class  PxCapsuleObstacle
 A capsule obstacle. More...
class  PxObstacleContext
 Context class for obstacles. More...
struct  PxExtendedVec3

Defines

#define PX_PHYSX_CHARACTER_API
#define INVALID_OBSTACLE_HANDLE   0xffffffff
#define PX_BIG_WORLDS
#define PX_MAX_EXTENDED   PX_MAX_F64
#define PxExtendedAbs(x)   fabs(x)

Typedefs

typedef PxU32 ObstacleHandle
typedef double PxExtended

Functions

PX_C_EXPORT
PX_PHYSX_CHARACTER_API
physx::PxControllerManager
*PX_CALL_CONV 
PxCreateControllerManager (physx::PxFoundation &foundation)
PX_FORCE_INLINE PxVec3 toVec3 (const PxExtendedVec3 &v)
PX_INLINE PxBoxControllerDesc::PxBoxControllerDesc ()
 constructor sets to default.
virtual PX_INLINE PxBoxControllerDesc::~PxBoxControllerDesc ()
virtual PX_INLINE void PxBoxControllerDesc::setToDefault ()
 (re)sets the structure to the default.
virtual PX_INLINE bool PxBoxControllerDesc::isValid () const
 returns true if the current settings are valid
PX_INLINE PxCapsuleControllerDesc::PxCapsuleControllerDesc ()
 constructor sets to default.
virtual PX_INLINE PxCapsuleControllerDesc::~PxCapsuleControllerDesc ()
virtual PX_INLINE void PxCapsuleControllerDesc::setToDefault ()
 (re)sets the structure to the default.
virtual PX_INLINE bool PxCapsuleControllerDesc::isValid () const
 returns true if the current settings are valid
PX_INLINE PxControllerDesc::PxControllerDesc (PxControllerShapeType::Enum)
 constructor sets to default.
virtual PX_INLINE PxControllerDesc::~PxControllerDesc ()
virtual PX_INLINE bool PxControllerDesc::isValid () const
 returns true if the current settings are valid

Define Documentation

#define INVALID_OBSTACLE_HANDLE   0xffffffff

#define PX_BIG_WORLDS

#define PX_MAX_EXTENDED   PX_MAX_F64

#define PX_PHYSX_CHARACTER_API

#define PxExtendedAbs (  )     fabs(x)


Typedef Documentation

typedef double PxExtended


Function Documentation

PX_INLINE bool PxControllerDesc::isValid (  )  const [virtual, inherited]

PX_INLINE bool PxCapsuleControllerDesc::isValid (  )  const [virtual, inherited]

returns true if the current settings are valid

Returns:
True if the descriptor is valid.

Reimplemented from PxControllerDesc.

References PxCapsuleControllerDesc::height, PxControllerDesc::isValid(), PxCapsuleControllerDesc::radius, and PxControllerDesc::stepOffset.

PX_INLINE bool PxBoxControllerDesc::isValid (  )  const [virtual, inherited]

returns true if the current settings are valid

Returns:
True if the descriptor is valid.

Reimplemented from PxControllerDesc.

References PxBoxControllerDesc::halfForwardExtent, PxBoxControllerDesc::halfHeight, PxBoxControllerDesc::halfSideExtent, PxControllerDesc::isValid(), and PxControllerDesc::stepOffset.

PX_INLINE PxBoxControllerDesc::PxBoxControllerDesc (  )  [inherited]

constructor sets to default.

Referenced by PxBoxControllerDesc::setToDefault().

PX_INLINE PxCapsuleControllerDesc::PxCapsuleControllerDesc (  )  [inherited]

PX_C_EXPORT PX_PHYSX_CHARACTER_API physx::PxControllerManager* PX_CALL_CONV PxCreateControllerManager ( physx::PxFoundation &  foundation  ) 

PX_INLINE void PxCapsuleControllerDesc::setToDefault (  )  [virtual, inherited]

(re)sets the structure to the default.

References PxCapsuleControllerDesc::PxCapsuleControllerDesc().

PX_INLINE void PxBoxControllerDesc::setToDefault (  )  [virtual, inherited]

(re)sets the structure to the default.

References PxBoxControllerDesc::PxBoxControllerDesc().

PX_FORCE_INLINE PxVec3 toVec3 ( const PxExtendedVec3 v  ) 

PX_INLINE PxBoxControllerDesc::~PxBoxControllerDesc (  )  [virtual, inherited]

PX_INLINE PxCapsuleControllerDesc::~PxCapsuleControllerDesc (  )  [virtual, inherited]

PX_INLINE PxControllerDesc::~PxControllerDesc (  )  [protected, virtual, inherited]



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