VR-Forces 4.0.4 Class Documentation
Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions
DtCompassHandler Class Reference

Handles the creation of a compass for the main map area. More...

Inheritance diagram for DtCompassHandler:
Inheritance graph
[legend]

List of all members.

Public Slots

virtual void setPosition (int)
 Sets position on the screen relative to the position.
virtual void showMapCompass (bool b)
 Shows/hides all compasses on all map areas for owner window.

Public Member Functions

 DtCompassHandler ()
 Default Constructor.
virtual ~DtCompassHandler ()
 Destructor.

Static Public Member Functions

static DtEventHandler * create (DtEventController *owner, void *usr)
 Static creator.

Protected Slots

virtual void setTerrainDatabase (const DtTerrainDatabase *)
 Called when terrain is set.
virtual void viewportExtentsChanged (const DtTMViewportExtents *)

Protected Member Functions

virtual DtEntityMapperKey compassMapperKey () const
 Key used to create compass object. Currently: -1 -1 112 0 0 0 0 0 0.
virtual DtCompassModelData * createCompassData (DtTMMapArea *) const
 Creates a compass model data and assigns it to the areas model data dictionary.
virtual DtCompassModelData * createCompassModelData () const
 Creates the base model data class to use for the compass.
virtual bool connecting (DtTMMapArea *)
 Called when a map is being connected to an event handler.
virtual bool disconnecting (DtTMMapArea *)
 Called when a map is being disconnect from an event handler.

Detailed Description

Handles the creation of a compass for the main map area.

It will only be created if the area is a main map area and there is a database opened that the compass can be placed on top of


Constructor & Destructor Documentation

Default Constructor.

virtual DtCompassHandler::~DtCompassHandler ( ) [virtual]

Destructor.


Member Function Documentation

virtual void DtCompassHandler::setPosition ( int  ) [virtual, slot]

Sets position on the screen relative to the position.

virtual void DtCompassHandler::showMapCompass ( bool  b) [virtual, slot]

Shows/hides all compasses on all map areas for owner window.

virtual void DtCompassHandler::setTerrainDatabase ( const DtTerrainDatabase *  ) [protected, virtual, slot]

Called when terrain is set.

If main map area of window does not have a compass, creates one and adds it to the local map dictionary

virtual void DtCompassHandler::viewportExtentsChanged ( const DtTMViewportExtents *  ) [protected, virtual, slot]
virtual DtEntityMapperKey DtCompassHandler::compassMapperKey ( ) const [protected, virtual]

Key used to create compass object. Currently: -1 -1 112 0 0 0 0 0 0.

virtual DtCompassModelData* DtCompassHandler::createCompassData ( DtTMMapArea *  ) const [protected, virtual]

Creates a compass model data and assigns it to the areas model data dictionary.

virtual DtCompassModelData* DtCompassHandler::createCompassModelData ( ) const [protected, virtual]

Creates the base model data class to use for the compass.

virtual bool DtCompassHandler::connecting ( DtTMMapArea *  area) [protected, virtual]

Called when a map is being connected to an event handler.

Reimplemented from DtEventHandler.

virtual bool DtCompassHandler::disconnecting ( DtTMMapArea *  area) [protected, virtual]

Called when a map is being disconnect from an event handler.

Reimplemented from DtEventHandler.

static DtEventHandler* DtCompassHandler::create ( DtEventController *  owner,
void *  usr 
) [static]

Static creator.


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)