A capsule character controller. More...

#include <PxCapsuleController.h>

Inheritance diagram for physx::PxCapsuleController:

Collaboration diagram for physx::PxCapsuleController:

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.

Public Member Functions inherited from physx::PxController
virtual PxControllerShapeType::Enum	getType () const =0
	Return the type of controller.

virtual void	release ()=0
	Releases the controller.

virtual PxControllerCollisionFlags	move (const PxVec3 &disp, PxF32 minDist, PxF32 elapsedTime, const PxControllerFilters &filters, const PxObstacleContext *obstacles=NULL)=0
	Moves the character using a "collide-and-slide" algorithm.

virtual bool	setPosition (const PxExtendedVec3 &position)=0
	Sets controller's position.

virtual const PxExtendedVec3 &	getPosition () const =0
	Retrieve the raw position of the controller.

virtual bool	setFootPosition (const PxExtendedVec3 &position)=0
	Set controller's foot position.

virtual PxExtendedVec3	getFootPosition () const =0
	Retrieve the "foot" position of the controller, i.e. the position of the bottom of the CCT's shape.

virtual PxRigidDynamic *	getActor () const =0
	Get the rigid body actor associated with this controller (see PhysX documentation). The behavior upon manually altering this actor is undefined, you should primarily use it for reading const properties.

virtual void	setStepOffset (const PxF32 offset)=0
	The step height.

virtual PxF32	getStepOffset () const =0
	Retrieve the step height.

virtual void	setNonWalkableMode (PxControllerNonWalkableMode::Enum flag)=0
	Sets the non-walkable mode for the CCT.

virtual PxControllerNonWalkableMode::Enum	getNonWalkableMode () const =0
	Retrieves the non-walkable mode for the CCT.

virtual PxF32	getContactOffset () const =0
	Retrieve the contact offset.

virtual void	setContactOffset (PxF32 offset)=0
	Sets the contact offset.

virtual PxVec3	getUpDirection () const =0
	Retrieve the 'up' direction.

virtual void	setUpDirection (const PxVec3 &up)=0
	Sets the 'up' direction.

virtual PxF32	getSlopeLimit () const =0
	Retrieve the slope limit.

virtual void	setSlopeLimit (PxF32 slopeLimit)=0
	Sets the slope limit.

virtual void	invalidateCache ()=0
	Flushes internal geometry cache.

virtual PxScene *	getScene ()=0
	Retrieve the scene associated with the controller.

virtual void *	getUserData () const =0
	Returns the user data associated with this controller.

virtual void	setUserData (void *userData)=0
	Sets the user data associated with this controller.

virtual void	getState (PxControllerState &state) const =0
	Returns information about the controller's internal state.

virtual void	getStats (PxControllerStats &stats) const =0
	Returns the controller's internal statistics.

virtual void	resize (PxReal height)=0
	Resizes the controller.

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

Member Function Documentation

◆ getClimbingMode()

virtual PxCapsuleClimbingMode::Enum physx::PxCapsuleController::getClimbingMode ( ) const

pure virtual

Gets controller's climbing mode.

Returns: The capsule controller's climbing mode.

See also: PxCapsuleControllerDesc.climbingMode setClimbingMode()

◆ getHeight()

virtual PxF32 physx::PxCapsuleController::getHeight ( ) const

pure virtual

Gets controller's height.

Returns: The height of the capsule controller.

See also: PxCapsuleControllerDesc.height setHeight()

◆ getRadius()

virtual PxF32 physx::PxCapsuleController::getRadius ( ) const

pure virtual

Gets controller's radius.

Returns: The radius of the controller.

See also: PxCapsuleControllerDesc.radius setRadius()

◆ setClimbingMode()

virtual bool physx::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()

◆ setHeight()

virtual bool physx::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()

◆ setRadius()

virtual bool physx::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:

RavEngine/deps/physx/physx/include/characterkinematic/PxCapsuleController.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ getClimbingMode()

◆ getHeight()

◆ getRadius()

◆ setClimbingMode()

◆ setHeight()

◆ setRadius()