Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Menge::Agents::NavMeshSpatialQueryFactory Class Reference

Factory for the NavMeshSpatialQuery. More...

#include <SpatialQueryNavMesh.h>

Inheritance diagram for Menge::Agents::NavMeshSpatialQueryFactory:
Menge::Agents::SpatialQueryFactory Menge::ElementFactory< SpatialQuery >

Public Member Functions

 NavMeshSpatialQueryFactory ()
 Constructor.
 
virtual const char * name () const
 The name of the spatial query implemenation. More...
 
virtual const char * description () const
 A description of the spatial query. More...
 
- Public Member Functions inherited from Menge::Agents::SpatialQueryFactory
 SpatialQueryFactory ()
 Constructor.
 
- Public Member Functions inherited from Menge::ElementFactory< SpatialQuery >
 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...
 
SpatialQuery * createInstance (TiXmlElement *node, const std::string &behaveFldr) const
 Parses the xml data. More...
 

Protected Member Functions

SpatialQueryinstance () const
 Create an instance of this class's spatial query implementation. More...
 
virtual bool setFromXML (SpatialQuery *sq, TiXmlElement *node, const std::string &specFldr) const
 Given a pointer to an SpatialQuery instance, sets the appropriate fields from the provided XML node. More...
 
- Protected Member Functions inherited from Menge::ElementFactory< SpatialQuery >
virtual ~ElementFactory ()
 Destructor.
 
virtual bool setFromXML (SpatialQuery *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 _fileNameID
 The identifier for the "file_name" string attribute.
 
- Protected Attributes inherited from Menge::Agents::SpatialQueryFactory
size_t _testVisID
 The identifier for the "test_visibility" bool attribute.
 
- Protected Attributes inherited from Menge::ElementFactory< SpatialQuery >
AttributeSet _attrSet
 The attribute set for this factory.
 

Detailed Description

Factory for the NavMeshSpatialQuery.

Member Function Documentation

virtual const char* Menge::Agents::NavMeshSpatialQueryFactory::description ( ) const
inlinevirtual

A description of the spatial query.

Each spatial query factory must override this function.

Returns
A string containing the spatial query description.

Implements Menge::ElementFactory< SpatialQuery >.

SpatialQuery* Menge::Agents::NavMeshSpatialQueryFactory::instance ( ) const
inlineprotectedvirtual

Create an instance of this class's spatial query implementation.

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

Returns
A pointer to a newly instantiated SpatialQuery class.

Implements Menge::ElementFactory< SpatialQuery >.

virtual const char* Menge::Agents::NavMeshSpatialQueryFactory::name ( ) const
inlinevirtual

The name of the spatial query implemenation.

The spatial query's name must be unique among all registered spatial query components. Each spatial query factory must override this function.

Returns
A string containing the unique spatial query name.

Implements Menge::ElementFactory< SpatialQuery >.

bool Menge::Agents::NavMeshSpatialQueryFactory::setFromXML ( SpatialQuery sq,
TiXmlElement *  node,
const std::string &  specFldr 
) const
protectedvirtual

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

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

Parameters
sqA pointer to the spatial query whose attributes are to be set.
nodeThe XML node containing the elevation attributes.
specFldrThe path to the specification file. If the SpatialQuery references resources in the file system, it should be defined relative to the specification file location. This is the folder containing that path.
Returns
A boolean reporting success (true) or failure (false).

Reimplemented from Menge::Agents::SpatialQueryFactory.


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