 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
The DtEntityDataInterface class is a wrapper around state views to give access to convenience methods which will allow developers to more easily access data about those objects. More...
Public Member Functions | |
| DtEntityDataInterface (makVrv::DtDe &) | |
| virtual | ~DtEntityDataInterface () |
| virtual void | setStateView (const makVrv::DtStateView< makVrv::DtSimState > *) |
| Called to set the state view this data will wrap. | |
| virtual makVrv::DtElementEntry::ElementType | type () const |
| Returns the type of this object. Used for dynamic casting to proper sub-class. | |
| virtual DtVector | location (Representation rep=Local) const |
| Returns the location of the entity. | |
| virtual std::string | label () const |
| Returns the label of the object. | |
| virtual DtTaitBryan | orientation (Representation rep=Local) const |
| Returns the orientation of the object. | |
| virtual DtVector | velocity (Representation rep=Local) const |
| Returns the objects velocity. | |
| virtual DtVector | acceleration (Representation rep=Local) const |
| Returns the objects acceleration. | |
| virtual double | heading () const |
| Returns the objects topographic heading (in degrees) | |
| virtual makVrv::DtElementID | embarkedOn () const |
| Returns the element this object is embarked on. An element ID of 0 means the item is not embarked. | |
| virtual std::vector < makVrv::DtElementID > | objectsEmbarked () const |
| Returns a list of all elements that are embarked on this object. | |
| virtual makVrv::DtElementID | superior () const |
| Returns the ID of the superior of this object. If the ID is 0 the object superior is the force level object. | |
| makVrv::DtStateView < makVrv::DtVrlinkSimulatedEntityState > * | entityStateView () const |
| Returns the state view of this class. | |
| makVrv::DtStateView < DtIffStateData > * | iffStateDataView () const |
| Returns the state view for any iff data that might be associated with this class. | |
Protected Member Functions | |
| virtual void | slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &) |
| Slot that is called when the state view is destroyed. Will mark this item as removed by clearing out internal pointers. | |
Protected Attributes | |
| makVrv::DtStateView < makVrv::DtVrlinkSimulatedEntityState > * | myEntityStateView |
| makVrv::DtStateView < DtIffStateData > * | myIffStateDataView |
The DtEntityDataInterface class is a wrapper around state views to give access to convenience methods which will allow developers to more easily access data about those objects.
It will also provide some basic manipulation for that object
| virtual makVrf::DtEntityDataInterface::~DtEntityDataInterface | ( | ) | [virtual] |
| virtual void makVrf::DtEntityDataInterface::setStateView | ( | const makVrv::DtStateView< makVrv::DtSimState > * | ) | [virtual] |
Called to set the state view this data will wrap.
Subclasses are responsible for providing interface to access the specific data, however, you can access the data through the state() members of the contained state views. Overridden to cast to appropriate type
Reimplemented from makVrf::DtVrfVrlinkDataInterface.
Reimplemented in makVrf::DtAggregateDataInterface.
| virtual makVrv::DtElementEntry::ElementType makVrf::DtEntityDataInterface::type | ( | ) | const [virtual] |
Returns the type of this object. Used for dynamic casting to proper sub-class.
Reimplemented from makVrf::DtObjectDataInterface.
Reimplemented in makVrf::DtAggregateDataInterface.
| virtual DtVector makVrf::DtEntityDataInterface::location | ( | Representation | rep = Local | ) | const [virtual] |
Returns the location of the entity.
| virtual std::string makVrf::DtEntityDataInterface::label | ( | ) | const [virtual] |
Returns the label of the object.
| virtual DtTaitBryan makVrf::DtEntityDataInterface::orientation | ( | Representation | rep = Local | ) | const [virtual] |
Returns the orientation of the object.
| virtual DtVector makVrf::DtEntityDataInterface::velocity | ( | Representation | rep = Local | ) | const [virtual] |
Returns the objects velocity.
| virtual DtVector makVrf::DtEntityDataInterface::acceleration | ( | Representation | rep = Local | ) | const [virtual] |
Returns the objects acceleration.
| virtual double makVrf::DtEntityDataInterface::heading | ( | ) | const [virtual] |
Returns the objects topographic heading (in degrees)
| virtual makVrv::DtElementID makVrf::DtEntityDataInterface::embarkedOn | ( | ) | const [virtual] |
Returns the element this object is embarked on. An element ID of 0 means the item is not embarked.
| virtual std::vector<makVrv::DtElementID> makVrf::DtEntityDataInterface::objectsEmbarked | ( | ) | const [virtual] |
Returns a list of all elements that are embarked on this object.
| virtual makVrv::DtElementID makVrf::DtEntityDataInterface::superior | ( | ) | const [virtual] |
Returns the ID of the superior of this object. If the ID is 0 the object superior is the force level object.
| makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>* makVrf::DtEntityDataInterface::entityStateView | ( | ) | const [inline] |
Returns the state view of this class.
| makVrv::DtStateView<DtIffStateData>* makVrf::DtEntityDataInterface::iffStateDataView | ( | ) | const [inline] |
Returns the state view for any iff data that might be associated with this class.
A NULL return means this entity does not have IFF data
| virtual void makVrf::DtEntityDataInterface::slot_simObjectEntryAboutToBeRemoved | ( | makVrv::DtSimObjectEntry & | ) | [protected, virtual] |
Slot that is called when the state view is destroyed. Will mark this item as removed by clearing out internal pointers.
Reimplemented from makVrf::DtVrfVrlinkDataInterface.
Reimplemented in makVrf::DtAggregateDataInterface.
makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>* makVrf::DtEntityDataInterface::myEntityStateView [protected] |