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	PxControllerNonWalkableMode
	specifies how a CCT interacts with non-walkable parts. More...
struct	PxControllerCollisionFlag
	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	PxControllerHit
	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	PxControllerFilterCallback
	Dedicated filtering callback for CCT vs CCT. 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	PxControllerDebugRenderFlag
	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 PxFlags < PxControllerCollisionFlag::Enum, PxU8 >	PxControllerCollisionFlags
	Bitfield that contains a set of raised flags defined in PxControllerCollisionFlag.
typedef PxFlags < PxControllerBehaviorFlag::Enum, PxU8 >	PxControllerBehaviorFlags
	Bitfield that contains a set of raised flags defined in PxControllerBehaviorFlag.
typedef PxFlags < PxControllerDebugRenderFlag::Enum, PxU32 >	PxControllerDebugRenderFlags
	Bitfield that contains a set of raised flags defined in PxControllerDebugRenderFlag.
typedef PxU32	ObstacleHandle
typedef double	PxExtended
Functions
PX_C_EXPORT PX_PHYSX_CHARACTER_API physx::PxControllerManager *PX_CALL_CONV	PxCreateControllerManager (physx::PxScene &scene, bool lockingEnabled=false)
	Creates the controller manager.
PX_FORCE_INLINE PxVec3	toVec3 (const PxExtendedVec3 &v)
PX_INLINE	PxBoxControllerDesc::PxBoxControllerDesc ()
	constructor sets to default.
PX_INLINE	PxBoxControllerDesc::PxBoxControllerDesc (const PxBoxControllerDesc &)
	copy constructor.
PX_INLINE PxBoxControllerDesc &	PxBoxControllerDesc::operator= (const PxBoxControllerDesc &)
	assignment operator.
