VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes
DtEnvironmentalModelData Class Reference

Represents an environmental process. Used for creating overlay symbols. More...

Inheritance diagram for DtEnvironmentalModelData:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtEnvironmentalModelData ()
 DtEnvironmentalModelData (const DtEnvironmentalModelData &orig)
virtual ~DtEnvironmentalModelData ()
DtEnvironmentalModelDataoperator= (const DtEnvironmentalModelData &rhs)
virtual DtModelDataType type () const
 \ brief Returns the type of this model data
virtual bool hasColor () const
virtual void setColor (QColor color)
virtual QColor color (bool applyAlpha=false) const
virtual void setRawAppearance (int app)
 Bypasses bit masking for line width and appearance and just sets the appearance field.
virtual int rawAppearance () const
 Appearance. Zero by default.
virtual void setAppearance (int app)
 Because the high 4 bits are used for line width, the only supported bits for appearance are the lower 28 bits.
virtual int appearance () const
virtual void setLineWidth (int width)
 Note that the color shares the myAppearance variable, using the high 4 bits.
virtual int lineWidth () const
virtual void setFillStyle (int style)
 Note that this shares the myAppearance variable, using the 12-15 bits.
virtual int fillStyle () const
virtual void setLineStyle (int style)
 Note that this shares the myAppearance variable, using the 8-11 bits line style is defined as Qt::PenStyle plus 1 with 0 being undefined.
virtual int lineStyle () const
virtual void setUserData (DtArchivableObject *obj)
 Allow for setting and retrieving of user data, which can be anything.
virtual DtArchivableObjectuserData ()
virtual void setTransparencyLevel (int i)
 Allow for transparency level of object from 0 (opaque) to 100 (completely transparent).
virtual int transparencyLevel () const
virtual void setCoordinateSystemType (int)
virtual int coordinateSystemType () const
virtual bool isControlPoint () const
 Questions to ask about this object Accessors to return info about the category.
virtual bool isAnyRoute () const
virtual bool isRoute () const
virtual bool isArea () const
virtual bool isAnyArea () const
virtual bool isObstacle () const
virtual bool isPhaseLine () const
virtual bool isVrfRoute () const
virtual bool isPuff () const

Static Public Member Functions

static DtArchivableObjectcreate ()
static QColor mapColorFrom8Bit (unsigned char iColor)
static unsigned char mapColorTo8Bit (QColor color)

Protected Attributes

QColor myColor
int myAppearance
DtPtrQList< DtArchivableObject * > myUserData
 User a ptr list such that objects that are contained in this list can be recrated when read in (if they have a valid creator).
int myCoordinateSystemType
 Saved out as coordinate system type.

Detailed Description

Represents an environmental process. Used for creating overlay symbols.


Constructor & Destructor Documentation


Member Function Documentation

DtEnvironmentalModelData& DtEnvironmentalModelData::operator= ( const DtEnvironmentalModelData rhs)
virtual DtModelDataType DtEnvironmentalModelData::type ( ) const [virtual]

\ brief Returns the type of this model data

Reimplemented from DtModelData.

Reimplemented in DtTerrainModelData, and DtCompassModelData.

virtual bool DtEnvironmentalModelData::hasColor ( ) const [virtual]
static QColor DtEnvironmentalModelData::mapColorFrom8Bit ( unsigned char  iColor) [static]
static unsigned char DtEnvironmentalModelData::mapColorTo8Bit ( QColor  color) [static]
virtual void DtEnvironmentalModelData::setColor ( QColor  color) [virtual]
virtual QColor DtEnvironmentalModelData::color ( bool  applyAlpha = false) const [virtual]
virtual void DtEnvironmentalModelData::setRawAppearance ( int  app) [virtual]

Bypasses bit masking for line width and appearance and just sets the appearance field.

virtual int DtEnvironmentalModelData::rawAppearance ( ) const [virtual]

Appearance. Zero by default.

Reimplemented from DtModelData.

virtual void DtEnvironmentalModelData::setAppearance ( int  app) [virtual]

Because the high 4 bits are used for line width, the only supported bits for appearance are the lower 28 bits.

In addition, the bits 8-15 are used for styling parameters and reserved also.

virtual int DtEnvironmentalModelData::appearance ( ) const [virtual]
virtual void DtEnvironmentalModelData::setLineWidth ( int  width) [virtual]

Note that the color shares the myAppearance variable, using the high 4 bits.

If line width is 0, then the default line width for the particular type is used. If this item is a point object, the line width is meaningless

virtual int DtEnvironmentalModelData::lineWidth ( ) const [virtual]
virtual void DtEnvironmentalModelData::setFillStyle ( int  style) [virtual]

Note that this shares the myAppearance variable, using the 12-15 bits.

the fill style is defined as the Qt::BrushStyle parameter plus 1 with 0 being undefined

virtual int DtEnvironmentalModelData::fillStyle ( ) const [virtual]
virtual void DtEnvironmentalModelData::setLineStyle ( int  style) [virtual]

Note that this shares the myAppearance variable, using the 8-11 bits line style is defined as Qt::PenStyle plus 1 with 0 being undefined.

virtual int DtEnvironmentalModelData::lineStyle ( ) const [virtual]
virtual void DtEnvironmentalModelData::setUserData ( DtArchivableObject obj) [virtual]

Allow for setting and retrieving of user data, which can be anything.

Note that user data is a derivative of an archivable object such that the data can be stored and retrieved when this object is saved. Since only one user object at a time is currently supported, if the object being set is not the same as the current object, the previous will be removed and deleted

virtual void DtEnvironmentalModelData::setTransparencyLevel ( int  i) [virtual]

Allow for transparency level of object from 0 (opaque) to 100 (completely transparent).

If sent over the network, sent as the alpha channel of the rgb color

virtual int DtEnvironmentalModelData::transparencyLevel ( ) const [virtual]
virtual void DtEnvironmentalModelData::setCoordinateSystemType ( int  ) [virtual]
virtual int DtEnvironmentalModelData::coordinateSystemType ( ) const [virtual]
virtual bool DtEnvironmentalModelData::isControlPoint ( ) const [virtual]

Questions to ask about this object Accessors to return info about the category.

virtual bool DtEnvironmentalModelData::isAnyRoute ( ) const [virtual]
virtual bool DtEnvironmentalModelData::isRoute ( ) const [virtual]
virtual bool DtEnvironmentalModelData::isArea ( ) const [virtual]
virtual bool DtEnvironmentalModelData::isAnyArea ( ) const [virtual]
virtual bool DtEnvironmentalModelData::isObstacle ( ) const [virtual]
virtual bool DtEnvironmentalModelData::isPhaseLine ( ) const [virtual]
virtual bool DtEnvironmentalModelData::isVrfRoute ( ) const [virtual]
virtual bool DtEnvironmentalModelData::isPuff ( ) const [virtual]

Member Data Documentation

User a ptr list such that objects that are contained in this list can be recrated when read in (if they have a valid creator).

Currently, only supports one user data object

Saved out as coordinate system type.

Will currently only convert (on load from an overlay file) from DIS to local


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)