makVrf::DtGuiEventProcessor Class Reference

The Gui Event Processor will process certain events that pertain to the VRF Gui, most notably terrain zoom and box selection. More...

Inheritance diagram for makVrf::DtGuiEventProcessor:

Public Member Functions
	DtGuiEventProcessor (makVrv::DtDe &de)
	CTOR.
virtual	~DtGuiEventProcessor ()
	DTOR.
virtual void	setBlockKeyboardEvents (bool)
	If true block any keyboard event from being processed.
virtual bool	blockKeyboardEvents () const
virtual bool	processMouseEvent (const makVrv::DtMouseEvent &ev, makVrv::DtChannel &channel)
	Processes a mouse event on the channel.
virtual bool	processKeyboardEvent (const makVrv::DtKeyEvent &ev, makVrv::DtChannel &channel)
	Processes a keyboard event on the channel.
virtual const std::string &	className ()
	Returns the name of the processor class, to be used for identifying an event processor.
virtual void	setCurrentMousePosition (makVrv::DtDe &, int x, int y)
virtual void	setCurrentMousePosition (int x, int y)
virtual void	getCurrentMousePosition (int &x, int &y) const
virtual void	setMousePositionProvider (DtMousePositionProvider *)
	Accessor for mouse position provider.
virtual DtMousePositionProvider *	mousePositionProvider ()
virtual bool	setFreezeMousePosition (bool)
	Sets the mouse position to what it currently is and will not allow changing.
virtual bool	mousePositionFrozen () const
virtual bool	isShiftKeyDown () const
	Uses mouse position provider to return current state of these keys, else returns false.
virtual bool	isControlKeyDown () const
virtual bool	isAltKeyDown () const
Public Member Functions inherited from makVrv::DtEventProcessorInterface
	DtEventProcessorInterface ()
	CTOR.
virtual	~DtEventProcessorInterface ()
	DTOR.
virtual bool	processPinchGesture (const DtPinchGesture &ev, DtChannel &channel)
	Don't require a handler for pinch gestures, but make them available.
virtual void	setEnabled (bool b)
	Get/set enabled flag.
bool	enabled () const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtGuiEventProcessor &	instance (makVrv::DtDe &de)
	Returns instance of the processor.
static void	registerInstance (makVrv::DtDe &, DtGuiEventProcessor *)

Protected Member Functions
virtual void	cleanupBox ()
	Cleanup up box and removes from scene.
virtual void	createBox (makVrv::DtChannel &channel)
	Creates box to show selection/zoom area.
virtual void	setBoxFromExtents (makVrv::DtChannel &channel, int anchorX, int anchorY, int toX, int toY)
	Intersects terrain to get database positions to set box from.

Protected Attributes
makVrv::DtDe &	myDe
makVrv::DtOutlinedPolygon *	myBox
makVrv::DtUniqueID	myLineId
DtMousePositionProvider *	myMousePositionProvider
makVrv::DtSelectionManager::IdSet	myCurrentSelections
bool	myFrozen
int	myInitialMousePositionX
int	myInitialMousePositionY
int	myCurrentMousePositionX
int	myCurrentMousePositionY
int	myBlockKeyboardEvents
Protected Attributes inherited from makVrv::DtEventProcessorInterface
bool	myEnabled

Detailed Description

The Gui Event Processor will process certain events that pertain to the VRF Gui, most notably terrain zoom and box selection.

Constructor & Destructor Documentation

makVrf::DtGuiEventProcessor::DtGuiEventProcessor

(

makVrv::DtDe &

de

)

CTOR.

virtual makVrf::DtGuiEventProcessor::~DtGuiEventProcessor ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtGuiEventProcessor::setBlockKeyboardEvents ( bool  )

virtual

If true block any keyboard event from being processed.

Will increase/decrease counter so make sure to unblock for each block

virtual bool makVrf::DtGuiEventProcessor::blockKeyboardEvents ( ) const

virtual

