A velocity modifier that scales the input velocity's speed. More...

Inheritance diagram for Menge::BFSM::ScaleVelModifier:

Public Member Functions
	ScaleVelModifier ()
	Default constructor.

	ScaleVelModifier (const float scale)
	Constructor. More...

void	setScale (const float scale)
	Sets the scale factor. More...

void	adaptPrefVelocity (const Agents::BaseAgent *agent, Agents::PrefVelocity &pVel)
	Scales the input preferred velocity's speed by the pre-defined scale factor. More...

float	getScale () const
	Returns scale factor. More...

VelModifier *	copy () const
	Creates a copy of this velocity modifier. More...

virtual VelModContext *	getContext ()
	Provides a display context for interacting with this velocity modifier. More...

Public Member Functions inherited from Menge::BFSM::VelModifier
	VelModifier ()
	Default constructor.

virtual void	registerAgent (const Agents::BaseAgent *agent)
	Registers an agent for use with the VelModifier. More...

virtual void	unregisterAgent (const Agents::BaseAgent *agent)
	Unregisters a registed agent. More...

void	onEnter (const Agents::BaseAgent *agent)
	Called when an agent enters the state with this velocity modifier. More...

void	onLeave (const Agents::BaseAgent *agent)
	Called when an agent exits the state with this velocity modifier. 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...

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

Detailed Description

A velocity modifier that scales the input velocity's speed.

Constructor & Destructor Documentation

Menge::BFSM::ScaleVelModifier::ScaleVelModifier ( const float scale )

Constructor.

Parameters

scale The scale factor to apply to the preferred velocity's speed.

void Menge::BFSM::ScaleVelModifier::adaptPrefVelocity	(	const Agents::BaseAgent *	agent,
		Agents::PrefVelocity &	pVel
	)

virtual

Scales the input preferred velocity's speed by the pre-defined scale factor.

Parameters

agent	The agent for which a preferred velocity is modified.
pVel	The instance of Agents::PrefVelocity to set.

VelModifier * Menge::BFSM::ScaleVelModifier::copy ( ) const

virtual

Creates a copy of this velocity modifier.

VelModContext * Menge::BFSM::ScaleVelModifier::getContext ( )

virtual

Provides a display context for interacting with this velocity modifier.

float Menge::BFSM::ScaleVelModifier::getScale ( ) const

inline

Returns scale factor.

void Menge::BFSM::ScaleVelModifier::setScale ( const float scale )

Sets the scale factor.

Parameters

scale The the scale factor to apply to the preferred velocity's speed.

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