VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Public Attributes | Protected Types | Protected Attributes
makVrv::DtElementData Class Reference

The element data is all the information about all elements in the scene. More...

List of all members.

Public Types

typedef std::vector< DtUniqueID > SceneObjectIdList
typedef boost::unordered_map
< DtElementID, DtElementEntry * > 
ElementEntryMap
 Map of unique id's to DtSimEntry's.
typedef boost::unordered_map
< DtElementID,
SceneObjectIdList > 
ElementToSceneObjectMap
typedef std::vector
< DtElementEntry * > 
ElementList
 Type for signals.
typedef std::vector< DtElementID > UniqueIdList
 Type for signals.
typedef std::vector
< DtElementAttribute * > 
AttributeList
 Type for signals.
typedef std::pair
< DtElementEntry
*, AttributeList > 
EntryAttributes
 Type for signals.
typedef std::vector
< EntryAttributes > 
EntryAttributesList
 Type for signals.

Public Member Functions

 DtElementData (DtDe &de)
 CTOR.
 ~DtElementData ()
 DTOR.
void applyChanges (const DtElementChanges &changes)
 Apply changes via an element changes object.
void requestAttributeChange (const DtElementEntry &entry, DtElementAttribute *atr)
 Request an attribute change.
const ElementEntryMap & elements () const
 Get the element map.
const ElementToSceneObjectMap & elementToSceneObjectMap () const
 Get the element to scene object map.
DtElementEntry * findElement (DtElementID id)
 Find an element.
void findAll (DtElementEntry::ElementType type, ElementList &outVector, bool sort=true)
 Find all elements of a given type, and return in a array (which by default is sorted according to their ID)
void findAll (const std::vector< DtElementEntry::ElementType > &types, ElementList &outVector, bool sort=true)
 Find all elements of a for several types, and return in a array (which by default is sorted according to their ID)
void findAll (ElementList &outVector, bool sort=true)
 Find all elements and return in a array (which by default is sorted according to their ID)
virtual void addElementID (const DtElementID &elementID, const DtUniqueID &sceneObjectID, int modelSet)
 Tell the mapper about an element ID / scene object ID pairing, as well as the model set the scene object is from.
virtual void addElementID (const DtElementID &elementID, const DtUniqueID &sceneObjectID)
 Tell the mapper about an element ID / scene object ID pairing for an element that is not part of a model set (such as a prop)
virtual void removeElementID (const DtElementID &elementID, const DtUniqueID &sceneObjectID, int modelSet)
 remove and element ID / scene object ID pairing
virtual void removeElementID (const DtElementID &elementID, const DtUniqueID &sceneObjectID)
virtual void getSceneObjectIds (const DtElementID &elementID, SceneObjectIdList &outputList, int modelSet=-1) const
 Get the scene object ID from the specified modelset that is associated with an element ID (or all scene object IDs associated with that element ID)
virtual DtElementID elementId (const DtUniqueID &sceneObjectID) const
 Get the element ID associated with a scene object ID.

Public Attributes

boost::signal< void(const
ElementList &) > 
signal_elementsAdded
 Signal elements added.
boost::signal< void(const
UniqueIdList &) > 
signal_elementsToBeRemoved
 Signal elements to be removed.
boost::signal< void(const
EntryAttributesList &) > 
signal_attributesChanged
 Signal Attribute changed.

Protected Types

typedef boost::unordered_map
< int, ElementToSceneObjectMap > 
ModelSetToElementSceneObjectMap
typedef boost::unordered_map
< DtUniqueID, DtElementID > 
SceneObjectToElementMap

Protected Attributes

DtDe & myDe
ElementEntryMap myElements
ElementToSceneObjectMap myElementToSceneObjectMap
ModelSetToElementSceneObjectMap myModelSetToElementSceneObjectMap
SceneObjectToElementMap mySceneObjectToElementMap

Detailed Description

The element data is all the information about all elements in the scene.


Member Typedef Documentation

Map of unique id's to DtSimEntry's.

Type for signals.

Type for signals.

Type for signals.

Type for signals.

Type for signals.

typedef boost::unordered_map<DtUniqueID, DtElementID> makVrv::DtElementData::SceneObjectToElementMap [protected]

Constructor & Destructor Documentation

CTOR.

DTOR.


Member Function Documentation

Apply changes via an element changes object.

Request an attribute change.

Get the element map.

Get the element to scene object map.

Find an element.

void makVrv::DtElementData::findAll ( DtElementEntry::ElementType  type,
ElementList &  outVector,
bool  sort = true 
)

Find all elements of a given type, and return in a array (which by default is sorted according to their ID)

void makVrv::DtElementData::findAll ( const std::vector< DtElementEntry::ElementType > &  types,
ElementList &  outVector,
bool  sort = true 
)

Find all elements of a for several types, and return in a array (which by default is sorted according to their ID)

void makVrv::DtElementData::findAll ( ElementList &  outVector,
bool  sort = true 
)

Find all elements and return in a array (which by default is sorted according to their ID)

virtual void makVrv::DtElementData::addElementID ( const DtElementID &  elementID,
const DtUniqueID &  sceneObjectID,
int  modelSet 
) [virtual]

Tell the mapper about an element ID / scene object ID pairing, as well as the model set the scene object is from.

virtual void makVrv::DtElementData::addElementID ( const DtElementID &  elementID,
const DtUniqueID &  sceneObjectID 
) [virtual]

Tell the mapper about an element ID / scene object ID pairing for an element that is not part of a model set (such as a prop)

virtual void makVrv::DtElementData::removeElementID ( const DtElementID &  elementID,
const DtUniqueID &  sceneObjectID,
int  modelSet 
) [virtual]

remove and element ID / scene object ID pairing

virtual void makVrv::DtElementData::removeElementID ( const DtElementID &  elementID,
const DtUniqueID &  sceneObjectID 
) [virtual]
virtual void makVrv::DtElementData::getSceneObjectIds ( const DtElementID &  elementID,
SceneObjectIdList &  outputList,
int  modelSet = -1 
) const [virtual]

Get the scene object ID from the specified modelset that is associated with an element ID (or all scene object IDs associated with that element ID)

virtual DtElementID makVrv::DtElementData::elementId ( const DtUniqueID &  sceneObjectID) const [virtual]

Get the element ID associated with a scene object ID.


Member Data Documentation

Signal elements added.

Signal elements to be removed.

Signal Attribute changed.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)