Viewport requests for managing the viewport cursor state. More...

#include <ViewportMessages.h>

Public Member Functions
virtual void	BeginCursorCapture ()=0
	Begins hiding the cursor and locking it in place, to prevent the cursor from escaping the viewport window.

virtual void	EndCursorCapture ()=0
	Restores the cursor and ends locking it in place, allowing it to be moved freely.

virtual void	SetCursorMode (AzToolsFramework::CursorInputMode mode)=0
	Sets the cursor input mode.

virtual bool	IsMouseOver () const =0
	Is the mouse over the viewport.

virtual void	SetOverrideCursor (CursorStyleOverride cursorStyleOverride)=0
	Set the cursor style override.

virtual void	ClearOverrideCursor ()=0
	Clear the cursor style override.

virtual AZStd::optional< AzFramework::ScreenPoint >	MousePosition () const =0
	Returns the viewport position of the cursor if a valid position exists (the cursor is over the viewport).

Detailed Description

Viewport requests for managing the viewport cursor state.

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

Code/Framework/AzToolsFramework/AzToolsFramework/Viewport/ViewportMessages.h

Public Member Functions