physx::PxObstacleContext Class Reference

Context class for obstacles. More...

#include <PxControllerObstacles.h>

Public Member Functions
virtual void	release ()=0
	Releases the context.
virtual PxControllerManager &	getControllerManager () const =0
	Retrieves the controller manager associated with this context.
virtual PxObstacleHandle	addObstacle (const PxObstacle &obstacle)=0
	Adds an obstacle to the context.
virtual bool	removeObstacle (PxObstacleHandle handle)=0
	Removes an obstacle from the context.
virtual bool	updateObstacle (PxObstacleHandle handle, const PxObstacle &obstacle)=0
	Updates data for an existing obstacle.
virtual PxU32	getNbObstacles () const =0
	Retrieves number of obstacles in the context.
virtual const PxObstacle *	getObstacle (PxU32 i) const =0
	Retrieves desired obstacle.
virtual const PxObstacle *	getObstacleByHandle (PxObstacleHandle handle) const =0
	Retrieves desired obstacle by given handle.

Detailed Description

Context class for obstacles.

An obstacle context class contains and manages a set of user-defined obstacles.

See also

PxBoxObstacle PxCapsuleObstacle PxObstacle

Member Function Documentation

addObstacle()

virtual PxObstacleHandle physx::PxObstacleContext::addObstacle ( const PxObstacle &  obstacle )

pure virtual

Adds an obstacle to the context.

Parameters

[in]

obstacle

Obstacle data for the new obstacle. The data gets copied.

Returns

Handle for newly-added obstacle

getControllerManager()

virtual PxControllerManager & physx::PxObstacleContext::getControllerManager ( ) const

pure virtual

Retrieves the controller manager associated with this context.

Returns

The associated controller manager

getNbObstacles()

virtual PxU32 physx::PxObstacleContext::getNbObstacles ( ) const

pure virtual

Retrieves number of obstacles in the context.

Returns

Number of obstacles in the context

getObstacle()

virtual const PxObstacle * physx::PxObstacleContext::getObstacle ( PxU32  i ) const

pure virtual

Retrieves desired obstacle.

Parameters

[in]

i

Obstacle index

Returns

Desired obstacle

getObstacleByHandle()

virtual const PxObstacle * physx::PxObstacleContext::getObstacleByHandle ( PxObstacleHandle  handle ) const

pure virtual

Retrieves desired obstacle by given handle.

Parameters

[in]

handle

Obstacle handle

Returns

Desired obstacle

removeObstacle()

virtual bool physx::PxObstacleContext::removeObstacle ( PxObstacleHandle  handle )

pure virtual

Removes an obstacle from the context.

Parameters

[in]

handle

Handle for the obstacle object that needs to be removed.

Returns

True if success

updateObstacle()

virtual bool physx::PxObstacleContext::updateObstacle ( PxObstacleHandle  handle, const PxObstacle &  obstacle  )

pure virtual

Updates data for an existing obstacle.

Parameters

[in]	handle	Handle for the obstacle object that needs to be updated.
[in]	obstacle	New obstacle data

Returns

True if success

---

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

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