VR-Forces 4.2 Class Documentation
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions
DtPointObjectSymbol Class Reference

class DtPointObjectSymbol: More...

Inheritance diagram for DtPointObjectSymbol:
Inheritance graph
[legend]

Public Types

enum  DtPointObjectAlignment { DtPointObjectCentered = 0, DtPointObjectBottomCentered = 1 }

Public Member Functions

 DtPointObjectSymbol (DtSymbolDrawer &d)
 Constructor.
virtual ~DtPointObjectSymbol ()
 Destructor.
 DtPointObjectSymbol (const DtPointObjectSymbol &orig)
 Copy Constructor.
DtPointObjectSymboloperator= (const DtPointObjectSymbol &rhs)
 Assignment Operator.
virtual void setHighlight (const bool highlight)
 Set/get the highlight flag (whether the symbol should be drawn highlighted).
virtual bool highlight () const
virtual void setOrigin (const QPoint &center)
 Set the display coordinate that will become the 0,0 point for drawing this symbol.
virtual void setOrigin (int x, int y)
 Same as above.
virtual const DtDisplayPoint centerPoint () const
 Set/get the location of the center of the symbol.
virtual const QPoint origin () const
 returns the display origin for the symbol.
virtual bool select (const QPoint &point)
 Checks to see if any children symbols intersect.
virtual bool select (const QPoint &point, const QSize &s)
 Returns true if the rectangle intersects the symbol, if the symbol is selectable.
virtual QRect selBbox () const
 Get the selection box (area where you can select an item)
virtual void shift (QPoint p)
 Move the center of this object by p amount.
virtual DtSymbolclone () const
 Returns an instance of a symbol which is a copy of this.
virtual bool adjustPoints (QPolygon &pnts, bool constrain)
 Returns true if point array has been changed.
virtual bool supportsRightClickDialog () const
 Returns true as to whether or not dialogs can be shown on right clicks.
void setAlignment (DtPointObjectAlignment)
DtPointObjectAlignment alignment () const
virtual void draw (DtSymbol *symbol, QPainter &paint) const
 Draws the symbol.
virtual void setRotateToHeading (bool b)
virtual bool rotateToHeading () const
virtual void setRotationValue (double d)
virtual double rotationValue () const
- Public Member Functions inherited from DtNameLabelSymbol
 DtNameLabelSymbol ()
 Constructor.
 DtNameLabelSymbol (DtSymbolDrawer &d)
virtual ~DtNameLabelSymbol ()
 Destructor.
 DtNameLabelSymbol (const DtNameLabelSymbol &orig)
 Copy Constructor.
DtNameLabelSymboloperator= (const DtNameLabelSymbol &rhs)
 Assignment Operator.
virtual DtTTSSymbolname ()
virtual void setName (DtTTSSymbol *s)
virtual DtTTSSymbollabel ()
virtual void setLabel (DtTTSSymbol *s)
virtual DtTTSSymbollayer ()
virtual void setLayer (DtTTSSymbol *s)
virtual int resetLabelPositions () const
virtual bool offsetFromBottom () const
 Return true if you want to offset labels from bottom of symbol.
virtual void setOffsetFromBottom (bool b)
virtual void setColor (const QColor &col)
 Sets the color of the main symbol and name/label.
virtual void setMainSymbolColor (const QColor &col)
 Set the color of the main symbol if it is a DtColorizedSymbol.
virtual QColor * mainSymbolColor () const
virtual void setPenColor (const QColor &col)
 Sets the pen color for both name and label symbol (if exist)
virtual QColor penColor () const
virtual void setNeedsLabelUpdate (bool b)
virtual bool needsLabelUpdate () const
virtual bool addNameLabel () const
virtual bool addLabelLabel () const
virtual bool addLayerLabel () const
virtual bool canChangeFont () const
 Return true if the dialog (point dialog only) should show a font change section rather than the default height above terrain section.
virtual void setName (const QString &name)
 The specific name of this symbol.
