spk::MouseMotionTrigger Class Reference

Trigger that fires on mouse motion. More...

#include <spk_input_trigger.hpp>

Inheritance diagram for spk::MouseMotionTrigger:

Collaboration diagram for spk::MouseMotionTrigger:

Public Types
enum class	Mode { Absolute , Delta }
	Mouse motion mode to report.

Public Member Functions
	MouseMotionTrigger (Mode p_mode, const std::function< void(const spk::Vector2Int &)> &p_callback)
	Creates a mouse motion trigger.
bool	isInitialized () const override
	Reports whether the trigger is initialized.
void	initialize (spk::UpdateEvent &p_event) override
	Initializes the trigger by extracting the mouse from an update event.
const spk::Mouse *	mouse () const
	Returns the assigned mouse.
void	setMouse (const spk::Mouse *p_mouse)
	Manually sets the mouse.
void	update () override
	Updates the trigger and fires the callback.
Public Member Functions inherited from spk::InputTrigger
virtual	~InputTrigger ()=default
	Virtual destructor.

Detailed Description

Trigger that fires on mouse motion.

Constructor & Destructor Documentation

MouseMotionTrigger()

spk::MouseMotionTrigger::MouseMotionTrigger ( Mode p_mode, const std::function< void(const spk::Vector2Int &)> & p_callback )

inline

Creates a mouse motion trigger.

Parameters

p_mode	Motion mode (absolute or delta).
p_callback	Callback invoked with mouse motion.

Member Function Documentation

initialize()

void spk::MouseMotionTrigger::initialize ( spk::UpdateEvent & p_event )

inlineoverridevirtual

Initializes the trigger by extracting the mouse from an update event.

Parameters

p_event

Update event providing device references.

Implements spk::InputTrigger.

isInitialized()

bool spk::MouseMotionTrigger::isInitialized ( ) const

inlineoverridevirtual

Reports whether the trigger is initialized.

Returns

True if a mouse is assigned.

Implements spk::InputTrigger.

mouse()

const spk::Mouse * spk::MouseMotionTrigger::mouse ( ) const

inline

Returns the assigned mouse.

Returns

Mouse pointer or nullptr.

setMouse()

void spk::MouseMotionTrigger::setMouse ( const spk::Mouse * p_mouse )

inline

Manually sets the mouse.

Parameters

p_mouse

Mouse pointer.

update()

void spk::MouseMotionTrigger::update ( )

inlineoverridevirtual

Updates the trigger and fires the callback.

Implements spk::InputTrigger.

---

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

• includes/structure/engine/spk_input_trigger.hpp