VR-Forces 4.1 Class Documentation
List of all members | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtTMMiniMap Class Reference

A DtTMMiniMap is a view of the full world on a small window. More...

Inheritance diagram for DtTMMiniMap:
Inheritance graph
[legend]

Public Slots

virtual void setActiveRubberBand (DtTMRubberBand *)
 Slot to set the active rubber band.
virtual void removeRubberBand (QObject *)
 Its a qobject only for signal/slot matching..
virtual void drawRubberBands (QPainter *p)
- Public Slots inherited from DtTMArea
virtual void loadDatabaseFile (const QString &)
virtual void setViewportExtents (const DtTMViewportExtents *v)
virtual bool updateAllSymbols ()
 Go through the list of symbols that we have marked for update and update them.
virtual void updateBackground ()
virtual void resizeMapArea ()
virtual DtSymboladdSymbol (const DtModelData &data, bool force=false)
virtual void removeSymbol (const DtModelData &data, bool force=false)
virtual void modifySymbol (const DtModelData &data)
virtual void removeSymbol (const DtModelKey &data, bool force=false)
virtual void setDrawOrderSymbols (bool b)
 Set to true to draw order symbols on the next tick.
virtual void signalDrawOrderSymbols ()
 Signals to draw order the symbols on the next tick.
virtual void drawOrderSymbols ()
 Draw order symbols if at least one first/last draw by having lens area draw order symbols.

Signals

void activeRubberBandSet (const DtTMRubberBand *)
 Indicates that the active rubber band has been changed.
- Signals inherited from DtTMArea
void viewportExtentsSet (const DtTMViewportExtents *v)
 Called after setTdbView.
void viewportExtentsChanged (const DtTMViewportExtents *v)
 Called after internally changing tdb view.
void newDatabaseFile (const QString &)
void removingSymbol (const DtModelKey &data)
 Called when removing, adding or modifying a symbol.
void addingSymbol (const DtModelKey &data)
void modifyingSymbol (const DtModelKey &data)
void resized ()
 Sent when this area has resized.
void modelDataMarkedForUpdated (const DtModelData &d)
void modelDataRemovedFromUpdate (const DtModelData &)

Public Member Functions

 DtTMMiniMap (QWidget *parent=0, const Qt::WindowFlags &f=0)
 Constructor.
virtual ~DtTMMiniMap ()
 Destructor.
virtual bool init (const DtTMFactory *f)
 Initializer.
virtual bool showingRubberBands () const
 Returns true if showing rubber bands. False if not.
virtual void setShowingRubberBands (bool onOff)
 Toggles showing rubber bands.
virtual QSize minimumSizeHint () const
 Returns preferred size.
virtual QSize sizeHint () const
virtual DtTMRubberBandaddRubberBand (const DtTMFactory *f, const DtTMMiniMap *m, const DtTMMapArea *a, double pctX=0, double pctY=0, double pctWidth=1, double pctHeight=1, QPen *activePen=0, QPen *inactivePen=0)
virtual const QPen & activePen () const
 Returns a reference to the default pen used for drawing in the active state.
virtual void setActivePen (const QPen &p)
 Sets the default pen used for drawing in the active state.
virtual const QPen & inactivePen () const
 Returns a reference to the default pen use for drawing in the inactive state.
virtual void setInactivePen (const QPen &p)
 Sets the default pen used for drawing in the inactive state.
virtual void setActiveColor (const QColor &c)
virtual void setInactiveColor (const QColor &c)
- Public Member Functions inherited from DtTMArea
 DtTMArea (QWidget *parent=0, const Qt::WindowFlags &flags=0)
virtual ~DtTMArea ()
virtual void setSymbolMapper (DtBaseSymbolMapper *mapper)
virtual DtBaseSymbolMappergetSymbolMapper ()
virtual DtTMSymbolUpdatersymbolUpdater ()
virtual DtTMViewportExtentsviewportExtents () const
 Gets the current viewport extents.
virtual DtViewDriverviewDriver () const
 Gets the current view driver.
virtual void setViewDriver (DtViewDriver *v)
 Sets the current view driver.
virtual DtTMBackgroundbackground () const
 Gets the current background.
virtual void setBackground (DtTMBackground *v)
 Sets the current background.
virtual void setSymbolLensArea (DtSymbolLensArea *area)
virtual DtSymbolLensAreasymbolLensArea ()
virtual bool tick ()
 area was modified because of the tick
virtual bool isInitialized ()
virtual DtModelDataDictModelDataDict ()
 Returns the local list of Symbol Datas.
virtual DtModelDataIterModelDataIter () const
 Returns the local list of Symbol Datas.
virtual DtModelDataIterCombinedModelDataIter () const
 Returns the combined list of global application and local model data.
virtual void setUpdateOnTick (bool b)
 Set the fact that this area will also refresh its display on a tick.
virtual void markForUpdate (const QVector< DtModelKey > &, bool emitSignal=true)
 Copy the model data from the supplied list to our internal update list that will be updated on the next call to updateAllSymbols.
