ezInputDeviceMouseKeyboard Class Reference

This is the base class for all input devices that handle mouse and keyboard input. More...

#include <MouseKeyboard.h>

Inheritance diagram for ezInputDeviceMouseKeyboard:

Public Member Functions
virtual void	SetShowMouseCursor (bool bShow)=0
	Shows or hides the mouse cursor inside the application window.
virtual bool	GetShowMouseCursor () const =0
	Returns whether the mouse cursor is shown.
virtual void	SetClipMouseCursor (ezMouseCursorClipMode::Enum mode)=0
	Will trap the mouse inside the application window. Should usually be enabled, to prevent accidental task switches. More...
virtual ezMouseCursorClipMode::Enum	GetClipMouseCursor () const =0
	Returns whether the mouse is confined to the application window or not.
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	IsFocused ()
	Returns if the associated ezWindow has focus.
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. More...
Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () 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.

Static Public Member Functions
static ezInt32	GetWindowNumberMouseIsOver ()
	Returns the number of the ezWindow over which the mouse moved last.
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Protected Member Functions
virtual void	UpdateInputSlotValues () override
	Override this, if you need to query the state of the hardware to update the input slots. More...
Protected Member Functions inherited from ezInputDevice
virtual void	InitializeDevice ()=0
	Override this if you need to do device specific initialization before the first use.
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	RegisterInputSlots ()=0
	Override this to register all the input slots that this device exposes. More...
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.

Protected Attributes
ezTime	m_DoubleClickTime = ezTime::MakeFromMilliseconds(500)
Protected Attributes inherited from ezInputDevice
ezMap< ezString, float >	m_InputSlotValues
	Stores all the values for all input slots that this device handles. More...
ezUInt32	m_uiLastCharacter
	If this input device type handles character input, it should write the last typed character into this variable. The ezInputManager calls RetrieveLastCharacter() to query what the user typed last.
Protected Attributes inherited from ezEnumerable< ezInputDevice, ezReflectedClass >
ezEnumerable *	m_pNextInstance

Static Protected Attributes
static ezInt32	s_iMouseIsOverWindowNumber = -1

Additional Inherited Members
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.

Detailed Description

This is the base class for all input devices that handle mouse and keyboard input.

This class is derived from ezInputDevice but adds interface functions to handle mouse and keyboard input.

Member Function Documentation

SetClipMouseCursor()

virtual void ezInputDeviceMouseKeyboard::SetClipMouseCursor ( ezMouseCursorClipMode::Enum  mode )

pure virtual

Will trap the mouse inside the application window. Should usually be enabled, to prevent accidental task switches.

Especially on multi-monitor systems, the mouse can easily leave the application window (even in fullscreen mode). Do NOT use this function when you have multiple windows and require absolute mouse positions.

See also

ezMouseCursorClipMode

Implemented in ezStandardInputDevice, ezStandardInputDevice, ezStandardInputDevice, and ezStandardInputDevice.

UpdateInputSlotValues()

void ezInputDeviceMouseKeyboard::UpdateInputSlotValues ( )

overrideprotectedvirtual

Override this, if you need to query the state of the hardware to update the input slots.

Note

This function might be called multiple times before ResetInputSlotValues() is called. This will be the case when ezInputManager::PollHardware is used to make more frequent hardware updates than input is actually processed. Just make sure to always accumulate delta values (such as mouse move values) and don't expect ResetInputSlotValues() to be called in tandem with this function and it will be fine.

Implements ezInputDevice.

Reimplemented in ezStandardInputDevice.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/Input/DeviceTypes/MouseKeyboard.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/Input/DeviceTypes/DeviceTypes.cpp