PX_INLINE void	PxBoxControllerDesc::copy (const 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.
PX_INLINE	PxCapsuleControllerDesc::PxCapsuleControllerDesc (const PxCapsuleControllerDesc &)
	copy constructor.
PX_INLINE PxCapsuleControllerDesc &	PxCapsuleControllerDesc::operator= (const PxCapsuleControllerDesc &)
	assignment operator.
PX_INLINE void	PxCapsuleControllerDesc::copy (const 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.
PX_INLINE	PxControllerDesc::PxControllerDesc (const PxControllerDesc &)
	copy constructor.
PX_INLINE PxControllerDesc &	PxControllerDesc::operator= (const PxControllerDesc &)
	assignment operator.
PX_INLINE void	PxControllerDesc::copy (const PxControllerDesc &)
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

Referenced by PxExtendedVec3::setMinusInfinity(), and PxExtendedVec3::setPlusInfinity().

#define PX_PHYSX_CHARACTER_API

#define PxExtendedAbs

(

x

)

fabs(x)

---

Typedef Documentation

typedef PxU32 ObstacleHandle

typedef PxFlags<PxControllerBehaviorFlag::Enum, PxU8> PxControllerBehaviorFlags

Bitfield that contains a set of raised flags defined in PxControllerBehaviorFlag.

See also:

PxControllerBehaviorFlag

typedef PxFlags<PxControllerCollisionFlag::Enum, PxU8> PxControllerCollisionFlags

Bitfield that contains a set of raised flags defined in PxControllerCollisionFlag.

See also:

PxControllerCollisionFlag

typedef PxFlags<PxControllerDebugRenderFlag::Enum, PxU32> PxControllerDebugRenderFlags

Bitfield that contains a set of raised flags defined in PxControllerDebugRenderFlag.

See also:

PxControllerDebugRenderFlag

typedef double PxExtended

---

Function Documentation

PX_INLINE void PxControllerDesc::copy

(

const PxControllerDesc &

other

)

[protected, inherited]

References PxControllerDesc::behaviorCallback, PxControllerDesc::contactOffset, PxControllerDesc::density, PxControllerDesc::invisibleWallHeight, PxControllerDesc::material, PxControllerDesc::maxJumpHeight, PxControllerDesc::nonWalkableMode, PxControllerDesc::position, PxControllerDesc::registerDeletionListener, PxControllerDesc::reportCallback, PxControllerDesc::scaleCoeff, PxControllerDesc::slopeLimit, PxControllerDesc::stepOffset, PxControllerDesc::upDirection, PxControllerDesc::userData, PxControllerDesc::volumeGrowth, PxExtendedVec3::x, PxExtendedVec3::y, and PxExtendedVec3::z.

Referenced by PxControllerDesc::operator=(), and PxControllerDesc::PxControllerDesc().

PX_INLINE void PxCapsuleControllerDesc::copy

(

const PxCapsuleControllerDesc &

other

)

[protected, inherited]

References PxCapsuleControllerDesc::climbingMode, PxCapsuleControllerDesc::height, and PxCapsuleControllerDesc::radius.

Referenced by PxCapsuleControllerDesc::operator=(), and PxCapsuleControllerDesc::PxCapsuleControllerDesc().

PX_INLINE void PxBoxControllerDesc::copy

(

const PxBoxControllerDesc &

other

)

[protected, inherited]

References PxBoxControllerDesc::halfForwardExtent, PxBoxControllerDesc::halfHeight, and PxBoxControllerDesc::halfSideExtent.

Referenced by PxBoxControllerDesc::operator=(), and PxBoxControllerDesc::PxBoxControllerDesc().

PX_INLINE bool PxControllerDesc::isValid

(

)

const [virtual, inherited]

returns true if the current settings are valid

Returns:

True if the descriptor is valid.

Reimplemented in PxBoxControllerDesc, and PxCapsuleControllerDesc.

References PxControllerDesc::contactOffset, PxControllerDesc::density, PxControllerShapeType::eBOX, PxControllerShapeType::eCAPSULE, PxControllerDesc::material, PxControllerDesc::mType, PxControllerDesc::scaleCoeff, PxControllerDesc::slopeLimit, PxControllerDesc::stepOffset, and PxControllerDesc::volumeGrowth.

Referenced by PxCapsuleControllerDesc::isValid(), and PxBoxControllerDesc::isValid().

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 PxControllerDesc & PxControllerDesc::operator=

(

const PxControllerDesc &

other

)

[protected, inherited]

assignment operator.

References PxControllerDesc::copy().

PX_INLINE PxCapsuleControllerDesc & PxCapsuleControllerDesc::operator=

(

const PxCapsuleControllerDesc &

other

)

[inherited]

assignment operator.

References PxCapsuleControllerDesc::copy().

PX_INLINE PxBoxControllerDesc & PxBoxControllerDesc::operator=

(

const PxBoxControllerDesc &

other

)

[inherited]

assignment operator.

References PxBoxControllerDesc::copy().

PX_INLINE PxBoxControllerDesc::PxBoxControllerDesc

(

const PxBoxControllerDesc &

other

)

[inherited]

copy constructor.

References PxBoxControllerDesc::copy().

PX_INLINE PxBoxControllerDesc::PxBoxControllerDesc

(

)

[inherited]

constructor sets to default.

Referenced by PxBoxControllerDesc::setToDefault().

PX_INLINE PxCapsuleControllerDesc::PxCapsuleControllerDesc

(

const PxCapsuleControllerDesc &

other

)

[inherited]

copy constructor.

References PxCapsuleControllerDesc::copy().

PX_INLINE PxCapsuleControllerDesc::PxCapsuleControllerDesc

(

)

[inherited]

constructor sets to default.

References PxCapsuleControllerDesc::climbingMode, PxCapsuleClimbingMode::eEASY, PxCapsuleControllerDesc::height, and PxCapsuleControllerDesc::radius.

Referenced by PxCapsuleControllerDesc::setToDefault().

PX_INLINE PxControllerDesc::PxControllerDesc

(

const PxControllerDesc &

other

)

[protected, inherited]

copy constructor.

References PxControllerDesc::copy().

PX_INLINE PxControllerDesc::PxControllerDesc

(

PxControllerShapeType::Enum

t

)

[protected, inherited]

constructor sets to default.

References PxControllerDesc::behaviorCallback, PxControllerDesc::contactOffset, PxControllerDesc::density, PxControllerNonWalkableMode::ePREVENT_CLIMBING, PxControllerDesc::invisibleWallHeight, PxControllerDesc::material, PxControllerDesc::maxJumpHeight, PxControllerDesc::nonWalkableMode, PxControllerDesc::position, PxControllerDesc::registerDeletionListener, PxControllerDesc::reportCallback, PxControllerDesc::scaleCoeff, PxControllerDesc::slopeLimit, PxControllerDesc::stepOffset, PxControllerDesc::upDirection, PxControllerDesc::userData, PxControllerDesc::volumeGrowth, PxExtendedVec3::x, PxExtendedVec3::y, and PxExtendedVec3::z.

PX_C_EXPORT PX_PHYSX_CHARACTER_API physx::PxControllerManager* PX_CALL_CONV PxCreateControllerManager	(	physx::PxScene &	scene,
		bool	lockingEnabled = false
	)

Creates the controller manager.

Parameters:

[in]	scene	PhysX scene.
[in]	lockingEnabled	Enables/disables internal locking.

The character controller is informed by PxDeletionListener::onRelease() when actors or shapes are released, and updates its internal caches accordingly. If character controller movement or a call to PxControllerManager::shiftOrigin() may overlap with actor/shape releases, internal data structures must be guarded against concurrent access.

Locking guarantees thread safety in such scenarios.

Note:

locking may result in significant slowdown for release of actors or shapes.

By default, locking is disabled.

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

)

References PxExtendedVec3::x, PxExtendedVec3::y, and PxExtendedVec3::z.

PX_INLINE PxControllerDesc::~PxControllerDesc

(

)

[protected, virtual, inherited]