ezInputDeviceMouseKeyboard_NoImpl Class Reference

Inheritance diagram for ezInputDeviceMouseKeyboard_NoImpl:

Public Member Functions
	ezInputDeviceMouseKeyboard_NoImpl (ezUInt32 uiWindowNumber)
virtual void	SetShowMouseCursor (bool bShow) override
	Shows or hides the mouse cursor inside the application window.
virtual bool	GetShowMouseCursor () const override
	Returns whether the mouse cursor is shown.
virtual void	SetClipMouseCursor (ezMouseCursorClipMode::Enum mode) override
	Will trap the mouse inside the application window. Should usually be enabled, to prevent accidental task switches.
virtual ezMouseCursorClipMode::Enum	GetClipMouseCursor () const override
	Returns whether the mouse is confined to the application window or not.
Public Member Functions inherited from ezInputDeviceMouseKeyboard
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
	Returns the current (normalized) mouse position within the window.
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 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.

Private Member Functions
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 ezRTTI *	GetStaticRTTI ()
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.
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)
Protected Attributes inherited from ezInputDevice
ezMap< ezString, float >	m_InputSlotValues
	Stores all the values for all input slots that this device handles.
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 inherited from ezInputDeviceMouseKeyboard
static ezInputDevice *	s_pMouseOver = nullptr

Member Function Documentation

GetClipMouseCursor()

ezMouseCursorClipMode::Enum ezInputDeviceMouseKeyboard_NoImpl::GetClipMouseCursor ( ) const

overridevirtual

Returns whether the mouse is confined to the application window or not.

Implements ezInputDeviceMouseKeyboard.

GetShowMouseCursor()

bool ezInputDeviceMouseKeyboard_NoImpl::GetShowMouseCursor ( ) const

overridevirtual

Returns whether the mouse cursor is shown.

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.

SetClipMouseCursor()

void ezInputDeviceMouseKeyboard_NoImpl::SetClipMouseCursor ( ezMouseCursorClipMode::Enum  mode )

overridevirtual

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

Implements ezInputDeviceMouseKeyboard.

SetShowMouseCursor()

void ezInputDeviceMouseKeyboard_NoImpl::SetShowMouseCursor ( bool  bShow )

overridevirtual

Shows or hides the mouse cursor inside the application window.

Implements ezInputDeviceMouseKeyboard.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/Platform/NoImpl/InputDevice_NoImpl.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/Platform/NoImpl/InputDevice_NoImpl.inl