VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions
DtAreaObjectSymbol Class Reference

class DtAreaObjectSymbol: More...

Inheritance diagram for DtAreaObjectSymbol:
Inheritance graph
[legend]

Public Member Functions

 DtAreaObjectSymbol ()
 Constructor.
 DtAreaObjectSymbol (DtSymbolDrawer &d)
virtual ~DtAreaObjectSymbol ()
 Destructor.
 DtAreaObjectSymbol (const DtAreaObjectSymbol &orig)
 Copy Constructor.
DtAreaObjectSymboloperator= (const DtAreaObjectSymbol &rhs)
 Assignment Operator.
virtual DtSymbolclone () const
 Returns an instance of a symbol which is a copy of this.
virtual bool closedFigure () const
virtual bool checkValid () const
 Return true/false if need to check for concave validity.
virtual bool select (const QPoint &point)
 Checks to see if any children symbols intersect.
virtual void setAllowInsideSelection (bool b)
 If set to true, will check if point is inside area, not just segments.
- Public Member Functions inherited from DtLineObjectSymbol
 DtLineObjectSymbol ()
 Constructor.
 DtLineObjectSymbol (DtSymbolDrawer &d)
virtual ~DtLineObjectSymbol ()
 Destructor.
 DtLineObjectSymbol (const DtLineObjectSymbol &orig)
 Copy Constructor.
DtLineObjectSymboloperator= (const DtLineObjectSymbol &rhs)
 Assignment Operator.
virtual bool select (const QPoint &point, const QSize &s)
 Returns true if the rectangle intersects the symbol, if the symbol is selectable.
virtual void setHighlight (const bool highlight)
 Set/get the highlight flag (whether the symbol should be drawn highlighted).
virtual bool highlight () const
virtual int resetLabelPositions () const
virtual const QPolygon * getLocationData () const
 Provided for a simpler interface to subclasses.
virtual bool adjustPoints (QPolygon &pnts, bool constrain)
 Adjusts the list of points to match the box we need.
virtual bool setAndCalculatePoint (int iIndex, const QPoint &pnt)
 Given a screen point, return a point on the line that will draw exactly to the screen.
virtual bool setAndCalculatePoint (int iIndex, const DtPoint &pnt, QVector< DtPoint > *list)
 Given a database point and database coordinates, calculate new locations based on that and place the results into the supplied array.
virtual void setAdjustPoints (bool)
virtual bool adjustPoints () 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 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 supportsRightClickDialog () const
 Returns true as to whether or not dialogs can be shown on right clicks.
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.
void shift (QPoint p)
 Move the center of this object by p amount.
virtual void draw (QPainter &paint) const
virtual void drawHidden (QPainter &paint) const
virtual const DtDisplayPoint centerPoint () const
 Set/get the location of the center of the symbol.
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 QRect selBbox () const
 Get the selection box (area where you can select an item)
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 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 QPoint origin () const
 returns the display origin for the symbol.
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
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)

Additional Inherited Members

- Public Types inherited from DtSymbol
enum  DtSymbol_OverlapTest {
  DtSymbol_BoundingSphere = 0, DtSymbol_BoundingBox = 1, DtSymbol_SpherePieces = 2, DtSymbol_BoxPieces = 3,
  DtSymbol_Exact = 4
}
 Type of overlap test. More...
enum  DtSymbol_DrawOrder { DtSymbol_DrawAsEntered = 0, DtSymbol_DrawFirst = 1, DtSymbol_DrawLast = 2 }
enum  DtSymbolCompositeDrawOptions { DtSymbol_Always = 0, DtSymbol_Never = 1, DtSymbol_OnlyIfCloned = 2 }
- 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 ()
- Protected Attributes inherited from DtNameLabelSymbol
DtTTSSymbolmyName
DtTTSSymbolmyLabel
DtTTSSymbolmyLayer
QColor myLabelColor
bool myNeedsLabelUpdate
bool myOffsetFromBottom
QString myFontname
DtSymbolDrawermyLabelDrawer
bool myPositionLabelChildren
- Static Protected Attributes inherited from DtSymbol
static DtNullDrawer theNullDrawer

Detailed Description

class DtAreaObjectSymbol:

Instances of DtAreaObjectSymbol are

Constructor & Destructor Documentation

DtAreaObjectSymbol::DtAreaObjectSymbol ( )

Constructor.

DtAreaObjectSymbol::DtAreaObjectSymbol ( DtSymbolDrawer d)
virtual DtAreaObjectSymbol::~DtAreaObjectSymbol ( )
virtual

Destructor.

DtAreaObjectSymbol::DtAreaObjectSymbol ( const DtAreaObjectSymbol orig)

Copy Constructor.

Member Function Documentation

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

Assignment Operator.

virtual DtSymbol* DtAreaObjectSymbol::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 DtLineObjectSymbol.

Reimplemented in DtCircleObjectSymbol.

virtual bool DtAreaObjectSymbol::closedFigure ( ) const
virtual

Reimplemented from DtLineObjectSymbol.

virtual bool DtAreaObjectSymbol::checkValid ( ) const
virtual

Return true/false if need to check for concave validity.

By default returns true

Reimplemented in DtCircleObjectSymbol.

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

Checks to see if any children symbols intersect.

Reimplemented from DtLineObjectSymbol.

Reimplemented in DtCircleObjectSymbol.

virtual void DtAreaObjectSymbol::setAllowInsideSelection ( bool  b)
virtual

If set to true, will check if point is inside area, not just segments.

Default is false

static DtSymbol* DtAreaObjectSymbol::create ( DtSymbolDrawer drawer)
static

Reimplemented from DtLineObjectSymbol.

Reimplemented in DtCircleObjectSymbol.


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)