 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
The back end data that will be used to construct a symbol. More...
Signals | |
| void | modelDataDestroyed (const QString &) |
| Emitted from the destructor. | |
Public Member Functions | |
| DtModelData () | |
| DtModelData (const DtModelData &orig) | |
| virtual | ~DtModelData () |
| DtModelData & | operator= (const DtModelData &rhs) |
| virtual const DtModelKey & | key () const |
| Key is a unique identifier for the symbol. | |
| virtual void | setKey (const DtModelKey &k) |
| virtual const DtModelKey & | modelKey () const |
| Model Key is the key that can translate this model data into a symbol through the symbol mapper,aka entity type. | |
| virtual void | setModelKey (const DtModelKey &k) |
| virtual void | setAllPoints (const QVector< DtPoint > *pts) |
| virtual const QVector< DtPoint > * | getAllPoints () const |
| virtual void | setPoint (int iIndex, const DtPoint &pnt) |
| Set a point at the particular index (if it is not out of range) | |
| virtual void | insertPoint (int iIndex, const DtPoint &pnt) |
| Inserts a point at the particular index (if it is not out of range) | |
| virtual void | removePoint (int iIndex) |
| Removes the point at the particular index. | |
| virtual void | setName (const QString &name) |
| The name of this symbol, usually the marking text. | |
| virtual const QString & | getName () const |
| virtual void | setLabel (const QString &name) |
| The label of this symbol. | |
| virtual const QString & | getLabel () const |
| virtual void | setForceId (int id) |
| Set what force this symbol belongs to, if appropriate. | |
| virtual int | getForceId () const |
| virtual void | updateFromModel () |
| Re-implement in derived classes that interact with your model. | |
| virtual bool | forceUpdate () const |
| Return true if this model data should always be updated regardless of cache state change. | |
| virtual void | setForceUpdate (bool b) |
| virtual int | rawAppearance () const |
| Appearance. Zero by default. | |
| virtual DtModelDataType | type () const |
| \ brief Returns the type of this model data | |
| virtual QString | typeStr () |
| Returns the string type of this model data. | |
| virtual DtEntityMapperKey | entityMapperKey () const |
| Returns an entity mapper key that identifies this type of object. | |
| virtual void | setIsPublished (bool b) |
| Set to true if this item is published on the network. | |
| virtual bool | isPublished () const |
| virtual void | setCanPublish (bool b) |
| Set to true if this item is can be published on the network. | |
| virtual bool | canPublish () const |
| virtual void | setDeleteFromLayer (bool b) |
| Return true if this object can be deleted from an overlay layer. | |
| virtual bool | deleteFromLayer () const |
| virtual void | setMustBeOnLayer (bool b) |
| Set to true if this item must be on a layer. By default returns false. | |
| virtual bool | mustBeOnLayer () const |
| virtual bool | isInExtent (const DtExtent &) const |
| Returns true if the model data can be drawn within the give extent. | |
| virtual const QStringList & | parents () const |
| The ability to add multiple parent's exists, however the system will only currently support the first parent in the list. | |
| virtual void | setParents (const QStringList &parent) |
| virtual void | addParent (const QString &parent) |
| virtual void | removeParent (const QString &parent) |
| virtual void | changeParentName (const QString &oldName, const QString &newName) |
| virtual bool | canEdit () const |
| Return true/false if this item can be edited. By default is true. | |
| virtual void | setCanEdit (bool) |
| void | setChangedFlags (int) |
| int | changedFlags () const |
| virtual void | setOriginPoint (double x=0, double y=0, double z=0) |
| The first point in the point list is defined as the origin. | |
| virtual void | setOriginPoint (const DtPoint &pnt) |
| The first point in the point list is defined as the origin. | |
| virtual const DtPoint * | getOriginPoint () const |
| The first point in the point list is defined as the origin. | |
Protected Member Functions | |
| virtual bool | isInExtent (const DtExtent &, const QVector< DtPoint > *) const |
| virtual bool | isInExtent (const DtExtent &, const QVector< DtVector > *) const |
| virtual void | read (QTextStream &s) |
| Read/write points. | |
| virtual void | write (QTextStream &s) |
Protected Attributes | |
| QStringList | myParents |
| bool | myCanEdit |
| QVector< DtPoint > * | myPoints |
| QString | myName |
| QString | myLabel |
| QString | myTypeString |
| DtModelKey | myKey |
| DtModelKey | myModelKey |
| int | myForceId |
| int | myChangedFlags |
| bool | myForceUpdate |
| bool | myIsPublished |
| bool | myCanPublish |
| bool | myMustBeOnLayer |
| bool | myDeleteFromLayer |
The back end data that will be used to construct a symbol.
This information should be filled by your own backend in order to properly tie it in with the drawing front end. Override the following if you have more necessary data
| DtModelData::DtModelData | ( | const DtModelData & | orig | ) |
| virtual DtModelData::~DtModelData | ( | ) | [virtual] |
| DtModelData& DtModelData::operator= | ( | const DtModelData & | rhs | ) |
| virtual const DtModelKey& DtModelData::key | ( | ) | const [virtual] |
Key is a unique identifier for the symbol.
| virtual void DtModelData::setKey | ( | const DtModelKey & | k | ) | [virtual] |
| virtual const DtModelKey& DtModelData::modelKey | ( | ) | const [virtual] |
Model Key is the key that can translate this model data into a symbol through the symbol mapper,aka entity type.
| virtual void DtModelData::setModelKey | ( | const DtModelKey & | k | ) | [virtual] |
| virtual void DtModelData::setOriginPoint | ( | double | x = 0, |
| double | y = 0, |
||
| double | z = 0 |
||
| ) | [virtual] |
The first point in the point list is defined as the origin.
| virtual void DtModelData::setOriginPoint | ( | const DtPoint & | pnt | ) | [virtual] |
The first point in the point list is defined as the origin.
| virtual const DtPoint* DtModelData::getOriginPoint | ( | ) | const [virtual] |
The first point in the point list is defined as the origin.
Reimplemented in DtFormationModelData.
| virtual void DtModelData::setAllPoints | ( | const QVector< DtPoint > * | pts | ) | [virtual] |
| virtual const QVector<DtPoint>* DtModelData::getAllPoints | ( | ) | const [virtual] |
Reimplemented in DtTerrainModelData.
| virtual void DtModelData::setPoint | ( | int | iIndex, |
| const DtPoint & | pnt | ||
| ) | [virtual] |
Set a point at the particular index (if it is not out of range)
| virtual void DtModelData::insertPoint | ( | int | iIndex, |
| const DtPoint & | pnt | ||
| ) | [virtual] |
Inserts a point at the particular index (if it is not out of range)
| virtual void DtModelData::removePoint | ( | int | iIndex | ) | [virtual] |
Removes the point at the particular index.
| virtual void DtModelData::setName | ( | const QString & | name | ) | [virtual] |
The name of this symbol, usually the marking text.
| virtual const QString& DtModelData::getName | ( | ) | const [virtual] |
| virtual void DtModelData::setLabel | ( | const QString & | name | ) | [virtual] |
The label of this symbol.
| virtual const QString& DtModelData::getLabel | ( | ) | const [virtual] |
| virtual void DtModelData::setForceId | ( | int | id | ) | [virtual] |
Set what force this symbol belongs to, if appropriate.
standard convention has 1 for friendly, 2 for hostile, 3 for neutral, and 0 for unknown.
| virtual int DtModelData::getForceId | ( | ) | const [virtual] |
| virtual void DtModelData::updateFromModel | ( | ) | [virtual] |
Re-implement in derived classes that interact with your model.
| virtual bool DtModelData::forceUpdate | ( | ) | const [virtual] |
Return true if this model data should always be updated regardless of cache state change.
By default returns false
| virtual void DtModelData::setForceUpdate | ( | bool | b | ) | [virtual] |
| virtual int DtModelData::rawAppearance | ( | ) | const [virtual] |
Appearance. Zero by default.
Reimplemented in DtEnvironmentalModelData.
| virtual DtModelDataType DtModelData::type | ( | ) | const [virtual] |
\ brief Returns the type of this model data
Reimplemented in DtTerrainModelData, DtEnvironmentalModelData, DtFormationModelData, and DtCompassModelData.
| virtual QString DtModelData::typeStr | ( | ) | [virtual] |
Returns the string type of this model data.
| virtual DtEntityMapperKey DtModelData::entityMapperKey | ( | ) | const [virtual] |
Returns an entity mapper key that identifies this type of object.
If modelKey is not empty, returns that
Reimplemented in DtFormationModelData.
| virtual void DtModelData::setIsPublished | ( | bool | b | ) | [virtual] |
Set to true if this item is published on the network.
| virtual bool DtModelData::isPublished | ( | ) | const [virtual] |
| virtual void DtModelData::setCanPublish | ( | bool | b | ) | [virtual] |
Set to true if this item is can be published on the network.
| virtual bool DtModelData::canPublish | ( | ) | const [virtual] |
| virtual void DtModelData::setDeleteFromLayer | ( | bool | b | ) | [virtual] |
Return true if this object can be deleted from an overlay layer.
Default is true
| virtual bool DtModelData::deleteFromLayer | ( | ) | const [virtual] |
| virtual void DtModelData::setMustBeOnLayer | ( | bool | b | ) | [virtual] |
Set to true if this item must be on a layer. By default returns false.
| virtual bool DtModelData::mustBeOnLayer | ( | ) | const [virtual] |
| virtual bool DtModelData::isInExtent | ( | const DtExtent & | ) | const [virtual] |
Returns true if the model data can be drawn within the give extent.
| virtual const QStringList& DtModelData::parents | ( | ) | const [virtual] |
The ability to add multiple parent's exists, however the system will only currently support the first parent in the list.
| virtual void DtModelData::setParents | ( | const QStringList & | parent | ) | [virtual] |
| virtual void DtModelData::addParent | ( | const QString & | parent | ) | [virtual] |
| virtual void DtModelData::removeParent | ( | const QString & | parent | ) | [virtual] |
| virtual void DtModelData::changeParentName | ( | const QString & | oldName, |
| const QString & | newName | ||
| ) | [virtual] |
| virtual bool DtModelData::canEdit | ( | ) | const [virtual] |
Return true/false if this item can be edited. By default is true.
| virtual void DtModelData::setCanEdit | ( | bool | ) | [virtual] |
| void DtModelData::setChangedFlags | ( | int | i | ) | [inline] |
References myChangedFlags.
| int DtModelData::changedFlags | ( | ) | const [inline] |
References myChangedFlags.
| void DtModelData::modelDataDestroyed | ( | const QString & | ) | [signal] |
Emitted from the destructor.
| virtual bool DtModelData::isInExtent | ( | const DtExtent & | , |
| const QVector< DtPoint > * | |||
| ) | const [protected, virtual] |
| virtual bool DtModelData::isInExtent | ( | const DtExtent & | , |
| const QVector< DtVector > * | |||
| ) | const [protected, virtual] |
| virtual void DtModelData::read | ( | QTextStream & | s | ) | [protected, virtual] |
Read/write points.
Reimplemented from DtArchivableObject.
| virtual void DtModelData::write | ( | QTextStream & | s | ) | [protected, virtual] |
Reimplemented from DtArchivableObject.
QStringList DtModelData::myParents [protected] |
bool DtModelData::myCanEdit [protected] |
QVector<DtPoint>* DtModelData::myPoints [mutable, protected] |
QString DtModelData::myName [protected] |
QString DtModelData::myLabel [protected] |
QString DtModelData::myTypeString [protected] |
DtModelKey DtModelData::myKey [protected] |
DtModelKey DtModelData::myModelKey [protected] |
int DtModelData::myForceId [protected] |
int DtModelData::myChangedFlags [protected] |
Referenced by changedFlags(), and setChangedFlags().
bool DtModelData::myForceUpdate [protected] |
bool DtModelData::myIsPublished [protected] |
bool DtModelData::myCanPublish [protected] |
bool DtModelData::myMustBeOnLayer [protected] |
bool DtModelData::myDeleteFromLayer [protected] |