virtual QString getName () const
virtual void setLabel (const QString &label)
virtual QString getLabel () const
virtual void setLayer (const QString &label)
virtual QString getLayer () const
virtual const QFont * font () const
virtual void setFontname (const QString &font)
virtual void setEditable (bool b)
 Accessors for whether or not this line can be edited.
virtual bool editable () const
virtual void setAllowEditOnSelection (bool b)
 Set in main symbol as well.
virtual bool freehand () const
 Returns true if main symbol is in freehand mode.
virtual DtTTSSymbolcreateNameSymbol ()
 Must set drawer to draw labels before being able to create.
virtual DtTTSSymbolcreateLabelSymbol ()
virtual void setLabelDrawer (DtSymbolDrawer *drawer)
void setPositionLabelChildren (bool)
bool positionLabelChildren () const
virtual void copyDataFrom (const DtSymbol *symbol)
 Differs from the equal operator in that this method could copy a different set of data than the = operator.
virtual void clearColor ()
 Noop function to allow subclasses to clear out any color information.
virtual void clearMainSymbolColor ()
- Public Member Functions inherited from DtCompositeSymbol
 DtCompositeSymbol (const DtCompositeSymbol &orig)
 standard
DtCompositeSymboloperator= (const DtCompositeSymbol &orig)
virtual ~DtCompositeSymbol ()
 DtCompositeSymbol (DtSymbolDrawer &drawer)
 default constructor
 DtCompositeSymbol (DtSymbolDrawer &drawer, const DtDisplayPoint &center)
virtual bool setLocationData (const QPolygon *)
 This function is used so that multipoint symbols have the same interface as single point symbols In the single point case, it takes the first value and sets the origin from that.
virtual void draw (QPainter &paint) const
virtual void drawHidden (QPainter &paint) const
virtual void addSymbol (DtSymbol *symbol, bool isALabel=false)
 Adds a child symbol to the composite.
virtual void removeSymbol (const DtSymbol *symbol, bool deleteSymbol=true, bool resetMainSymbol=false)
 Removes a child symbol from the composite.
virtual void removeSymbol (int iIndex, bool deleteSymbol=true, bool resetMainSymbol=false)
virtual void removeAllSymbols (const QVector< DtSymbol * > &except=QVector< DtSymbol * >())
 Removes all child symbols from the composite.
virtual DtSymbolsetMainSymbol (DtSymbol *symbol)
 Set/get the center symbol.
virtual DtSymbolmainSymbol () const
virtual DtSymbolgetSymbolByName (const QString &name)
 Get a symbol by using its name.
virtual bool isComposite ()
 Returns true if this symbol is a combination of others (this returns true)
virtual QSize bbox () const
 Calculates size of the composite based on its children.
virtual bool overlapsSymbol (const DtSymbol &aSymbol, const DtSymbol_OverlapTest aTest=DtSymbol_BoxPieces, const float aTolerance=0) const
 Returns true if the two symbols overlap Different intersection tests are available.
virtual bool labelsOverlapsSymbol (const DtSymbol &aSymbol, const DtSymbol_OverlapTest aTest=DtSymbol_BoundingBox, const float aTolerance=0) const
virtual DtSymbolListchildrenList () const
virtual DtSymbolListlabelList () const
virtual bool show (DtShowHideContext module)
 Show this symbol and any other symbol in the hidden list.
virtual bool hide (DtShowHideContext module)
 Hide symbols that are shown and put into hidden list.
virtual void setDrawOrder ()
 Creates the draw order list for the symbols.
virtual DtSymboleditableSymbol ()
 Returns the symbol that can be edited via an event handler.
virtual int labelOffset (const DtSymbol *s) const
 Returns the label offset from the main symbols bounding box.
virtual void setLabelOffset (int i)
virtual const QPoint & lowestLabelOffset () const
 Returns the parent offset of the last label drawn.
