ezEngine Release 26.9
Loading...
Searching...
No Matches
ezInputDeviceMouseKeyboard_NoImpl Class Reference
Inheritance diagram for ezInputDeviceMouseKeyboard_NoImpl:

Public Member Functions

 ezInputDeviceMouseKeyboard_NoImpl (ezUInt32 uiWindowNumber)
 
- Public Member Functions inherited from ezInputDeviceMouseKeyboard
void SetShowMouseCursor (bool bShow)
 
bool GetShowMouseCursor () const
 
virtual ezUInt32 GetHardwareCursorSize () const
 
void SetClipMouseCursor (ezMouseCursorClipMode::Enum mode)
 
ezMouseCursorClipMode::Enum GetClipMouseCursor () const
 
virtual void SetDisableOSHotkeys (bool bDisable)
 
bool GetDisableOSHotkeys () const
 Returns whether OS hotkey suppression is currently requested.
 
virtual void SetMouseSpeed (const ezVec2 &vScale)
 Sets the scaling factor that is applied on all (relative) mouse input.
 
ezVec2 GetMouseSpeed () const
 Returns the scaling factor that is applied on all (relative) mouse input.
 
bool IsMouseOver () const
 Returns the number of the ezWindow over which the mouse moved last.
 
bool IsFocused ()
 Returns if the associated ezWindow has focus.
 
ezVec2 GetLocalMouseCoordinates () const
 
- Public Member Functions inherited from ezInputDevice
 ezInputDevice ()
 Default Constructor.
 
float GetInputSlotState (ezStringView sSlot) const
 Allows to query current input values for the given slot.
 
bool HasDeviceBeenUsedLastFrame () const
 Returns true, if the device was 'used' during the last frame, ie. when it generated input due to some user interaction.
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Private Member Functions

virtual void ApplyShowMouseCursor (bool bShow, bool bCustomCursorActive) override
 
virtual void ApplyClipMouseCursor (ezMouseCursorClipMode::Enum mode) override
 Platform implementation of confining the OS cursor.
 
virtual void InitializeDevice () override
 Override this if you need to do device specific initialization before the first use.
 
virtual void RegisterInputSlots () override
 Override this to register all the input slots that this device exposes.
 

Additional Inherited Members

- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 
- Protected Member Functions inherited from ezInputDeviceMouseKeyboard
virtual void UpdateInputSlotValues () override
 Override this, if you need to query the state of the hardware to update the input slots.
 
void UpdateEffectiveMouseCursorState ()
 
- Protected Member Functions inherited from ezInputDevice
virtual void ResetInputSlotValues ()
 Override this, if you need to reset certain input slot values to zero, after the ezInputManager is finished with the current frame update.
 
virtual void UpdateHardwareState (ezTime tTimeDifference)
 This function is called once after ezInputManager::Update with the same time delta value. It allows to update hardware state, such as the vibration of gamepad motors.
 
- Static Protected Member Functions inherited from ezInputDevice
static void RegisterInputSlot (ezStringView sName, ezStringView sDefaultDisplayName, ezBitflags< ezInputSlotFlags > SlotFlags)
 Calls RegisterInputSlot() on the ezInputManager and passes the parameters through.
 
- Protected Attributes inherited from ezInputDeviceMouseKeyboard
ezTime m_DoubleClickTime = ezTime::MakeFromMilliseconds(500)
 
ezVec2 m_vLocalMouseCoordinates = ezVec2(0.0f)
 
bool m_bDisableOSHotkeys = false
 
bool m_bShowMouseCursorDesired = true
 
ezMouseCursorClipMode::Enum m_ClipModeDesired = ezMouseCursorClipMode::NoClip
 
bool m_bShowMouseCursorEffective = true
 
ezMouseCursorClipMode::Enum m_ClipModeEffective = ezMouseCursorClipMode::NoClip
 
- Protected Attributes inherited from ezInputDevice
bool m_bOverridesAbsoluteInput = false
 Whether this device is authoritative for absolute-value slots (a position, not a delta) it writes, such as the mouse position - see ezInputManager::GatherDeviceInputSlotValues().
 
ezMap< ezString, float > m_InputSlotValues
 Stores all the values for all input slots that this device handles.
 
ezStringBuilder m_sLastCharacters
 If this input device type handles character input, append every typed character (Unicode codepoint) it receives to this, one Append() call per character event. Append rather than overwrite, so several characters typed within one frame - which happens whenever the OS delivers input faster than the game updates - are all preserved instead of all but the last being silently dropped. The ezInputManager calls RetrieveLastCharacters() to query what the user typed since the last update.
 
- Protected Attributes inherited from ezEnumerable< ezInputDevice, ezReflectedClass >
ezEnumerablem_pNextInstance
 
- Static Protected Attributes inherited from ezInputDeviceMouseKeyboard
static ezInputDevices_pMouseOver = nullptr
 

Member Function Documentation

◆ ApplyClipMouseCursor()

void ezInputDeviceMouseKeyboard_NoImpl::ApplyClipMouseCursor ( ezMouseCursorClipMode::Enum  mode)
overrideprivatevirtual

Platform implementation of confining the OS cursor.

See also
ApplyShowMouseCursor()

Implements ezInputDeviceMouseKeyboard.

◆ ApplyShowMouseCursor()

void ezInputDeviceMouseKeyboard_NoImpl::ApplyShowMouseCursor ( bool  bShow,
bool  bCustomCursorActive 
)
overrideprivatevirtual

Platform implementation of showing / hiding the OS cursor.

Called by the base class only, and only when the effective state actually changed, so implementations don't need to filter out redundant calls themselves.

Parameters
bShowThe state to apply.
bCustomCursorActiveWhether the cursor is hidden because a custom ('software') cursor is drawn instead. In that case the mouse must keep reporting absolute in-window positions, ie. the cursor may be hidden, but must not be captured.

Implements ezInputDeviceMouseKeyboard.

◆ InitializeDevice()

void ezInputDeviceMouseKeyboard_NoImpl::InitializeDevice ( )
overrideprivatevirtual

Override this if you need to do device specific initialization before the first use.

Implements ezInputDevice.

◆ RegisterInputSlots()

void ezInputDeviceMouseKeyboard_NoImpl::RegisterInputSlots ( )
overrideprivatevirtual

Override this to register all the input slots that this device exposes.

This is called once during initialization. It needs to call RegisterInputSlot() once for every input slot that this device exposes to the system.

Implements ezInputDevice.


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