VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
makVrv::DtMouseHideProcessor Class Reference

DtMouseHideProcessor tracks mouse move events and when they happen. More...

Public Member Functions

 DtMouseHideProcessor (DtInputDriver &inputDriver, DtDe &de)
 CTOR.
virtual ~DtMouseHideProcessor ()
 DTOR.
virtual void processMouseMoveEvent (const DtMouseEvent &ev, DtChannel &channel)
 Processes a mouse event on the channel.
virtual void slot_fullScreenToggle (DtWindow *window, bool fullScreen)
 This method is attached to the signal_fullScreenModeChanged for every local DtWindow.
virtual void setMouseHideTime (float hideTime)
 Set/get the number of seconds a mouse should not move before hiding it.
virtual float mouseHideTime () const
virtual void setMouseHideEnabled (bool enabled)
 Set/get whether mouse hiding is enabled.
virtual bool mouseHideEnabled () const

Protected Types

typedef boost::unordered_map
< const DtWindow
*, boost::signalslib::connection * > 
WindowDataMap

Protected Member Functions

virtual void slot_channelToBeDestroyed (DtChannel *channel)
 Attached to DtChannelManagerSignaler::signal_channelToBeDestroyed Cleans up if the channel being deleted is one we have cached a pointer to for restoring a mouse.
virtual void slot_windowCreated (DtWindow *window)
 Attached to DtWindowManagerSignaler so we can attach to DtWindow::signal_fullScreenModeChanged signals.
virtual void slot_windowToBeDestroyed (DtWindow *window)
 Attached to DtWindowManagerSignaler so we can detach from DtWindow::signal_fullScreenModeChanged signals.
virtual void slot_preTick ()
 Attached to DtDe::signal_preTick This tracks the time since the last mouse move event.
virtual void clearState ()
 Clear any pending values (like pointers to channels when current window or channel is destroyed or enable state changes.
virtual void showMouse ()
 Internal show/hide calls.
virtual void hideMouse ()

Protected Attributes

DtDemyDe
double myLastMouseMoveTime
double myMouseHideTime
bool myMouseHideEnabled
DtInputDrivermyInputDriver
bool myMouseHidden
DtChannelmyLastMouseChannel
const DtWindowmyLastMouseWindow
int myLastMouseX
int myLastMouseY
DtSignalConnectionManager myConnections
WindowDataMap myWindowDataMap

Private Member Functions

 DtMouseHideProcessor ()
 Default constructor (unimplemented)
 DtMouseHideProcessor (const DtMouseHideProcessor *orig)
 Copy Constructor (unimplemented)
DtMouseHideProcessoroperator= (const DtMouseHideProcessor *orig)
 Assignment operator (unimplemented)

Detailed Description

DtMouseHideProcessor tracks mouse move events and when they happen.

If a mouse move event does not happen within a certain time period, the processor will request that the mouse be hidden. Any mouse move event while the mouse is hidden will result in a request to show the mouse.

Member Typedef Documentation

typedef boost::unordered_map<const DtWindow*, boost::signalslib::connection*> makVrv::DtMouseHideProcessor::WindowDataMap
protected

Constructor & Destructor Documentation

makVrv::DtMouseHideProcessor::DtMouseHideProcessor ( DtInputDriver inputDriver,
DtDe de 
)

CTOR.

virtual makVrv::DtMouseHideProcessor::~DtMouseHideProcessor ( )
virtual

DTOR.

makVrv::DtMouseHideProcessor::DtMouseHideProcessor ( )
private

Default constructor (unimplemented)

makVrv::DtMouseHideProcessor::DtMouseHideProcessor ( const DtMouseHideProcessor orig)
private

Copy Constructor (unimplemented)

Member Function Documentation

virtual void makVrv::DtMouseHideProcessor::processMouseMoveEvent ( const DtMouseEvent ev,
DtChannel channel 
)
virtual

Processes a mouse event on the channel.

Makes note of the sim time if it's a mouse move event

virtual void makVrv::DtMouseHideProcessor::setMouseHideTime ( float  hideTime)
virtual

Set/get the number of seconds a mouse should not move before hiding it.

virtual float makVrv::DtMouseHideProcessor::mouseHideTime ( ) const
virtual
virtual void makVrv::DtMouseHideProcessor::setMouseHideEnabled ( bool  enabled)
virtual

Set/get whether mouse hiding is enabled.

virtual bool makVrv::DtMouseHideProcessor::mouseHideEnabled ( ) const
virtual
virtual void makVrv::DtMouseHideProcessor::slot_fullScreenToggle ( DtWindow window,
bool  fullScreen 
)
virtual

This method is attached to the signal_fullScreenModeChanged for every local DtWindow.

virtual void makVrv::DtMouseHideProcessor::slot_channelToBeDestroyed ( DtChannel channel)
protectedvirtual

Attached to DtChannelManagerSignaler::signal_channelToBeDestroyed Cleans up if the channel being deleted is one we have cached a pointer to for restoring a mouse.

virtual void makVrv::DtMouseHideProcessor::slot_windowCreated ( DtWindow window)
protectedvirtual

Attached to DtWindowManagerSignaler so we can attach to DtWindow::signal_fullScreenModeChanged signals.

virtual void makVrv::DtMouseHideProcessor::slot_windowToBeDestroyed ( DtWindow window)
protectedvirtual

Attached to DtWindowManagerSignaler so we can detach from DtWindow::signal_fullScreenModeChanged signals.

virtual void makVrv::DtMouseHideProcessor::slot_preTick ( )
protectedvirtual

Attached to DtDe::signal_preTick This tracks the time since the last mouse move event.

virtual void makVrv::DtMouseHideProcessor::clearState ( )
protectedvirtual

Clear any pending values (like pointers to channels when current window or channel is destroyed or enable state changes.

virtual void makVrv::DtMouseHideProcessor::showMouse ( )
protectedvirtual

Internal show/hide calls.

virtual void makVrv::DtMouseHideProcessor::hideMouse ( )
protectedvirtual
DtMouseHideProcessor& makVrv::DtMouseHideProcessor::operator= ( const DtMouseHideProcessor orig)
private

Assignment operator (unimplemented)

Member Data Documentation

DtDe& makVrv::DtMouseHideProcessor::myDe
protected
double makVrv::DtMouseHideProcessor::myLastMouseMoveTime
protected
double makVrv::DtMouseHideProcessor::myMouseHideTime
protected
bool makVrv::DtMouseHideProcessor::myMouseHideEnabled
protected
DtInputDriver& makVrv::DtMouseHideProcessor::myInputDriver
protected
bool makVrv::DtMouseHideProcessor::myMouseHidden
protected
DtChannel* makVrv::DtMouseHideProcessor::myLastMouseChannel
protected
const DtWindow* makVrv::DtMouseHideProcessor::myLastMouseWindow
protected
int makVrv::DtMouseHideProcessor::myLastMouseX
protected
int makVrv::DtMouseHideProcessor::myLastMouseY
protected
DtSignalConnectionManager makVrv::DtMouseHideProcessor::myConnections
protected
WindowDataMap makVrv::DtMouseHideProcessor::myWindowDataMap
protected

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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)