virtual void markForUpdate (DtModelDataIter *iter, bool emitSignal=true)
virtual void markForUpdate (const DtModelData &data, bool emitSignal=true)
virtual void removeFromUpdate (DtModelDataIter *iter)
 Call these to remove model datas for update.
virtual void removeFromUpdate (const DtModelData &data)
virtual void removeDictionaryEntry (const DtModelKey &key)
 Removes this entry from the local dictionary.
virtual void setUpdateBackgroundOnTick (bool b)
 Set to true to call updateBackground on next tick.
void setNextTickIsRepaint (bool b)
 Set to have the next update (if the area is updated in a tick) to be a repaint rather than an update.
bool nextTickIsRepaint () const
virtual bool needsTick () const
 Return true if this area needs to be ticked.
virtual bool needsUpdate () const
 Return true if this area needs update because myUpdateData.count() is not zero.
virtual DtSymboladdSymbol (const DtModelData &data, DtSymbol *symbol)
 Adds a new symbol with the associated model data to the map area.
virtual void read (QTextStream &ts)
 Archival operators.
virtual void write (QTextStream &ts)
virtual void clear ()
 Tells view driver to clear out any symbols and then clears out local data dictionary of any data.
virtual void clearSymbols ()
virtual void setForceTickOnViewportChange (bool b)
 Set this to true to force a tick when the viewport has changed (to speed drawing on map areas).
virtual bool forceTickOnViewportChange () const
virtual void paint (QPainter *painter, bool paintBackground=true)
 Draw to the supplied device. Draws the background (if specified) and the lens area.
virtual void redrawBackground ()
virtual DtSymbolgetSymbol (const DtModelKey &) const
 Returns a symbol from the view driver for the given model key (if exists)
void setAlwaysResizeToGlobalView (bool)
 If true, when map area is resized, always go back to global view.
bool alwaysResizeToGlobalView () const
virtual bool terrainLoaded () const
void setWindow (DtBaseWindow *)
DtBaseWindowwindow () const
virtual void insertIntoDrawOrder (DtSymbol *)
 Insert symbol into lens area draw order.

Static Public Member Functions

static DtTMMiniMapcreate (QWidget *parent, const Qt::WindowFlags &f)
 Returns a newly created instance of a DtTMMiniMap.

Protected Member Functions

 DtTMMiniMap (const DtTMMiniMap &orig)
 Not implemented.
DtTMMiniMapoperator= (const DtTMMiniMap &orig)
 Not implemented.
virtual void mouseReleaseEvent (QMouseEvent *e)
 Override parent implementation.
virtual void mousePressEvent (QMouseEvent *e)
virtual void mouseMoveEvent (QMouseEvent *e)
virtual void resizeEvent (QResizeEvent *e)
 Resize event.
virtual void clipPoint (QPoint &point)
 Protected member functions.
virtual void clipRect (QRect &rect)
virtual void reorderRectangle (QRect &rect)
virtual void resizeRectToFitAspectRatio (QRect &r, const double &ratio)
virtual bool needsDrawOrder () const
 Mini maps do not care about draw ordering, so return false.
- Protected Member Functions inherited from DtTMArea
 DtTMArea (const DtTMArea &orig)
 Not implemented.
DtTMAreaoperator= (const DtTMArea &rhs)
 Not implemented.
virtual bool initViewportExtents (const DtTMFactory *f)
virtual bool initViewDriver (const DtTMFactory *f)
virtual bool initLensArea (const DtTMFactory *f, bool useGL=false)
virtual bool initBackground (const DtTMFactory *f)
virtual void showEvent (QShowEvent *e)

Protected Attributes

QPen myActivePen
QPen myInactivePen
DtTMRubberBandList myTMRubberBandList
DtTMRubberBandmyActiveRubberBand
QRect mySelectionRect
bool myShowingRubberBands
bool myTracking
- Protected Attributes inherited from DtTMArea
DtViewDrivermyViewDriver
DtTMViewportExtentsmyViewportExtents
bool myDelayGlobalResize
DtSymbolLensAreamyLensArea
bool myDeleteLensArea
QPixmap * myBackground
QTimer myResizeTimer
DtTMBackgroundmyTMBackground
bool myDeleteBackground
DtModelDataDict myModelDataDict
DtModelDataItermyModelDataIter
DtModelDataItermyCombinedModelDataIter
bool myFirstTick
bool myUpdateOnTick
QHash< DtModelKey, DtModelData * > myUpdateData
bool myUpdateOnlyModified
bool myIsInitialized
bool myUpdateBackgroundOnTick
bool myForceTickOnViewportChange
bool myNextTickIsRepaint
DtArchiver myArchiver
 Used to write out any variables that want to be saved.
bool myAlwaysResizeToGlobalView
DtBaseWindowmyWindow
bool myNeedsDrawOrder
bool myInTick

Additional Inherited Members

- Protected Slots inherited from DtTMArea
virtual void catchViewportChange (const DtTMViewportExtents *v)
virtual void symbolAdded (const DtModelKey &data)
 Called when the view driver adds or removes a symbol.
virtual void symbolAdded (const DtSymbol *)
virtual void symbolRemoved (const DtModelKey &data)
virtual void symbolRemoved (const DtSymbol *)

