Aircraft::ClearAABBCondFactory Class Reference

The factory for creating the ClearAABBCondition. More...

#include <AircraftTransition.h>

Inheritance diagram for Aircraft::ClearAABBCondFactory:

Public Member Functions
const char *	name () const
	The name of the action. More...
const char *	description () const
	A description of the action. More...

Protected Member Functions
ClearAABBCondition *	instance () const
	Create an instance of this class's condition. More...
virtual bool	setFromXML (BFSM::Condition *condition, TiXmlElement *node, const std::string &behaveFldr) const
	Given a pointer to an Condition instance, sets the appropriate fields from the provided XML node. More...

Detailed Description

The factory for creating the ClearAABBCondition.

Member Function Documentation

const char* Aircraft::ClearAABBCondFactory::description ( ) const

inline

A description of the action.

Each action factory must override this function.

Returns

A string containing the action description.

ClearAABBCondition* Aircraft::ClearAABBCondFactory::instance ( ) const

inlineprotected

Create an instance of this class's condition.

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

Returns

A pointer to a newly instantiated Action class.

const char* Aircraft::ClearAABBCondFactory::name ( ) const

inline

The name of the action.

The action's name must be unique among all registered actions. Each action factory must override this function.

Returns

A string containing the unique action name.

bool Aircraft::ClearAABBCondFactory::setFromXML ( BFSM::Condition *  condition, TiXmlElement *  node, const std::string &  behaveFldr  ) const

protectedvirtual

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

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

Parameters

condition	A pointer to the condition whose attributes are to be set.
node	The XML node containing the condition attributes.
behaveFldr	The path to the behavior file. If the condition 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/Plugins/aircraft/AircraftTransition.h
• src/Plugins/aircraft/AircraftTransition.cpp