virtual void setTransparencyLevel (int i)
 Transparency information.
virtual void hideAllChildren (DtShowHideContext iModule=DtDefaultShowHideContext)
 Hides all children but keeps main symbol shown.
virtual void showAllChildren (DtShowHideContext iModule=DtDefaultShowHideContext)
 Shows all children.
virtual void setShadowText (bool b)
 Cycles through all children and set shadow text to be true (if they are TTS symbol).
virtual void blockSignals (bool)
 Blocks signals from being emitted from this symbol.
virtual bool originIsCenterOfMass () const
 Asks main symbol if the origin is center of call.
virtual void setCacheSymbolAsBitmap (bool)
 Get/set whether or not the drawer should cache this symbol as a bitmap.
virtual void setShowIndicatorOption (int)
int showIndicatorOption () const
virtual DtShowHideContext mapIndicatorOptionToContext (int) const
virtual bool editMode ()
 Extends the editMode functions from basic DtySymbol to propagate correctly.
virtual void setEditMode (bool onOff)
virtual void reset ()
 Resets any relevant information associated with this symbol.
- Public Member Functions inherited from DtSymbol
virtual ~DtSymbol ()
 destructor
 DtSymbol (const DtSymbol &orig)
 copy constructor
DtSymboloperator= (const DtSymbol &orig)
 assignment operator Note that the copy constructor, by default, make the symbol non editable even if the source is editable
 DtSymbol (DtSymbolDrawer &drawer)
 Drawer is non-const since it does memory management.
virtual const QString & name () const
virtual bool selected () const
virtual const DtDisplayPoint topLeftPoint () const
 The real visual top left corner of the symbol in display coordinates.
virtual const QPolygon * getLocationData () const
 Provided for a simpler interface to subclasses.
virtual const DtSymbolDrawerdrawer () const
virtual QRect brect () const
virtual void clearOffsetToParent ()
 Set/get the offset to the parent.
virtual void setOffsetToParent (const QPoint &offsetToParent)
virtual const QPoint * offsetToParent () const
 if the offsetToParent blit has been cleared, this returns null
virtual void show ()
 Use this method to show the symbol regardless of how many contexts have hidden it.
virtual void hide ()
 Use this method to hide a symbol without context. Same as hide(DtDefaultShowHideContext)
virtual void addIgnoreContext (DtShowHideContext)
 Add/remove contexts for hide() to ignore.
virtual void removeIgnoreContext (DtShowHideContext)
const QVector
< DtShowHideContext > & 
ignoreContexts () const
virtual bool isShown () const
virtual DtSymbolparent () const
virtual void setParent (DtSymbol *dad)
virtual DtSymbolGeometry geometry () const
virtual void setGeometry (DtSymbolGeometry geom)
virtual void setCategoryTag (const QString &name)
 A tag is the name of this type of symbol such as velocity vector name or force or whatever.
virtual const QString & categoryTag () const
virtual void setSelectable (bool value)
 Set/get the ability to select with this symbol.
virtual bool isSelectable () const
virtual bool allowEditOnSelection () const
virtual void setInternalSelectable (bool value)
 The following two functions are internal values kept in order to make sure that if an object has been filter modified and not shown, that it will not be selectable.
virtual bool isInternalSelectable () const
virtual void setAddToDrawOrder (bool b)
 Add this item to the draw order regardless of whether or not it is visible on the screen.
virtual bool addToDrawOrder () const
virtual bool overlapsAreaSymbol (const DtSymbol &aSymbol, const DtSymbol_OverlapTest aTest=DtSymbol_BoxPieces, const float aTolerance=0) const
 handles the case when aSymbol spans an area, such as a bitmap or a text symbol.
virtual bool overlapsLineSymbol (DtSymbol &aSymbol, const float aTolerance=0) const
 handles the case when aSymbol is composed of line segments, such as a line, polygon, or route.
virtual bool isOriginal () const
 Returns true if this symbol is an original symbol, otherwise return false.
