Nymph Game Engine
Chaiscript based Game Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Input::MouseScrollEvent Class Reference

Class for mouse scroll event. More...

#include <mouse_scroll_event.h>

Inheritance diagram for Input::MouseScrollEvent:
Events::Event

Public Member Functions

 MouseScrollEvent (const glm::dvec2 &offset)
 MouseScrollEvent constructor. More...
 
glm::dvec2 getPosition () const noexcept
 Gets the position. More...
 
- Public Member Functions inherited from Events::Event
 Event (const EventType &type)
 Event constructor. More...
 
EventType getEventType () const
 Gets the event type. More...
 

Static Public Member Functions

static std::shared_ptr
< MouseScrollEvent
create (const glm::dvec2 &offset)
 Factory function. More...
 

Detailed Description

Class for mouse scroll event.

Constructor & Destructor Documentation

Input::MouseScrollEvent::MouseScrollEvent ( const glm::dvec2 &  offset)
inline

MouseScrollEvent constructor.

Parameters
[in]offsetThe offset

Member Function Documentation

static std::shared_ptr<MouseScrollEvent> Input::MouseScrollEvent::create ( const glm::dvec2 &  offset)
inlinestatic

Factory function.

Parameters
[in]offsetThe offset
Returns
Newly created MouseScrollEvent

Referenced by generated::getMouseScrollEventModule(), and Input::InputSystem::pollForInput().

glm::dvec2 Input::MouseScrollEvent::getPosition ( ) const
inlinenoexcept

Gets the position.

Returns
The position.

Referenced by generated::getMouseScrollEventModule().


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