spk::InputTrigger Class Reference

Interface for input-triggered callbacks. More...

#include <spk_input_trigger.hpp>

Inheritance diagram for spk::InputTrigger:

Collaboration diagram for spk::InputTrigger:

Public Member Functions
virtual	~InputTrigger ()=default
	Virtual destructor.
virtual bool	isInitialized () const =0
	Reports whether the trigger is initialized.
virtual void	initialize (spk::UpdateEvent &p_event)=0
	Initializes the trigger using an update event.
virtual void	update ()=0
	Updates the trigger state.

Detailed Description

Interface for input-triggered callbacks.

Member Function Documentation

initialize()

virtual void spk::InputTrigger::initialize ( spk::UpdateEvent & p_event )

pure virtual

Initializes the trigger using an update event.

Parameters

p_event

Update event providing device references.

Implemented in spk::DeviceInputTrigger< Device, DeviceValue >, spk::DeviceInputTrigger< spk::Keyboard, spk::Keyboard::Key >, spk::DeviceInputTrigger< spk::Mouse, spk::Mouse::Button >, and spk::MouseMotionTrigger.

isInitialized()

virtual bool spk::InputTrigger::isInitialized ( ) const

pure virtual

Reports whether the trigger is initialized.

Returns

True if initialized.

Implemented in spk::DeviceInputTrigger< Device, DeviceValue >, spk::DeviceInputTrigger< spk::Keyboard, spk::Keyboard::Key >, spk::DeviceInputTrigger< spk::Mouse, spk::Mouse::Button >, and spk::MouseMotionTrigger.

update()

virtual void spk::InputTrigger::update ( )

pure virtual

Updates the trigger state.

Implemented in spk::DeviceInputTrigger< Device, DeviceValue >, spk::DeviceInputTrigger< spk::Keyboard, spk::Keyboard::Key >, spk::DeviceInputTrigger< spk::Mouse, spk::Mouse::Button >, and spk::MouseMotionTrigger.

---

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

• includes/structure/engine/spk_input_trigger.hpp