virtual DtStaticAnimDatastaticAnimData () const
virtual void setDrawOnComposite (DtSymbolCompositeDrawOptions opt)
 If true, will not draw this symbol if it is part of a composite symbol.
virtual bool drawOnComposite () const
virtual
DtSymbolCompositeDrawOptions 
drawOnCompositeValue () const
virtual bool drawFirst () const
 If true, this symbol will always be drawn first.
virtual void setDrawFirst (bool b)
virtual bool drawLast () const
 If true, this symbol will always be drawn last.
virtual void setDrawLast (bool b)
virtual bool selectAdditionalSymbols (QList< DtSymbol * > &additionalSymbols)
 This routine is called during symbol selection time to see if the selection of this symbol requires other symbols to be selected as well.
virtual void setDragClone (DtSymbol *clone)
 Contains the symbol that is being dragged that represents this symbol.
virtual DtSymboldragClone () const
virtual double scaleBy () const
virtual void enableVisibilityChange (bool b)
virtual void scheduleDisplayComplete (int)
 Sets a QTimer for the specified amount of time to fire off and then call the displayComplete() slot.
virtual void setShouldSelect (bool)
virtual bool shouldSelect () const
virtual int transparencyLevel () const
virtual bool needsTransparentRedraw () const
 Will return true if there is no cached image or internal variables have changed such that the cached image needs a redraw.
virtual QPixmap * transparentImage () const
virtual QPixmap * cacheTransparentImage (const QPixmap &pixmap)
virtual QPixmap * cacheTransparentImage (const QImage &image)
virtual bool wantsTransparentDraw () const
 Will return true if transparent percent is not 0 or 100.
bool operator== (const DtSymbol &orig) const
bool operator!= (const DtSymbol &orig) const
virtual DtSymbolDrawersymbolDrawer ()
 Sets the new drawer to be the supplied drawer.
virtual DtSymbolDrawersetDrawer (const DtSymbolDrawer &)
virtual DtSymbolDrawerbackupDrawer () const
 Returns the drawer that was set as a backup.
virtual void setBackupDrawer (DtSymbolDrawer *)
virtual bool removeIfOffScreen () const
 Return true/false if this symbol should be removed if it is off screen By default is true.
void setRemoveIfOffScreen (bool b)
 Default is true.
virtual void setSymbolDisplayOptions (DtSymbolDisplayOptions *)
virtual const
DtSymbolDisplayOptions
symbolDisplayOptions () const
virtual DtSymbolDisplayOptionssymbolDisplayOptions ()
virtual int displayOptionsCache () const
void setAdjustPoints (bool)
bool adjustPoints () const
const QVector
< DtShowHideContext > & 
hiddenByModules () const
 Routines to access which modules this symbol is hidden by.
bool hiddenByModule (DtShowHideContext module) const
bool cacheSymbolAsBitmap () const
virtual const QString & bitmapSymbolCacheKey () const
 Returns a cache key that can be used to lookup in a bitmap cache.

Static Public Member Functions

static DtSymbolcreate (DtSymbolDrawer &drawer)

Protected Attributes

DtPointObjectAlignment myAlignment
double myRotationValue
bool myRotateToHeading
- Protected Attributes inherited from DtNameLabelSymbol
DtTTSSymbolmyName
DtTTSSymbolmyLabel
DtTTSSymbolmyLayer
QColor myLabelColor
bool myNeedsLabelUpdate
bool myOffsetFromBottom
QString myFontname
DtSymbolDrawermyLabelDrawer
bool myPositionLabelChildren
- Protected Attributes inherited from DtCompositeSymbol
DtSymbolListmyChildrenList
DtSymbolListmyLabelList
DtSymbolmyMainSymbol
DtSymbolListmyDrawOrder
DtSymbolListmySelectedChildren
int myLabelOffset
QPoint myLastParentOffset
bool myShadowText
int myShowIndicatorOption
- Protected Attributes inherited from DtSymbol
DtSymbolDrawermySymbolDrawer
DtSymbolDrawermyBackupDrawer
QPoint myOrigin
bool myActiveOffsetToParent
QPoint myOffsetToParent
bool myHighlight
bool myIsShown
bool myIsSelectable
bool myEditable
bool myInternalSelectable
QString myName
QString myCategoryTag
DtSymbolGeometry myGeometry
DtSymbolmyParent
DtSymbolmyDragClone
 If this symbol is being dragged, then this will point to the symbol that was cloned for the drag.
