DtCompassHandler Class Reference

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

Inheritance diagram for DtCompassHandler:

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 Slots inherited from DtEventHandler
virtual bool	mouseEvent (DtTMMapArea *, QMouseEvent *evnt, const DtPoint &pnt)
virtual bool	keyboardEvent (DtTMMapArea *, QKeyEvent *evnt)
virtual bool	symbolsSelected (DtTMMapArea *area, DtSymbolList *sl)
virtual bool	selectionUpdated (DtTMMapArea *area, const QVector< DtModelKey > &d)
virtual bool	selectionInProgress (DtTMMapArea *area, DtSymbolSelector &d)
virtual bool	focusEvent (DtTMMapArea *, QEvent *evnt)
virtual bool	enterEvent (DtTMMapArea *area, QEvent *evnt)
virtual bool	leaveEvent (DtTMMapArea *area, QEvent *evnt)
virtual bool	dropEvent (DtTMMapArea *area, QDropEvent *evnt)
virtual bool	dragEnterEvent (DtTMMapArea *area, QDragEnterEvent *evnt)
virtual bool	dragMoveEvent (DtTMMapArea *area, QDragMoveEvent *evnt)
virtual bool	dragLeaveEvent (DtTMMapArea *area, QDragLeaveEvent *evnt)
virtual bool	userDefinedAction (DtUserDefinedType iAction, void *usr)
virtual bool	aboutToDraw (DtTMMapArea *area, QPainter *)
virtual bool	mapActivated (DtTMMapArea *area)
virtual bool	selectedModelDataUpdated (DtTMMapArea *area)
virtual bool	symbolAdded (DtTMMapArea *area, const DtModelKey &)
virtual bool	symbolRemoved (DtTMMapArea *area, const DtModelKey &)
virtual void	tick ()
virtual void	clearDialog ()

Public Member Functions
	DtCompassHandler ()
	Default Constructor.
virtual	~DtCompassHandler ()
	Destructor.
Public Member Functions inherited from DtEventHandler
	DtEventHandler ()
	Default Constructor.
virtual	~DtEventHandler ()
	Destructor.
virtual void	setEventController (DtEventController *)
virtual void	setInitialSelection (const QVector< DtModelKey > &d)
virtual void	showDialog (bool b)
virtual QWidget *	createDialog (QWidget *w)
	Creates the dialog associated with this handler (if there is one)
virtual QWidget *	dialog (bool createIfMissing=true, QWidget *parent=NULL)
	If createIfMissing is true, will create the dialog based on the supplied parent window, else will simply return the dialog pointer.
virtual void	reset ()
virtual DtBaseWindow *	baseWindow () const
	Returns the base window of the event controller.
virtual void	activate ()
	Called when this event handler first becomes active.
virtual void	deactivate ()
	Called when this event handler is removed as the current event.
virtual void	setBaseWindow (DtBaseWindow *w)
	Called when the base window is set for the event controller.
virtual void	init ()
	Called when the handler is first created, initialize context.
void	setSuspended (bool)
	Set when something wants to suspend some aspect of this handler without deactivating it.
bool	suspended () const
virtual void	dialogDestroyedEvent ()
	Called when dialog is destroyed.
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	read (QTextStream &s)
	Reads/writes archiver.
virtual void	write (QTextStream &s)
virtual void	setLevel (int i)
virtual int	level () const
virtual DtArchivableObject *	clone ()
	Allows for cloning of this object.

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.

Additional Inherited Members
Signals inherited from DtEventHandler
void	closedDialog ()
Protected Attributes inherited from DtEventHandler
QWidget *	myEventDlg
DtEventController *	myEventController
bool	mySuspended

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

DtCompassHandler::DtCompassHandler

(

)

Default Constructor.

virtual DtCompassHandler::~DtCompassHandler ( )

virtual

Destructor.

Member Function Documentation

virtual void DtCompassHandler::setPosition ( int  )

virtualslot

Sets position on the screen relative to the position.

virtual void DtCompassHandler::showMapCompass ( bool  b )

virtualslot

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

virtual void DtCompassHandler::setTerrainDatabase ( const DtTerrainDatabase *  )

protectedvirtualslot

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 *  )

protectedvirtualslot

virtual DtEntityMapperKey DtCompassHandler::compassMapperKey ( ) const

protectedvirtual

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

virtual DtCompassModelData* DtCompassHandler::createCompassData ( DtTMMapArea *  ) const

protectedvirtual

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

virtual DtCompassModelData* DtCompassHandler::createCompassModelData ( ) const

protectedvirtual

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

virtual bool DtCompassHandler::connecting ( DtTMMapArea *  area )

protectedvirtual

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

Reimplemented from DtEventHandler.

virtual bool DtCompassHandler::disconnecting ( DtTMMapArea *  area )

protectedvirtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/terrainEventHandler/compassHandler.h