Public Member Functions | Public Attributes | Protected Member Functions | List of all members
PxCapsuleControllerDesc Class Reference

A descriptor for a capsule character controller. More...

#include <PxCapsuleController.h>

Inheritance diagram for PxCapsuleControllerDesc:
Inheritance graph
[legend]
Collaboration diagram for PxCapsuleControllerDesc:
Collaboration graph
[legend]

Public Member Functions

PX_INLINE PxCapsuleControllerDesc ()
 constructor sets to default. More...
 
virtual PX_INLINE ~PxCapsuleControllerDesc ()
 
PX_INLINE PxCapsuleControllerDesc (const PxCapsuleControllerDesc &)
 copy constructor. More...
 
PX_INLINE PxCapsuleControllerDescoperator= (const PxCapsuleControllerDesc &)
 assignment operator. More...
 
virtual PX_INLINE void setToDefault ()
 (re)sets the structure to the default. More...
 
virtual PX_INLINE bool isValid () const
 returns true if the current settings are valid More...
 
- Public Member Functions inherited from PxControllerDesc
PX_INLINE
PxControllerShapeType::Enum 
getType () const
 Returns the character controller type. More...
 

Public Attributes

PxF32 radius
 The radius of the capsule. More...
 
PxF32 height
 The height of the controller. More...
 
PxCapsuleClimbingMode::Enum climbingMode
 The climbing mode. More...
 
- Public Attributes inherited from PxControllerDesc
PxExtendedVec3 position
 The position of the character. More...
 
PxVec3 upDirection
 Specifies the 'up' direction. More...
 
PxF32 slopeLimit
 The maximum slope which the character can walk up. More...
 
PxF32 invisibleWallHeight
 Height of invisible walls created around non-walkable triangles. More...
 
PxF32 maxJumpHeight
 Maximum height a jumping character can reach. More...
 
PxF32 contactOffset
 The contact offset used by the controller. More...
 
PxF32 stepOffset
 Defines the maximum height of an obstacle which the character can climb. More...
 
PxF32 density
 Density of underlying kinematic actor. More...
 
PxF32 scaleCoeff
 Scale coefficient for underlying kinematic actor. More...
 
PxF32 volumeGrowth
 Cached volume growth. More...
 
PxUserControllerHitReportreportCallback
 Specifies a user report callback. More...
 
PX_DEPRECATED
PxUserControllerHitReport
callback
 
PxControllerBehaviorCallbackbehaviorCallback
 Specifies a user behavior callback. More...
 
PxControllerNonWalkableMode::Enum nonWalkableMode
 The non-walkable mode controls if a character controller slides or not on a non-walkable part. More...
 
PxMaterialmaterial
 The material for the actor associated with the controller. More...
 
void * userData
 User specified data associated with the controller. More...
 

Protected Member Functions

PX_INLINE void copy (const PxCapsuleControllerDesc &)
 
- Protected Member Functions inherited from PxControllerDesc
PX_INLINE PxControllerDesc (PxControllerShapeType::Enum)
 constructor sets to default. More...
 
virtual PX_INLINE ~PxControllerDesc ()
 
PX_INLINE PxControllerDesc (const PxControllerDesc &)
 copy constructor. More...
 
PX_INLINE PxControllerDescoperator= (const PxControllerDesc &)
 assignment operator. More...
 
PX_INLINE void copy (const PxControllerDesc &)
 

Additional Inherited Members

- Protected Attributes inherited from PxControllerDesc
const PxControllerShapeType::Enum mType
 The type of the controller. This gets set by the derived class' ctor, the user should not have to change it. More...
 

Detailed Description

A descriptor for a capsule character controller.

See Also
PxCapsuleController PxControllerDesc

Constructor & Destructor Documentation

virtual PX_INLINE PxCapsuleControllerDesc::~PxCapsuleControllerDesc ( )
inlinevirtual

Member Data Documentation

PxCapsuleClimbingMode::Enum PxCapsuleControllerDesc::climbingMode

The climbing mode.

Default: PxCapsuleClimbingMode::eEASY

See Also
PxCapsuleController

Referenced by copy(), and PxCapsuleControllerDesc().

PxF32 PxCapsuleControllerDesc::height

The height of the controller.

Default: 0.0

See Also
PxCapsuleController

Referenced by copy(), isValid(), and PxCapsuleControllerDesc().

PxF32 PxCapsuleControllerDesc::radius

The radius of the capsule.

Default: 0.0

See Also
PxCapsuleController

Referenced by copy(), isValid(), and PxCapsuleControllerDesc().


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


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