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

Defintion of elevation class representing flat ground. More...

#include <ElevationFlat.h>

Inheritance diagram for Menge::Agents::FlatElevation:
Menge::Agents::Elevation Menge::Element

Public Member Functions

float getElevation (const Vector2 &point) const
 Reports the elevation of the simulation domain at the given point. The domain may have more than one valid elevation for the point. It is the responsibility of the elevation entity resolve this. More...
 
float getElevation (const BaseAgent *agent) const
 Reports the elevation of the simulation domain for the given agent. More...
 
virtual Vector2 getGradient (const Vector2 &point) const
 Reports the gradient of the simulation domain at the given point. The domain may have more than one valid gradient for the point. It is the responsibility of the elevation entity resolve this. More...
 
Vector2 getGradient (const BaseAgent *agent) const
 Reports the gradient of the simulation domain for the given agent. 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...
 

Additional Inherited Members

- Protected Member Functions inherited from Menge::Agents::Elevation
virtual ~Elevation ()
 Virtual destructor.
 

Detailed Description

Defintion of elevation class representing flat ground.

Member Function Documentation

float Menge::Agents::FlatElevation::getElevation ( const Vector2 point) const
virtual

Reports the elevation of the simulation domain at the given point. The domain may have more than one valid elevation for the point. It is the responsibility of the elevation entity resolve this.

Parameters
pointA point on the x-z cartesian plane.
Returns
The elevation at the given point.

Implements Menge::Agents::Elevation.

float Menge::Agents::FlatElevation::getElevation ( const BaseAgent agent) const
virtual

Reports the elevation of the simulation domain for the given agent.

Parameters
agentA pointer to the agent for which elevation should be reported.
Returns
The elevation (position on the y-axis) based on current agent state/position.

Implements Menge::Agents::Elevation.

Vector2 Menge::Agents::FlatElevation::getGradient ( const Vector2 point) const
virtual

Reports the gradient of the simulation domain at the given point. The domain may have more than one valid gradient for the point. It is the responsibility of the elevation entity resolve this.

Parameters
pointA point on the x-z cartesian plane.
Returns
The gradient at the given point.

Implements Menge::Agents::Elevation.

Vector2 Menge::Agents::FlatElevation::getGradient ( const BaseAgent agent) const
virtual

Reports the gradient of the simulation domain for the given agent.

Parameters
agentA pointer to the agent for which gradient should be reported.
Returns
The gradient of the domain based on current agent state/position.

Implements Menge::Agents::Elevation.


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