Factory for the ScaleVelModifier. More...

#include <VelModifierScale.h>

Inheritance diagram for Menge::BFSM::ScaleVMFactory:

Public Member Functions
	ScaleVMFactory ()
	Constructor.

virtual const char *	name () const
	The name of the velocity modifier. More...

virtual const char *	description () const
	A description of the velocity modifier. More...

Public Member Functions inherited from Menge::ElementFactory< VelModifier >
	ElementFactory ()
	Default constructor.

void	destroy ()
	This supplants the destructor. More...

bool	thisFactory (const std::string &typeName) const
	Reports if the xml node defines an element for this factory. More...

VelModifier *	createInstance (TiXmlElement *node, const std::string &behaveFldr) const
	Parses the xml data. More...

Protected Member Functions
VelModifier *	instance () const
	Create an instance of this class's velocity modifier. More...

virtual bool	setFromXML (VelModifier vm, TiXmlElement node, const std::string &behaveFldr) const
	Given a pointer to an VelModifier instance, sets the appropriate fields from the provided XML node. More...

Protected Member Functions inherited from Menge::ElementFactory< VelModifier >
virtual	~ElementFactory ()
	Destructor.

virtual bool	setFromXML (VelModifier element, TiXmlElement node, const std::string &specFldr) const
	Given a pointer to an element instance, sets the appropriate fields from the provided XML node. More...

Protected Attributes
size_t	_scaleID
	The identifier for the "scale" float attribute.

Protected Attributes inherited from Menge::ElementFactory< VelModifier >
AttributeSet	_attrSet
	The attribute set for this factory.

Detailed Description

Factory for the ScaleVelModifier.

Member Function Documentation

virtual const char* Menge::BFSM::ScaleVMFactory::description ( ) const

inlinevirtual

A description of the velocity modifier.

Each velocity modifier factory must override this function.

Returns: A string containing the velocity modifier description.

Implements Menge::ElementFactory< VelModifier >.

VelModifier* Menge::BFSM::ScaleVMFactory::instance ( ) const

inlineprotectedvirtual

Create an instance of this class's velocity modifier.

All VelModFactory sub-classes must override this by creating (on the heap) a new instance of its corresponding velocity modifier type. The various field values of the instance will be set in a subsequent call to VelModpFactory::setFromXML. The caller of this function takes ownership of the memory.

Returns: A pointer to a newly instantiated VelModifier class.

Implements Menge::ElementFactory< VelModifier >.

virtual const char* Menge::BFSM::ScaleVMFactory::name ( ) const

inlinevirtual

The name of the velocity modifier.

The velocity modifiers's name must be unique among all registered velocity modifiers. Each velocity modifier factory must override this function.

Returns: A string containing the unique velocity modifier name.

Implements Menge::ElementFactory< VelModifier >.

bool Menge::BFSM::ScaleVMFactory::setFromXML	(	VelModifier *	vm,
		TiXmlElement *	node,
		const std::string &	behaveFldr
	)		const

protectedvirtual

Given a pointer to an VelModifier instance, sets the appropriate fields from the provided XML node.

It is assumed that the value of the type attribute is this VelModifier's type. (i.e. VelModFactory::thisFactory has already been called and returned true.) If sub-classes of VelModFactory introduce new VelComponent parameters, then the sub-class should override this method but explicitly call the parent class's version.

Parameters

vm	A pointer to the velocity modifier whose attributes are to be set.
node	The XML node containing the velocity modifier attributes.
behaveFldr	The path to the behavior file. If the velocity modifier references resources in the file system, it should be defined relative to the behavior file location. This is the folder containing that path.

Returns: A boolean reporting success (true) or failure (false).

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

src/menge/MengeCore/BFSM/VelocityModifiers/VelModifierScale.h
src/menge/MengeCore/BFSM/VelocityModifiers/VelModifierScale.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation