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

NVIDIA PhysX SDK 3.4 API

PxCapsuleController Class Reference
[Character]

A capsule character controller. More...

#include <PxCapsuleController.h>

Inheritance diagram for PxCapsuleController:
Collaboration diagram for PxCapsuleController:

List of all members.


Public Member Functions

virtual PxF32 getRadius () const =0
 Gets controller's radius.
virtual bool setRadius (PxF32 radius)=0
 Sets controller's radius.
virtual PxF32 getHeight () const =0
 Gets controller's height.
virtual bool setHeight (PxF32 height)=0
 Resets controller's height.
virtual PxCapsuleClimbingMode::Enum getClimbingMode () const =0
 Gets controller's climbing mode.
virtual bool setClimbingMode (PxCapsuleClimbingMode::Enum mode)=0
 Sets controller's climbing mode.

Protected Member Functions

PX_INLINE PxCapsuleController ()
virtual ~PxCapsuleController ()

Detailed Description

A capsule character controller.

The capsule is defined as a position, a vertical height, and a radius. The height is the distance between the two sphere centers at the end of the capsule. In other words:

p = pos (returned by controller)
h = height
r = radius

p = center of capsule
top sphere center = p.y + h*0.5
bottom sphere center = p.y - h*0.5
top capsule point = p.y + h*0.5 + r
bottom capsule point = p.y - h*0.5 - r


Constructor & Destructor Documentation

PX_INLINE PxCapsuleController::PxCapsuleController (  )  [inline, protected]

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


Member Function Documentation

virtual PxCapsuleClimbingMode::Enum PxCapsuleController::getClimbingMode (  )  const [pure virtual]

Gets controller's climbing mode.

Returns:
The capsule controller's climbing mode.
See also:
PxCapsuleControllerDesc.climbingMode setClimbingMode()

virtual PxF32 PxCapsuleController::getHeight (  )  const [pure virtual]

Gets controller's height.

Returns:
The height of the capsule controller.
See also:
PxCapsuleControllerDesc.height setHeight()

virtual PxF32 PxCapsuleController::getRadius (  )  const [pure virtual]

Gets controller's radius.

Returns:
The radius of the controller.
See also:
PxCapsuleControllerDesc.radius setRadius()

virtual bool PxCapsuleController::setClimbingMode ( PxCapsuleClimbingMode::Enum  mode  )  [pure virtual]

Sets controller's climbing mode.

Parameters:
[in] mode The capsule controller's climbing mode.
See also:
PxCapsuleControllerDesc.climbingMode getClimbingMode()

virtual bool PxCapsuleController::setHeight ( PxF32  height  )  [pure virtual]

Resets controller's height.

Warning:
this doesn't check for collisions.
Parameters:
[in] height The new height for the controller.
Returns:
Currently always true.
See also:
PxCapsuleControllerDesc.height getHeight()

virtual bool PxCapsuleController::setRadius ( PxF32  radius  )  [pure virtual]

Sets controller's radius.

Warning:
this doesn't check for collisions.
Parameters:
[in] radius The new radius for the controller.
Returns:
Currently always true.
See also:
PxCapsuleControllerDesc.radius getRadius()


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