sculpto
Public Member Functions | List of all members
scl::mouse_button_event Class Reference

#include <mouse_event.h>

Inheritance diagram for scl::mouse_button_event:
scl::event

Public Member Functions

 mouse_button_event (bool Pressed, int X, int Y, mouse_button KeyCode)
 
bool GetPressed ()
 
int GetX ()
 
int GetY ()
 
mouse_button GetKeyCode ()
 
std::string ToString () const override
 
- Public Member Functions inherited from scl::event
virtual ~event ()=default
 
virtual u32 GetType () const =0
 
virtual const char * GetName () const =0
 
virtual std::string ToString () const
 

Additional Inherited Members

- Public Attributes inherited from scl::event
bool Handled { false }
 

Detailed Description

Mouse buttons click events class.

Definition at line 30 of file mouse_event.h.

Constructor & Destructor Documentation

◆ mouse_button_event()

scl::mouse_button_event::mouse_button_event ( bool  Pressed,
int  X,
int  Y,
mouse_button  KeyCode 
)
inline
  • Mouse button click default constructor..
Parameters
Pressed- is mouse key pressed or released flag.
DbClick- is button pressecd second time in a row flag.
X- mouse x position.
Y- mouse y possition.
KeyCode- mouse button code.

Definition at line 49 of file mouse_event.h.

49 :
50 Pressed(Pressed), X(X), Y(Y), KeyCode(KeyCode) {}

Member Function Documentation

◆ GetKeyCode()

mouse_button scl::mouse_button_event::GetKeyCode ( )
inline

Mouse button code getter function.

Definition at line 59 of file mouse_event.h.

59{ return KeyCode; }

◆ GetPressed()

bool scl::mouse_button_event::GetPressed ( )
inline

Mouse key pressed or released flag getter function.

Definition at line 53 of file mouse_event.h.

53{ return Pressed; }

◆ GetX()

int scl::mouse_button_event::GetX ( )
inline

Mouse x position getter function.

Definition at line 55 of file mouse_event.h.

55{ return X; }

◆ GetY()

int scl::mouse_button_event::GetY ( )
inline

Mouse y position getter function.

Definition at line 57 of file mouse_event.h.

57{ return Y; }

◆ ToString()

std::string scl::mouse_button_event::ToString ( ) const
inlineoverridevirtual
  • Convert event to string (for debug).
Parameters
None.
Returns
string representation of event.

Reimplemented from scl::event.

Definition at line 67 of file mouse_event.h.

68 {
69 std::stringstream ss;
70 ss << GetName() << ": Pressed? - " << Pressed
71 << ", (X, Y) - (" << X << ", " << Y << "), KeyCode - " << (int)KeyCode;
72 return ss.str();
73 }
virtual const char * GetName() const =0

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