physx::PxBoxController Class Reference

Box character controller. More...

#include <PxBoxController.h>

Inheritance diagram for physx::PxBoxController:

Collaboration diagram for physx::PxBoxController:

Public Member Functions
virtual PxF32	getHalfHeight () const =0
	Gets controller's half height.
virtual PxF32	getHalfSideExtent () const =0
	Gets controller's half side extent.
virtual PxF32	getHalfForwardExtent () const =0
	Gets controller's half forward extent.
virtual bool	setHalfHeight (PxF32 halfHeight)=0
	Sets controller's half height.
virtual bool	setHalfSideExtent (PxF32 halfSideExtent)=0
	Sets controller's half side extent.
virtual bool	setHalfForwardExtent (PxF32 halfForwardExtent)=0
	Sets controller's half forward extent.
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

Box character controller.

See also

PxBoxControllerDesc PxController

Member Function Documentation

getHalfForwardExtent()

virtual PxF32 physx::PxBoxController::getHalfForwardExtent ( ) const

pure virtual

Gets controller's half forward extent.

Returns

The half forward extent of the controller.

See also

PxBoxControllerDesc.halfForwardExtent setHalfForwardExtent()

getHalfHeight()

virtual PxF32 physx::PxBoxController::getHalfHeight ( ) const

pure virtual

Gets controller's half height.

Returns

The half height of the controller.

See also

PxBoxControllerDesc.halfHeight setHalfHeight()

getHalfSideExtent()

virtual PxF32 physx::PxBoxController::getHalfSideExtent ( ) const

pure virtual

Gets controller's half side extent.

Returns

The half side extent of the controller.

See also

PxBoxControllerDesc.halfSideExtent setHalfSideExtent()

setHalfForwardExtent()

virtual bool physx::PxBoxController::setHalfForwardExtent ( PxF32  halfForwardExtent )

pure virtual

Sets controller's half forward extent.

Warning

this doesn't check for collisions.

Parameters

[in]

halfForwardExtent

The new half forward extent for the controller.

Returns

Currently always true.

See also

PxBoxControllerDesc.halfForwardExtent getHalfForwardExtent()

setHalfHeight()

virtual bool physx::PxBoxController::setHalfHeight ( PxF32  halfHeight )

pure virtual

Sets controller's half height.

Warning

this doesn't check for collisions.

Parameters

[in]

halfHeight

The new half height for the controller.

Returns

Currently always true.

See also

PxBoxControllerDesc.halfHeight getHalfHeight()

setHalfSideExtent()

virtual bool physx::PxBoxController::setHalfSideExtent ( PxF32  halfSideExtent )

pure virtual

Sets controller's half side extent.

Warning

this doesn't check for collisions.

Parameters

[in]

halfSideExtent

The new half side extent for the controller.

Returns

Currently always true.

See also

PxBoxControllerDesc.halfSideExtent getHalfSideExtent()

---

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

• RavEngine/deps/physx/physx/include/characterkinematic/PxBoxController.h