Fast3D-specific mouse-state manager. More...

Inheritance diagram for Fast::FastMouseStateManager:

Collaboration diagram for Fast::FastMouseStateManager:

Public Member Functions
void	ResetCursorVisibilityTimer () override
	Resets the cursor visibility timeout counter to its configured value.

void	SetCursorVisibilityTime (uint32_t seconds)

uint32_t	GetCursorVisibilityTime ()

Public Member Functions inherited from Ship::MouseStateManager
	MouseStateManager ()
	Constructs a MouseStateManager with default settings.

virtual	~MouseStateManager ()
	Virtual destructor.

void	SetWindow (std::shared_ptr< Window > window)
	Caches the Window dependency.

virtual void	StartFrame ()
	Called at the beginning of each frame to update cursor visibility and capture state.

virtual bool	ShouldAutoCaptureMouse ()
	Checks whether the mouse should be automatically captured by the window.

virtual void	SetAutoCaptureMouse (bool capture)
	Enables or disables automatic mouse capture.

virtual bool	ShouldForceCursorVisibility ()
	Checks whether cursor visibility is being forced on.

virtual void	SetForceCursorVisibility (bool visible)
	Forces the cursor to remain visible regardless of other state.

virtual void	ToggleMouseCaptureOverride ()
	Toggles the manual mouse capture override on or off.

virtual void	UpdateMouseCapture ()
	Applies the current mouse capture settings to the underlying window system.

void	SetCursorVisibilityTimeTicks (uint32_t ticks)
	Sets the number of ticks before the cursor is automatically hidden.

uint32_t	GetCursorVisibilityTimeTicks ()
	Returns the configured cursor visibility timeout in ticks.

Additional Inherited Members
Protected Member Functions inherited from Ship::MouseStateManager
void	CursorVisibilityTimeoutTick ()
	Decrements the cursor visibility timeout counter by one tick.

Protected Attributes inherited from Ship::MouseStateManager
std::shared_ptr< Window >	mWindow
	Cached Window component.

Detailed Description

Fast3D-specific mouse-state manager.

Requires a Ship::Window component as a direct child of the Context so that ResetCursorVisibilityTimer() can query the target framerate.

Member Function Documentation

uint32_t Fast::FastMouseStateManager::GetCursorVisibilityTime ( )

void Fast::FastMouseStateManager::ResetCursorVisibilityTimer ( )

overridevirtual

Resets the cursor visibility timeout counter to its configured value.

void Fast::FastMouseStateManager::SetCursorVisibilityTime ( uint32_t seconds )

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