bool myIsOriginal
bool myAllowEditOnSelection
bool myAddToDrawOrder
double myScaleFactor
DtStaticAnimDatamyStaticAnimData
bool myEmitVisibilityChange
DtSymbol_DrawOrder myDrawOrder
QTimer * myTimer
DtSymbolCompositeDrawOptions myDrawOnComposite
bool myShouldSelect
 Set to true if part of a composite and a user has selected a part of the composite that should be selected.
int myTransparencyLevel
 Information for symbol transparency and transparent drawing.
QPixmap * myTransparentImage
DtSymbolmyTransparentCachedSymbol
DtSymbolDisplayOptionsmySymbolDisplayOptions
bool myAdjustPoints
QVector< DtShowHideContextmyHiddenByModules
QVector< DtShowHideContextmyIgnoreContexts
bool myRemoveIfOffscreen
bool myCacheSymbolAsBitmap
bool myEditMode
QString mySymbolBitmapCacheKey

Private Member Functions

 DtPointObjectSymbol ()
 Not implemented. Private to ensure it is only constructed with a drawer.

Additional Inherited Members

- Public Slots inherited from DtSymbol
virtual void invalidateStaticAnimData ()
 This gets called when modified symbols exist and the original symbol has been destroyed.
virtual void displayComplete ()
 Call when the display of this symbol is complete.
virtual void clearDragClone (QObject *)
 Called when the drag clone is destroyed outside of this context, we will be notified in that case to clear out this symbols internal pointer.
- Signals inherited from DtSymbol
void originalSymbolDestroyed ()
 Sent when an original symbol has been destroyed - (so that the drawer can remove that cache)
void destroyed (const DtSymbol *)
 Called when we are destroyed, this will give our drawers a chance to update any cached information.
void originChanged (const DtSymbol *)
 Sent when setOrigin is called with a different origin.
void visibilityChanged (const DtSymbol *)
 Sent when visibility change sending is enabled and a symbol is shown or hidden when it wasn't before.
void displayComplete (const DtSymbol *)
 Called from displayComplete()
- Protected Slots inherited from DtCompositeSymbol
virtual void symbolDestroyed (const DtSymbol *s)
 Called when this symbol is destroyed outside of this composite symbol.
virtual void symbolRemoved (const DtSymbol *s)
 Removes a symbol without deleting it.
- Protected Member Functions inherited from DtNameLabelSymbol
virtual DtTTSSymbolcreateTextSymbol ()
- Static Protected Attributes inherited from DtSymbol
static DtNullDrawer theNullDrawer

Detailed Description

class DtPointObjectSymbol:

Instances of DtPointObjectSymbol are

Member Enumeration Documentation

Enumerator:
DtPointObjectCentered 
DtPointObjectBottomCentered 

Constructor & Destructor Documentation

DtPointObjectSymbol::DtPointObjectSymbol ( DtSymbolDrawer d)

Constructor.

virtual DtPointObjectSymbol::~DtPointObjectSymbol ( )
virtual

Destructor.

DtPointObjectSymbol::DtPointObjectSymbol ( const DtPointObjectSymbol orig)

Copy Constructor.

DtPointObjectSymbol::DtPointObjectSymbol ( )
private

Not implemented. Private to ensure it is only constructed with a drawer.

Member Function Documentation

DtPointObjectSymbol& DtPointObjectSymbol::operator= ( const DtPointObjectSymbol rhs)

