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 Attributes | List of all members
Menge::BFSM::GoalCondition Class Reference

A spatial transition based on individual goal positions. More...

#include <CondGoal.h>

Inheritance diagram for Menge::BFSM::GoalCondition:
Menge::BFSM::Condition Menge::Element

Public Member Functions

 GoalCondition ()
 Constructor.
 
 GoalCondition (const GoalCondition &cond)
 Copy Constructor. More...
 
virtual bool conditionMet (Agents::BaseAgent *agent, const Goal *goal)
 The GoalCondition's condition is met when the agent is within a distance to the goal. More...
 
virtual Conditioncopy ()
 Create a copy of this condition. More...
 
void setMinDistance (float dist)
 Set the minimum distance of approach. More...
 
- Public Member Functions inherited from Menge::BFSM::Condition
 Condition ()
 Constructor.
 
 Condition (const Condition &cond)
 Copy Constructor. More...
 
virtual void onEnter (Agents::BaseAgent *agent)
 Called when an agent enters a state with this exiting transition. More...
 
virtual void onLeave (Agents::BaseAgent *agent)
 Called when an agent exits the state with this transition. 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 Attributes

float _distSq
 Minimum distance of approach (squared for efficiency).
 

Additional Inherited Members

- Protected Member Functions inherited from Menge::BFSM::Condition
virtual ~Condition ()
 Protected destructor.
 

Detailed Description

A spatial transition based on individual goal positions.

Constructor & Destructor Documentation

Menge::BFSM::GoalCondition::GoalCondition ( const GoalCondition cond)

Copy Constructor.

Parameters
condThe condition to copy from.

Member Function Documentation

bool Menge::BFSM::GoalCondition::conditionMet ( Agents::BaseAgent agent,
const Goal goal 
)
virtual

The GoalCondition's condition is met when the agent is within a distance to the goal.

Parameters
agentThe agent to test the transition for.
goalThe agent's goal (although this may be ignored).
Returns
True if the condition has been met, false otherwise.

Implements Menge::BFSM::Condition.

Condition * Menge::BFSM::GoalCondition::copy ( )
virtual

Create a copy of this condition.

It is the responsibility of the caller to delete the object.

Returns
: A "deep copy" of this condition - such that there is no shared objects between this and its copy.

Implements Menge::BFSM::Condition.

void Menge::BFSM::GoalCondition::setMinDistance ( float  dist)
inline

Set the minimum distance of approach.

Parameters
distThe minimum distance to the goal to consider the condition met.

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