Menge Plugin Examples
A Collection of Example Plugins for the Menge Framework
|
Factory for the HeightFieldModifier. More...
#include <VelModHeightField.h>
Public Member Functions | |
HeightFieldModifierFactory () | |
Constructor. | |
virtual const char * | name () const |
The name of the modifier. More... | |
virtual const char * | description () const |
A description of the modifier. More... | |
Protected Member Functions | |
BFSM::VelModifier * | instance () const |
Create an instance of this class's modifier. More... | |
virtual bool | setFromXML (BFSM::VelModifier *modifier, TiXmlElement *node, const std::string &behaveFldr) const |
Given a pointer to an modifier instance, sets the appropriate fields from the provided XML node. More... | |
Protected Attributes | |
size_t | _fileNameID |
The identifier for the "file_name" string attribute. | |
size_t | _turnID |
The identifier for the "dir_weight" float attribute. | |
size_t | _uphillID |
The identifier for the "up_hill_scale" float attribute. | |
size_t | _downhillID |
The identifier for the "down_hill_scale" float attribute. | |
Factory for the HeightFieldModifier.
|
inlinevirtual |
A description of the modifier.
Each modifier factory must override this function.
|
inlineprotected |
Create an instance of this class's modifier.
All modifierFactory sub-classes must override this by creating (on the heap) a new instance of its corresponding modifier type. The various field values of the instance will be set in a subsequent call to modifierFactory::setFromXML. The caller of this function takes ownership of the memory.
|
inlinevirtual |
The name of the modifier.
The modifier's name must be unique among all registered modifier. Each modifier factory must override this function.
|
protectedvirtual |
Given a pointer to an modifier instance, sets the appropriate fields from the provided XML node.
It is assumed that the value of the type
attribute is this modifier's type. (i.e. modifierFactory::thisFactory has already been called and returned true.) If sub-classes of modifierFactory introduce new modifier parameters, then the sub-class should override this method but explicitly call the parent class's version.
modifier | A pointer to the modifier whose attributes are to be set. |
node | The XML node containing the modifier attributes. |
behaveFldr | The path to the behavior file. If the modifier references resources in the file system, it should be defined relative to the behavior file location. This is the folder containing that path. |