Public Member Functions | List of all members
PxObstacleContext Class Referenceabstract
Character

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::PxObstacleContext ( )
inline

◆ ~PxObstacleContext()

virtual PxObstacleContext::~PxObstacleContext ( )
inlinevirtual

Member Function Documentation

◆ addObstacle()

virtual ObstacleHandle PxObstacleContext::addObstacle ( const PxObstacle &  obstacle)
pure virtual

Adds an obstacle to the context.

Parameters
[in]obstacleObstacle data for the new obstacle. The data gets copied.
Returns
Handle for newly-added obstacle

◆ getControllerManager()

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

Retrieves the controller manager associated with this context.

Returns
The associated controller manager

◆ getNbObstacles()

virtual PxU32 PxObstacleContext::getNbObstacles ( ) const
pure virtual

Retrieves number of obstacles in the context.

Returns
Number of obstacles in the context

◆ getObstacle()

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

Retrieves desired obstacle.

Parameters
[in]iObstacle index
Returns
Desired obstacle

◆ getObstacleByHandle()

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

Retrieves desired obstacle by given handle.

Parameters
[in]handleObstacle handle
Returns
Desired obstacle

◆ release()

virtual void PxObstacleContext::release ( )
pure virtual

Releases the context.

◆ removeObstacle()

virtual bool PxObstacleContext::removeObstacle ( ObstacleHandle  handle)
pure virtual

Removes an obstacle from the context.

Parameters
[in]handleHandle for the obstacle object that needs to be removed.
Returns
True if success

◆ updateObstacle()

virtual bool PxObstacleContext::updateObstacle ( ObstacleHandle  handle,
const PxObstacle &  obstacle 
)
pure virtual

Updates data for an existing obstacle.

Parameters
[in]handleHandle for the obstacle object that needs to be updated.
[in]obstacleNew obstacle data
Returns
True if success
The documentation for this class was generated from the following file: