VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtFormationModelData Class Reference
Inheritance diagram for DtFormationModelData:
Inheritance graph
[legend]

Public Member Functions

 DtFormationModelData (DtVrfSubObjectParameterEntry *, DtVrfSubObjectParameterList *)
virtual DtModelDataType type () const
 \ brief Returns the type of this model data
const
DtVrfSubObjectParameterEntry
entry () const
const DtVrfSubObjectParameterListsubordinateObjects () const
void setFormationEntry (DtFormationEntry *entry)
DtFormationEntryformationEntry () const
void setBoundingVolume (const Dt3dBoundingVolume *bv)
const Dt3dBoundingVolume * boundingVolume () const
void setFormationData (DtFormationEntry *e, DtFormation *f)
const DtFormationformation () const
DtFormationformation ()
void setParent (DtFormationModelData *d)
const DtFormationModelDataparent () const
DtFormationModelDataparent ()
void setRootNode (bool b)
bool rootNode () const
void setExpanded (bool b)
bool expanded () const
void addChild (DtFormationModelData *c)
const QVector
< DtFormationModelData * > & 
children () const
QVector< DtFormationModelData * > & children ()
virtual DtExtent extent (const DtPoint &origin=DtPoint(0, 0, 0)) const
 Returns the entire extent of this aggregate.
virtual const DtPointgetOriginPoint () const
 The first point in the point list is defined as the origin.
virtual DtExtent boundingBox () const
virtual DtPoint positionOffset () const
virtual DtPoint centerOfMass () const
 Given the number of children, return the center of mass as applied to the current formation.
DtPoint offset () const
virtual bool setNewOffsetFromLeader (const DtPoint &newPoint)
 Given the particular body coordinate, set this offset (relative to 0, 0, 0) to the entity this object is after in the promotion hierarchy.
virtual QList
< DtFormationModelData * > 
dataAtLeaderPromotionId (int) const
 Returns a list of the model data where the leader id is the same as the passed in it.
virtual DtFormationModelDatadataAtPromotionId (int) const
void removeChild (DtFormationModelData *child)
void setParameters (DtVrfObjectParameters *p)
DtVrfObjectParametersparameters () const
virtual void repositionInFormation (int iFrom, int iTo)
virtual void repositionInFormation (DtFormation *, int iFrom, int iTo)
virtual void addChildAtPosition (DtFormationModelData *fmd, int iPos)
 Creates a new entry if need be and then repositions all the objects.
virtual void clearUnusedNodes ()
 Clears out nodes at the end of the formation that are not used.
virtual int depth () const
virtual int maxPromotionId () const
virtual void reworkOffsetsToStandAlone (DtFormation *formation)
 Reworks all entries to not reference a leader.
virtual void reworkAsOffsetToLeader (DtFormation *formation)
 Reworks as offset from leader in formation.
void setEntityMapperKey (const DtEntityMapperKey &k)
virtual DtEntityMapperKey entityMapperKey () const
 Returns an entity mapper key that identifies this type of object.
- Public Member Functions inherited from DtModelData
 DtModelData ()
 DtModelData (const DtModelData &orig)
virtual ~DtModelData ()
DtModelDataoperator= (const DtModelData &rhs)
virtual const DtModelKeykey () const
 Key is a unique identifier for the symbol.
virtual void setKey (const DtModelKey &k)
virtual const DtModelKeymodelKey () 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 QString typeStr ()
 Returns the string type of this model data.
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.
- Public Member Functions inherited from DtArchivableObject
 DtArchivableObject (QString name, DtArchivableObjectCreator fcn)
 This constructor will add this object to the archivable object factory.
 DtArchivableObject (QString name)
 DtArchivableObject ()
virtual ~DtArchivableObject ()
virtual QString name () const
DtArchiverarchiver ()
 Returns the archiver of this object.
virtual void setLevel (int i)
virtual int level () const
virtual DtArchivableObjectclone ()
 Allows for cloning of this object.

Protected Member Functions

virtual DtPoint calculateOffset (const DtFormationEntry *entry, const DtFormation *formation) const
- Protected Member Functions inherited from DtModelData
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

DtVrfSubObjectParameterListmySubordinateObjects
DtVrfSubObjectParameterEntrymyEntry
bool myRootNode
bool myExpanded
DtFormationEntrymyFormationEntry
const Dt3dBoundingVolume * myBoundingVolume
DtFormationmyFormation
DtFormationModelDatamyParent
QVector< DtFormationModelData * > myChildren
DtVrfObjectParametersmyParameters
DtEntityMapperKey myEntityMapperKey
- Protected Attributes inherited from DtModelData
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
- Protected Attributes inherited from DtArchivableObject
DtArchivermyArchiver

Additional Inherited Members

- Signals inherited from DtModelData
void modelDataDestroyed (const QString &)
 Emitted from the destructor.

Constructor & Destructor Documentation

DtFormationModelData::DtFormationModelData ( DtVrfSubObjectParameterEntry ,
DtVrfSubObjectParameterList  
)

Member Function Documentation

virtual DtModelDataType DtFormationModelData::type ( ) const
virtual

\ brief Returns the type of this model data

Reimplemented from DtModelData.

