CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::DummyInputProvider Class Referencefinal

#include <CeresEngine/Input/Provider/DummyInputProvider.hpp>

Inheritance diagram for CeresEngine::DummyInputProvider:
CeresEngine::InputProvider

Public Member Functions

 DummyInputProvider ()
 Create a new DummyInputProvider.
 
 ~DummyInputProvider () final
 Destroys the DummyInputProvider.
 
Vector< AnyInputEventgetEvents () final
 A set of events that have been triggered since the last call to getEvents.
 
void setCursorMode (CursorMode mode) final
 Sets the cursor mode.
 
CursorMode getCursorMode () const
 
void pushEvent (const AnyInputEvent &event)
 Pushes a new event to the provider.
 
void buttonDown (Button button)
 
void buttonUp (Button button)
 
void moveCursor (Vector2 position)
 
void mouseScroll (Vector2 position)
 
- Public Member Functions inherited from CeresEngine::InputProvider
virtual ~InputProvider ()=default
 Defaulted virtual destructor.
 

Private Attributes

Vector< AnyInputEventmEvents
 A set of events that have been triggered since the last call to getEvents.
 
CursorMode mCursorMode = CursorMode::Normal
 

Constructor & Destructor Documentation

◆ DummyInputProvider()

CeresEngine::DummyInputProvider::DummyInputProvider ( )
explicit

Create a new DummyInputProvider.

◆ ~DummyInputProvider()

CeresEngine::DummyInputProvider::~DummyInputProvider ( )
final

Destroys the DummyInputProvider.

Member Function Documentation

◆ buttonDown()

void CeresEngine::DummyInputProvider::buttonDown ( Button  button)

◆ buttonUp()

void CeresEngine::DummyInputProvider::buttonUp ( Button  button)

◆ getCursorMode()

CursorMode CeresEngine::DummyInputProvider::getCursorMode ( ) const
inline

◆ getEvents()

Vector< AnyInputEvent > CeresEngine::DummyInputProvider::getEvents ( )
finalvirtual

A set of events that have been triggered since the last call to getEvents.

The order is guaranteed to be in the order as they came in from the system.

Implements CeresEngine::InputProvider.

◆ mouseScroll()

void CeresEngine::DummyInputProvider::mouseScroll ( Vector2  position)

◆ moveCursor()

void CeresEngine::DummyInputProvider::moveCursor ( Vector2  position)

◆ pushEvent()

void CeresEngine::DummyInputProvider::pushEvent ( const AnyInputEvent event)

Pushes a new event to the provider.

This can be used to insert events into the dummy input provider event queue.

Parameters
eventThe event to be pushed to the event queue.

◆ setCursorMode()

void CeresEngine::DummyInputProvider::setCursorMode ( CursorMode  mode)
finalvirtual

Sets the cursor mode.

Parameters
modeThe cursor mode to be set

Implements CeresEngine::InputProvider.

Member Data Documentation

◆ mCursorMode

CursorMode CeresEngine::DummyInputProvider::mCursorMode = CursorMode::Normal
private

◆ mEvents

Vector<AnyInputEvent> CeresEngine::DummyInputProvider::mEvents
private

A set of events that have been triggered since the last call to getEvents.

The order is guaranteed to be in the order as they came in from the system.


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