Detailed Description

A DtTMMiniMap is a view of the full world on a small window.

Because the world is typically not scaled or resized, this class is optimized for a static bitmap as a terrain. Also, it contains a way of drawing blips, and a few other graphical signals as well as a callback loop if you want to add extra information

Constructor & Destructor Documentation

DtTMMiniMap::DtTMMiniMap ( QWidget parent = 0,
const Qt::WindowFlags &  f = 0 
)

Constructor.

virtual DtTMMiniMap::~DtTMMiniMap ( )
virtual

Destructor.

DtTMMiniMap::DtTMMiniMap ( const DtTMMiniMap orig)
protected

Not implemented.

Member Function Documentation

virtual bool DtTMMiniMap::init ( const DtTMFactory f)
virtual

Initializer.

Reimplemented from DtTMArea.

Reimplemented in DtTerrainMiniMap.

virtual bool DtTMMiniMap::showingRubberBands ( ) const
virtual

Returns true if showing rubber bands. False if not.

virtual void DtTMMiniMap::setShowingRubberBands ( bool  onOff)
virtual

Toggles showing rubber bands.

virtual QSize DtTMMiniMap::minimumSizeHint ( ) const
virtual

Returns preferred size.

virtual QSize DtTMMiniMap::sizeHint ( ) const
virtual
virtual DtTMRubberBand* DtTMMiniMap::addRubberBand ( const DtTMFactory f,
const DtTMMiniMap m,
const DtTMMapArea a,
double  pctX = 0,
double  pctY = 0,
double  pctWidth = 1,
double  pctHeight = 1,
QPen *  activePen = 0,
QPen *  inactivePen = 0 
)
virtual
virtual const QPen& DtTMMiniMap::activePen ( ) const
virtual

Returns a reference to the default pen used for drawing in the active state.

Rubber bands may instantiate their own pen if they wish to use a special color etc.

virtual void DtTMMiniMap::setActivePen ( const QPen &  p)
virtual

Sets the default pen used for drawing in the active state.

virtual const QPen& DtTMMiniMap::inactivePen ( ) const
virtual

Returns a reference to the default pen use for drawing in the inactive state.

Rubber bands may instantiate their own pen if they wish to use a special color etc.

virtual void DtTMMiniMap::setInactivePen ( const QPen &  p)
virtual

Sets the default pen used for drawing in the inactive state.

virtual void DtTMMiniMap::setActiveColor ( const QColor &  c)
virtual
virtual void DtTMMiniMap::setInactiveColor ( const QColor &  c)
virtual
static DtTMMiniMap* DtTMMiniMap::create ( QWidget parent,
const Qt::WindowFlags &  f 
)
static

Returns a newly created instance of a DtTMMiniMap.

Reimplemented in DtTerrainMiniMap.

void DtTMMiniMap::activeRubberBandSet ( const DtTMRubberBand )
signal

Indicates that the active rubber band has been changed.

virtual void DtTMMiniMap::setActiveRubberBand ( DtTMRubberBand )
virtualslot

Slot to set the active rubber band.

virtual void DtTMMiniMap::removeRubberBand ( QObject )
virtualslot

Its a qobject only for signal/slot matching..

virtual void DtTMMiniMap::drawRubberBands ( QPainter *  p)
virtualslot
DtTMMiniMap& DtTMMiniMap::operator= ( const DtTMMiniMap orig)
protected

Not implemented.

virtual void DtTMMiniMap::mouseReleaseEvent ( QMouseEvent *  e)
protectedvirtual

Override parent implementation.

virtual void DtTMMiniMap::mousePressEvent ( QMouseEvent *  e)
protectedvirtual
virtual void DtTMMiniMap::mouseMoveEvent ( QMouseEvent *  e)
protectedvirtual
virtual void DtTMMiniMap::resizeEvent ( QResizeEvent *  e)
protectedvirtual

Resize event.

Reimplemented from DtTMArea.

virtual void DtTMMiniMap::clipPoint ( QPoint &  point)
protectedvirtual

Protected member functions.

virtual void DtTMMiniMap::clipRect ( QRect &  rect)
protectedvirtual
virtual void DtTMMiniMap::reorderRectangle ( QRect &  rect)
protectedvirtual
virtual void DtTMMiniMap::resizeRectToFitAspectRatio ( QRect &  r,
const double &  ratio 
)
protectedvirtual
virtual bool DtTMMiniMap::needsDrawOrder ( ) const
protectedvirtual

Mini maps do not care about draw ordering, so return false.

Reimplemented from DtTMArea.

Member Data Documentation

QPen DtTMMiniMap::myActivePen
protected
QPen DtTMMiniMap::myInactivePen
protected
DtTMRubberBandList DtTMMiniMap::myTMRubberBandList
protected
DtTMRubberBand* DtTMMiniMap::myActiveRubberBand
protected
QRect DtTMMiniMap::mySelectionRect
protected
bool DtTMMiniMap::myShowingRubberBands
protected
bool DtTMMiniMap::myTracking
protected

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)