Context class for obstacles. More...

#include <PxControllerObstacles.h>

Public Member Functions
	PxObstacleContext ()

virtual	~PxObstacleContext ()

virtual void	release ()=0
	Releases the context. More...

virtual PxControllerManager &	getControllerManager () const =0
	Retrieves the controller manager associated with this context. More...

virtual ObstacleHandle	addObstacle (const PxObstacle &obstacle)=0
	Adds an obstacle to the context. More...

virtual bool	removeObstacle (ObstacleHandle handle)=0
	Removes an obstacle from the context. More...

virtual bool	updateObstacle (ObstacleHandle handle, const PxObstacle &obstacle)=0
	Updates data for an existing obstacle. More...

virtual PxU32	getNbObstacles () const =0
	Retrieves number of obstacles in the context. More...

virtual const PxObstacle *	getObstacle (PxU32 i) const =0
	Retrieves desired obstacle. More...

virtual const PxObstacle *	getObstacleByHandle (ObstacleHandle handle) const =0
	Retrieves desired obstacle by given handle. More...

Detailed Description

Context class for obstacles.

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

See Also: PxBoxObstacle PxCapsuleObstacle PxObstacle

Constructor & Destructor Documentation

PxObstacleContext::PxObstacleContext ( )

inline

virtual PxObstacleContext::~PxObstacleContext ( )

inlinevirtual

Member Function Documentation

virtual ObstacleHandle 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

virtual PxControllerManager& PxObstacleContext::getControllerManager ( ) const

pure virtual

Retrieves the controller manager associated with this context.

Returns: The associated controller manager

virtual PxU32 PxObstacleContext::getNbObstacles ( ) const

pure virtual

Retrieves number of obstacles in the context.

Returns: Number of obstacles in the context

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

pure virtual

Retrieves desired obstacle.

Parameters

[in] i Obstacle index

Returns: Desired obstacle

virtual const PxObstacle* PxObstacleContext::getObstacleByHandle ( ObstacleHandle handle ) const

pure virtual

Retrieves desired obstacle by given handle.

Parameters

[in] handle Obstacle handle

Returns: Desired obstacle

virtual void PxObstacleContext::release ( )

pure virtual

Releases the context.

virtual bool PxObstacleContext::removeObstacle ( ObstacleHandle 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

virtual bool PxObstacleContext::updateObstacle	(	ObstacleHandle	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:

PxControllerObstacles.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation