Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Menge::Agents::ObstacleSet Class Referenceabstract

The base class for obstacle set definitions. More...

#include <ObstacleSet.h>

Inheritance diagram for Menge::Agents::ObstacleSet:
Menge::Element Menge::Agents::ListObstacleSet Menge::Agents::ExplicitObstacleSet Menge::Agents::NavMeshObstacleSet

Public Member Functions

 ObstacleSet ()
 Default constructor.
 
virtual size_t obstacleCount ()=0
 Reports the number of obstacles in the set. More...
 
virtual ObstaclegetObstacle (size_t i)=0
 Returns the ith obstacle. More...
 
virtual void setClass (size_t cl)
 Sets the class of this obstacle set. More...
 
virtual size_t getClass ()
 Gets the class of this obstacle set. More...
 
- Public Member Functions inherited from Menge::Element
void destroy ()
 This supplants the destructor. More...
 
virtual BFSM::TaskgetTask ()
 Return an optional task associated with this element. More...
 
virtual SceneGraph::GLNodegetSGNode ()
 Returns an optional visualization element associated with the element. More...
 

Protected Member Functions

virtual ~ObstacleSet ()
 Protected destructor. The destroy method should be used to delete an instance of an obstacle set.
 

Protected Attributes

size_t _class
 The class for the obstacles in this set. More...
 

Friends

class ObstacleSetFactory
 

Detailed Description

The base class for obstacle set definitions.

This is an abstract class defining the functions of an obstacle set in Menge Obstacle sets must be able to provide a count of Obstacles in their definition and pass those obstacles on to the SpatialQuery

Member Function Documentation

virtual size_t Menge::Agents::ObstacleSet::getClass ( )
inlinevirtual

Gets the class of this obstacle set.

Returns
The class id to which the obstacle set belongs.
virtual Obstacle* Menge::Agents::ObstacleSet::getObstacle ( size_t  i)
pure virtual

Returns the ith obstacle.

Parameters
iThe index of the requested obstacle.
Returns
A pointer to the corresponding Obstacle instance.
Exceptions
ObstacleSetExceptionif the index, i, is invalid.

Implemented in Menge::Agents::ListObstacleSet.

virtual size_t Menge::Agents::ObstacleSet::obstacleCount ( )
pure virtual

Reports the number of obstacles in the set.

Returns
The number of obstacles in this set.

Implemented in Menge::Agents::ListObstacleSet.

virtual void Menge::Agents::ObstacleSet::setClass ( size_t  cl)
inlinevirtual

Sets the class of this obstacle set.

Parameters
clthe class id to which the obstacle set belongs.

Member Data Documentation

size_t Menge::Agents::ObstacleSet::_class
protected

The class for the obstacles in this set.

This works with the BaseAgent::_obstacleSet member to determine which obstacles affect an agent.


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