Base class for platform specific implementations of mouse input devices.
More...
#include <InputDeviceMouse.h>
Inherited by AzFramework::XcbInputDeviceMouse.
Base class for platform specific implementations of mouse input devices.
◆ RawButtonEventQueueByIdMap
Alias for verbose container class
◆ Implementation()
AzFramework::InputDeviceMouse::Implementation::Implementation |
( |
InputDeviceMouse & |
inputDevice | ) |
|
Constructor
- Parameters
-
[in] | inputDevice | Reference to the input device being implemented |
◆ Create()
Default factory create function
- Parameters
-
[in] | inputDevice | Reference to the input device being implemented |
◆ GetSystemCursorPositionNormalized()
virtual AZ::Vector2 AzFramework::InputDeviceMouse::Implementation::GetSystemCursorPositionNormalized |
( |
| ) |
const |
|
pure virtual |
Get the current system cursor position normalized relative to the active window. The position obtained has had os ballistics applied, and is valid regardless of whether the system cursor is hidden or visible. When the cursor has been constrained to the active window the values will be in the [0.0, 1.0] range, but not when unconstrained. See also InputSystemCursorRequests::SetSystemCursorState and GetSystemCursorState.
- Returns
- The current system cursor position normalized relative to the active window
Implemented in AzFramework::XcbInputDeviceMouse.
◆ GetSystemCursorState()
virtual SystemCursorState AzFramework::InputDeviceMouse::Implementation::GetSystemCursorState |
( |
| ) |
const |
|
pure virtual |
◆ IsConnected()
virtual bool AzFramework::InputDeviceMouse::Implementation::IsConnected |
( |
| ) |
const |
|
pure virtual |
Query the connected state of the input device
- Returns
- True if the input device is currently connected, false otherwise
Implemented in AzFramework::XcbInputDeviceMouse.
◆ ProcessRawEventQueues()
void AzFramework::InputDeviceMouse::Implementation::ProcessRawEventQueues |
( |
| ) |
|
|
protected |
Process raw input events that have been queued since the last call to this function. This function is not thread safe, and so should only be called from the main thread.
◆ QueueRawButtonEvent()
void AzFramework::InputDeviceMouse::Implementation::QueueRawButtonEvent |
( |
const InputChannelId & |
inputChannelId, |
|
|
bool |
rawButtonState |
|
) |
| |
|
protected |
Queue raw button events to be processed in the next call to ProcessRawEventQueues. This function is not thread safe and so should only be called from the main thread.
- Parameters
-
[in] | inputChannelId | The input channel id |
[in] | rawButtonState | The raw button state |
◆ QueueRawMovementEvent()
void AzFramework::InputDeviceMouse::Implementation::QueueRawMovementEvent |
( |
const InputChannelId & |
inputChannelId, |
|
|
float |
rawMovementDelta |
|
) |
| |
|
protected |
Queue raw movement events to be processed in the next call to ProcessRawEventQueues. This function is not thread safe and so should only be called from the main thread.
- Parameters
-
[in] | inputChannelId | The input channel id |
[in] | rawMovementDelta | The raw movement delta |
◆ SetRawMovementSampleRate()
void AzFramework::InputDeviceMouse::Implementation::SetRawMovementSampleRate |
( |
AZ::u32 |
sampleRateHertz | ) |
|
Set the sample rate for raw mouse movement events
- Parameters
-
[in] | sampleRateHertz | The raw movement sample rate in Hertz (cycles per second) |
◆ SetSystemCursorPositionNormalized()
virtual void AzFramework::InputDeviceMouse::Implementation::SetSystemCursorPositionNormalized |
( |
AZ::Vector2 |
positionNormalized | ) |
|
|
pure virtual |
Attempt to set the system cursor position normalized relative to the active window
- Parameters
-
[in] | positionNormalized | The desired system cursor position normalized |
Implemented in AzFramework::XcbInputDeviceMouse.
◆ SetSystemCursorState()
virtual void AzFramework::InputDeviceMouse::Implementation::SetSystemCursorState |
( |
SystemCursorState |
systemCursorState | ) |
|
|
pure virtual |
◆ TickInputDevice()
virtual void AzFramework::InputDeviceMouse::Implementation::TickInputDevice |
( |
| ) |
|
|
pure virtual |
The documentation for this class was generated from the following file:
- Code/Framework/AzFramework/AzFramework/Input/Devices/Mouse/InputDeviceMouse.h