KarmaEngine
Game Engine for practical learning and research purposes
Loading...
Searching...
No Matches
Karma::MouseScrolledEvent Class Reference

Event triggered on scrolling of mouse. More...

#include <MouseEvent.h>

Inheritance diagram for Karma::MouseScrolledEvent:
Collaboration diagram for Karma::MouseScrolledEvent:

Public Member Functions

 MouseScrolledEvent (float xOffset, float yOffset)
 Default constructor.
 
float GetXOffset () const
 Getter for x offset.
 
float GetYOffset () const
 Getter for y offset.
 
std::string ToString () const override
 String representation of scrolling event.
 
- Public Member Functions inherited from Karma::Event
virtual EventType GetEventType () const =0
 Getter for event name (type)
 
virtual const char * GetName () const =0
 Getter for event type.
 
virtual int GetCategoryFlags () const =0
 Getter for category flags (enum EventCategory)
 
bool IsInCategory (EventCategory category)
 Routine to see if the category of the Event is (or a part of) given category.
 
bool IsHandled () const
 Getter for the m_Handled.
 
EventGetObjPointer ()
 Getter for the pointer to the object.
 

Additional Inherited Members

- Protected Attributes inherited from Karma::Event
bool m_Handled = false
 

Detailed Description

Event triggered on scrolling of mouse.

Constructor & Destructor Documentation

◆ MouseScrolledEvent()

Karma::MouseScrolledEvent::MouseScrolledEvent ( float xOffset,
float yOffset )
inline

Default constructor.

Since
Karma 1.0.0

Member Function Documentation

◆ GetXOffset()

float Karma::MouseScrolledEvent::GetXOffset ( ) const
inline

Getter for x offset.

Since
Karma 1.0.0

◆ GetYOffset()

float Karma::MouseScrolledEvent::GetYOffset ( ) const
inline

Getter for y offset.

Since
Karma 1.0.0

◆ ToString()

std::string Karma::MouseScrolledEvent::ToString ( ) const
inlineoverridevirtual

String representation of scrolling event.

Reimplemented from Karma::Event.


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