Assignment Operator.

virtual void DtPointObjectSymbol::setHighlight ( const bool  highlight)
virtual

Set/get the highlight flag (whether the symbol should be drawn highlighted).

Reimplemented from DtCompositeSymbol.

virtual bool DtPointObjectSymbol::highlight ( ) const
virtual

Reimplemented from DtSymbol.

virtual void DtPointObjectSymbol::setOrigin ( const QPoint &  center)
virtual

Set the display coordinate that will become the 0,0 point for drawing this symbol.

On most symbols, this will be the same as the center point, but this doesn not need to be the case

Reimplemented from DtSymbol.

virtual void DtPointObjectSymbol::setOrigin ( int  x,
int  y 
)
virtual

Same as above.

Reimplemented from DtSymbol.

virtual const DtDisplayPoint DtPointObjectSymbol::centerPoint ( ) const
virtual

Set/get the location of the center of the symbol.

Also set the children if they have the offset variable

Reimplemented from DtCompositeSymbol.

virtual const QPoint DtPointObjectSymbol::origin ( ) const
virtual

returns the display origin for the symbol.

On most symbols, this will be the same as the center point, but this doesn not need to be the case

Reimplemented from DtSymbol.

virtual bool DtPointObjectSymbol::select ( const QPoint &  point)
virtual

Checks to see if any children symbols intersect.

Reimplemented from DtCompositeSymbol.

virtual bool DtPointObjectSymbol::select ( const QPoint &  aPoint,
const QSize &  rectangleSize 
)
virtual

Returns true if the rectangle intersects the symbol, if the symbol is selectable.

Reimplemented from DtSymbol.

virtual QRect DtPointObjectSymbol::selBbox ( ) const
virtual

Get the selection box (area where you can select an item)

  • this queries the drawer

Reimplemented from DtCompositeSymbol.

virtual void DtPointObjectSymbol::shift ( QPoint  p)
virtual

Move the center of this object by p amount.

Reimplemented from DtCompositeSymbol.

virtual DtSymbol* DtPointObjectSymbol::clone ( ) const
virtual

Returns an instance of a symbol which is a copy of this.

The caller is responsible for freeing the memory.

Reimplemented from DtNameLabelSymbol.

virtual bool DtPointObjectSymbol::adjustPoints ( QPolygon &  pnts,
bool  constrain 
)
virtual

Returns true if point array has been changed.

Reimplemented from DtNameLabelSymbol.

virtual bool DtPointObjectSymbol::supportsRightClickDialog ( ) const
virtual

Returns true as to whether or not dialogs can be shown on right clicks.

By default is true

Reimplemented from DtNameLabelSymbol.

void DtPointObjectSymbol::setAlignment ( DtPointObjectAlignment  i)
inline

References myAlignment.

DtPointObjectSymbol::DtPointObjectAlignment DtPointObjectSymbol::alignment ( ) const
inline

References myAlignment.

virtual void DtPointObjectSymbol::draw ( DtSymbol symbol,
QPainter &  paint 
) const
virtual

Draws the symbol.

Override for any specific drawing. Called for each symbol to be drawn

Reimplemented from DtCompositeSymbol.

virtual void DtPointObjectSymbol::setRotateToHeading ( bool  b)
virtual
virtual bool DtPointObjectSymbol::rotateToHeading ( ) const
virtual
virtual void DtPointObjectSymbol::setRotationValue ( double  d)
virtual
virtual double DtPointObjectSymbol::rotationValue ( ) const
virtual
static DtSymbol* DtPointObjectSymbol::create ( DtSymbolDrawer drawer)
static

Reimplemented from DtNameLabelSymbol.

Member Data Documentation

DtPointObjectAlignment DtPointObjectSymbol::myAlignment
protected

Referenced by alignment(), and setAlignment().

double DtPointObjectSymbol::myRotationValue
protected
bool DtPointObjectSymbol::myRotateToHeading
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)