DtEnvironmentalModelData Class Reference

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

Inheritance diagram for DtEnvironmentalModelData:

Public Member Functions
	DtEnvironmentalModelData ()
	DtEnvironmentalModelData (const DtEnvironmentalModelData &orig)
virtual	~DtEnvironmentalModelData ()
DtEnvironmentalModelData &	operator= (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 DtArchivableObject *	userData ()
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
Public Member Functions inherited from DtModelData
	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 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.
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
DtArchiver *	archiver ()
	Returns the archiver of this object.
virtual void	setLevel (int i)
virtual int	level () const
virtual DtArchivableObject *	clone ()
	Allows for cloning of this object.

Static Public Member Functions
static DtArchivableObject *	create ()
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.
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
DtArchiver *	myArchiver

Additional Inherited Members
Signals inherited from DtModelData
void	modelDataDestroyed (const QString &)
	Emitted from the destructor.
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)

Detailed Description

Represents an environmental process. Used for creating overlay symbols.

Constructor & Destructor Documentation

DtEnvironmentalModelData::DtEnvironmentalModelData

(

)

DtEnvironmentalModelData::DtEnvironmentalModelData

(

const DtEnvironmentalModelData &

orig

)

virtual DtEnvironmentalModelData::~DtEnvironmentalModelData ( )

virtual

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.

static DtArchivableObject* DtEnvironmentalModelData::create ( )

static

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 DtArchivableObject* DtEnvironmentalModelData::userData ( )

virtual

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

QColor DtEnvironmentalModelData::myColor

protected

int DtEnvironmentalModelData::myAppearance

protected

DtPtrQList<DtArchivableObject*> DtEnvironmentalModelData::myUserData

protected

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

int DtEnvironmentalModelData::myCoordinateSystemType

protected

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:

• include/symbolMapper/envModelData.h