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

Class for mouse button down event. More...

#include <mouse_button_down_event.h>

Inheritance diagram for Input::MouseButtonDownEvent:
Events::Event

Public Member Functions

 MouseButtonDownEvent (const int button)
 MouseButtonDownEvent constructor. More...
 
int getButton () const noexcept
 Gets the button. 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
< MouseButtonDownEvent
create (const int button)
 Factory function. More...
 

Detailed Description

Class for mouse button down event.

Constructor & Destructor Documentation

Input::MouseButtonDownEvent::MouseButtonDownEvent ( const int  button)
inline

MouseButtonDownEvent constructor.

Parameters
[in]buttonThe button

Member Function Documentation

static std::shared_ptr<MouseButtonDownEvent> Input::MouseButtonDownEvent::create ( const int  button)
inlinestatic

Factory function.

Parameters
[in]buttonThe button
Returns
A newly created MouseButtonDownEvent

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

int Input::MouseButtonDownEvent::getButton ( ) const
inlinenoexcept

Gets the button.

Returns
The button.

Referenced by generated::getMouseButtonDownEventModule().


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