virtual bool makVrf::DtGuiEventProcessor::processMouseEvent ( const makVrv::DtMouseEvent &  ev, makVrv::DtChannel &  channel  )

virtual

Processes a mouse event on the channel.

Will return true if processes event, else return false.

Implements makVrv::DtEventProcessorInterface.

virtual bool makVrf::DtGuiEventProcessor::processKeyboardEvent ( const makVrv::DtKeyEvent &  ev, makVrv::DtChannel &  channel  )

virtual

Processes a keyboard event on the channel.

Should return true if the event is handled successfully, and false to reject it and pass it on to the next event processor.

Implements makVrv::DtEventProcessorInterface.

virtual const std::string& makVrf::DtGuiEventProcessor::className ( )

virtual

Returns the name of the processor class, to be used for identifying an event processor.

Implements makVrv::DtEventProcessorInterface.

virtual void makVrf::DtGuiEventProcessor::setCurrentMousePosition ( makVrv::DtDe &  , int  x, int  y  )

virtual

virtual void makVrf::DtGuiEventProcessor::setCurrentMousePosition ( int  x, int  y  )

virtual

virtual void makVrf::DtGuiEventProcessor::getCurrentMousePosition ( int &  x, int &  y  ) const

virtual

virtual void makVrf::DtGuiEventProcessor::setMousePositionProvider ( DtMousePositionProvider *  )

virtual

Accessor for mouse position provider.

virtual DtMousePositionProvider* makVrf::DtGuiEventProcessor::mousePositionProvider ( )

virtual

static DtGuiEventProcessor& makVrf::DtGuiEventProcessor::instance ( makVrv::DtDe &  de )

static

Returns instance of the processor.

static void makVrf::DtGuiEventProcessor::registerInstance ( makVrv::DtDe &  , DtGuiEventProcessor *    )

static

virtual bool makVrf::DtGuiEventProcessor::setFreezeMousePosition ( bool  )

virtual

Sets the mouse position to what it currently is and will not allow changing.

virtual bool makVrf::DtGuiEventProcessor::mousePositionFrozen ( ) const

virtual

virtual bool makVrf::DtGuiEventProcessor::isShiftKeyDown ( ) const

virtual

Uses mouse position provider to return current state of these keys, else returns false.

virtual bool makVrf::DtGuiEventProcessor::isControlKeyDown ( ) const

virtual

virtual bool makVrf::DtGuiEventProcessor::isAltKeyDown ( ) const

virtual

virtual void makVrf::DtGuiEventProcessor::cleanupBox ( )

protectedvirtual

Cleanup up box and removes from scene.

virtual void makVrf::DtGuiEventProcessor::createBox ( makVrv::DtChannel &  channel )

protectedvirtual

Creates box to show selection/zoom area.

virtual void makVrf::DtGuiEventProcessor::setBoxFromExtents ( makVrv::DtChannel &  channel, int  anchorX, int  anchorY, int  toX, int  toY  )

protectedvirtual

Intersects terrain to get database positions to set box from.

Member Data Documentation

makVrv::DtDe& makVrf::DtGuiEventProcessor::myDe

protected

makVrv::DtOutlinedPolygon* makVrf::DtGuiEventProcessor::myBox

protected

makVrv::DtUniqueID makVrf::DtGuiEventProcessor::myLineId

protected

DtMousePositionProvider* makVrf::DtGuiEventProcessor::myMousePositionProvider

protected

makVrv::DtSelectionManager::IdSet makVrf::DtGuiEventProcessor::myCurrentSelections

protected

bool makVrf::DtGuiEventProcessor::myFrozen

protected

int makVrf::DtGuiEventProcessor::myInitialMousePositionX

protected

int makVrf::DtGuiEventProcessor::myInitialMousePositionY

protected

int makVrf::DtGuiEventProcessor::myCurrentMousePositionX

protected

int makVrf::DtGuiEventProcessor::myCurrentMousePositionY

protected

int makVrf::DtGuiEventProcessor::myBlockKeyboardEvents

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/guiEventProcessor.h