Event triggered when the mouse button is pressed. More...

#include <MouseEvent.h>

Inheritance diagram for Karma::MouseButtonPressedEvent:

[legend]

Collaboration diagram for Karma::MouseButtonPressedEvent:

[legend]

Public Member Functions
	MouseButtonPressedEvent (int button)
	A constructor.

std::string	ToString () const override
	String representation of the mouse button press event.

Public Member Functions inherited from Karma::MouseButtonEvent
int	GetMouseButton () const
	Getter for mouse button.

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.

Event *	GetObjPointer ()
	Getter for the pointer to the object.

Additional Inherited Members
Protected Member Functions inherited from Karma::MouseButtonEvent
	MouseButtonEvent (int button)

Protected Attributes inherited from Karma::MouseButtonEvent
int	m_Button

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

Detailed Description

Event triggered when the mouse button is pressed.

Constructor & Destructor Documentation

Karma::MouseButtonPressedEvent::MouseButtonPressedEvent ( int button )

inline

A constructor.

Parameters

button GLFW defined mouse button, signifying the button pressed

std::string Karma::MouseButtonPressedEvent::ToString ( ) const

inlineoverridevirtual

String representation of the mouse button press event.

Reimplemented from Karma::Event.

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