const DtVrfSubObjectParameterEntry* DtFormationModelData::entry ( ) const
inline
const DtVrfSubObjectParameterList* DtFormationModelData::subordinateObjects ( ) const
inline
void DtFormationModelData::setFormationEntry ( DtFormationEntry entry)
inline
DtFormationEntry* DtFormationModelData::formationEntry ( ) const
inline
void DtFormationModelData::setBoundingVolume ( const Dt3dBoundingVolume *  bv)
inline
const Dt3dBoundingVolume* DtFormationModelData::boundingVolume ( ) const
inline
void DtFormationModelData::setFormationData ( DtFormationEntry e,
DtFormation f 
)
inline
const DtFormation* DtFormationModelData::formation ( ) const
inline
DtFormation* DtFormationModelData::formation ( )
inline
void DtFormationModelData::setParent ( DtFormationModelData d)
inline

Referenced by addChild().

const DtFormationModelData* DtFormationModelData::parent ( ) const
inline
DtFormationModelData* DtFormationModelData::parent ( )
inline
void DtFormationModelData::setRootNode ( bool  b)
inline
bool DtFormationModelData::rootNode ( ) const
inline
void DtFormationModelData::setExpanded ( bool  b)
inline

References myExpanded.

bool DtFormationModelData::expanded ( ) const
inline

References myExpanded.

void DtFormationModelData::addChild ( DtFormationModelData c)
inline

References setParent().

const QVector<DtFormationModelData*>& DtFormationModelData::children ( ) const
inline
QVector<DtFormationModelData*>& DtFormationModelData::children ( )
inline
virtual DtExtent DtFormationModelData::extent ( const DtPoint origin = DtPoint(0, 0, 0)) const
virtual

Returns the entire extent of this aggregate.

virtual const DtPoint* DtFormationModelData::getOriginPoint ( ) const
virtual

The first point in the point list is defined as the origin.

Reimplemented from DtModelData.

virtual DtExtent DtFormationModelData::boundingBox ( ) const
virtual
virtual DtPoint DtFormationModelData::positionOffset ( ) const
virtual
virtual DtPoint DtFormationModelData::centerOfMass ( ) const
virtual

Given the number of children, return the center of mass as applied to the current formation.

If there are no children, returns 0, 0, 0

DtPoint DtFormationModelData::offset ( ) const
inline
virtual bool DtFormationModelData::setNewOffsetFromLeader ( const DtPoint newPoint)
virtual

Given the particular body coordinate, set this offset (relative to 0, 0, 0) to the entity this object is after in the promotion hierarchy.

virtual QList<DtFormationModelData*> DtFormationModelData::dataAtLeaderPromotionId ( int  ) const
virtual

Returns a list of the model data where the leader id is the same as the passed in it.

virtual DtFormationModelData* DtFormationModelData::dataAtPromotionId ( int  ) const
virtual
void DtFormationModelData::removeChild ( DtFormationModelData child)
inline
void DtFormationModelData::setParameters ( DtVrfObjectParameters p)
inline
DtVrfObjectParameters* DtFormationModelData::parameters ( ) const
inline
virtual void DtFormationModelData::repositionInFormation ( int  iFrom,
int  iTo 
)
virtual
virtual void DtFormationModelData::repositionInFormation ( DtFormation ,
int  iFrom,
int  iTo 
)
virtual
virtual void DtFormationModelData::addChildAtPosition ( DtFormationModelData fmd,
int  iPos 
)
virtual

Creates a new entry if need be and then repositions all the objects.

virtual void DtFormationModelData::clearUnusedNodes ( )
virtual

Clears out nodes at the end of the formation that are not used.

virtual int DtFormationModelData::depth ( ) const
virtual
virtual int DtFormationModelData::maxPromotionId ( ) const
virtual
virtual void DtFormationModelData::reworkOffsetsToStandAlone ( DtFormation formation)
virtual

Reworks all entries to not reference a leader.

virtual void DtFormationModelData::reworkAsOffsetToLeader ( DtFormation formation)
virtual

Reworks as offset from leader in formation.

void DtFormationModelData::setEntityMapperKey ( const DtEntityMapperKey k)
inline
virtual DtEntityMapperKey DtFormationModelData::entityMapperKey ( ) const
inlinevirtual

Returns an entity mapper key that identifies this type of object.

If modelKey is not empty, returns that

Reimplemented from DtModelData.

virtual DtPoint DtFormationModelData::calculateOffset ( const DtFormationEntry entry,
const DtFormation formation 
) const
protectedvirtual

Member Data Documentation

DtVrfSubObjectParameterList* DtFormationModelData::mySubordinateObjects
protected
DtVrfSubObjectParameterEntry* DtFormationModelData::myEntry
protected
bool DtFormationModelData::myRootNode
protected
bool DtFormationModelData::myExpanded
protected
DtFormationEntry* DtFormationModelData::myFormationEntry
protected
const Dt3dBoundingVolume* DtFormationModelData::myBoundingVolume
protected
DtFormation* DtFormationModelData::myFormation
protected
DtFormationModelData* DtFormationModelData::myParent
protected
QVector<DtFormationModelData*> DtFormationModelData::myChildren
protected
DtVrfObjectParameters* DtFormationModelData::myParameters
protected
DtEntityMapperKey DtFormationModelData::myEntityMapperKey
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)