Menge::BFSM::ConstVelComponent Class Reference

A velocity component that always returns a constant velocity. More...

#include <VelCompConst.h>

Inheritance diagram for Menge::BFSM::ConstVelComponent:

Public Member Functions
	ConstVelComponent ()
	Default constructor.
	ConstVelComponent (const Vector2 &vel)
	Constructor. More...
void	setVelocity (const Vector2 &velocity)
	Sets the constant velocity. More...
virtual void	setPrefVelocity (const Agents::BaseAgent *agent, const Goal *goal, Agents::PrefVelocity &pVel)
	Computes and sets the agent's preferred velocity. More...
Vector2	getConstVelocity () const
	Returns the constant velocity. More...
virtual VelCompContext *	getContext ()
	Provides a display context for interacting with this velocity component. More...
Public Member Functions inherited from Menge::BFSM::VelComponent
	VelComponent ()
	Default constructor.
virtual void	onEnter (Agents::BaseAgent *agent)
	Called when the agent enters the state which possesses this velocity component. More...
virtual void	onExit (Agents::BaseAgent *agent)
	Called when the agent leaves the state which possesses this velocity component. More...
Public Member Functions inherited from Menge::Element
void	destroy ()
	This supplants the destructor. More...
virtual BFSM::Task *	getTask ()
	Return an optional task associated with this element. More...
virtual SceneGraph::GLNode *	getSGNode ()
	Returns an optional visualization element associated with the element. More...

Protected Attributes
Vector2	_dir
	The direction of the constant preferred velocity.
float	_speed
	The speed of the constant preferred velocity.

Friends
class	ConstVCFactory

Additional Inherited Members
Protected Member Functions inherited from Menge::BFSM::VelComponent
virtual	~VelComponent ()
	Virtual destructor.

Detailed Description

A velocity component that always returns a constant velocity.

Constructor & Destructor Documentation

Menge::BFSM::ConstVelComponent::ConstVelComponent

(

const Vector2 &

vel

)

Constructor.

Parameters

vel	The preferred velocity to return.

Member Function Documentation

Vector2 Menge::BFSM::ConstVelComponent::getConstVelocity ( ) const

inline

Returns the constant velocity.

Returns

The velocity computed by this constant velocity component.

VelCompContext * Menge::BFSM::ConstVelComponent::getContext ( )

virtual

Provides a display context for interacting with this velocity component.

It is the responsibility of the caller to delete the provided context.

Returns

A pointer to a context for this vel component.

Reimplemented from Menge::BFSM::VelComponent.

void Menge::BFSM::ConstVelComponent::setPrefVelocity ( const Agents::BaseAgent *  agent, const Goal *  goal, Agents::PrefVelocity &  pVel  )

virtual

Computes and sets the agent's preferred velocity.

The velocity component directly sets preferred velocity values in the the provided preferred velocity instance. See Agents::PrefVelocity for details. Rather than setting the agent's preferred velocity value directly, a reference to a preferred velocity instance is passed in to make the use more general. This allows the computation of the preferred velocity for the agent, without necessarily making changes to it.

Parameters

agent	The agent for which a preferred velocity is computed.
goal	The agent's goal (although this may be ignored).
pVel	The instance of Agents::PrefVelocity to set.

Implements Menge::BFSM::VelComponent.

void Menge::BFSM::ConstVelComponent::setVelocity

(

const Vector2 &

velocity

)

Sets the constant velocity.

Parameters

velocity

The velocity for this velocity component.

---

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

• src/menge/MengeCore/BFSM/VelocityComponents/VelCompConst.h
• src/menge/MengeCore/BFSM/VelocityComponents/VelCompConst.cpp