sculpto
Public Member Functions | Public Attributes | List of all members
scl::event Class Referenceabstract

#include <event.h>

Inheritance diagram for scl::event:
scl::close_event scl::keyboard_event scl::mouse_button_event scl::mouse_move_event scl::mouse_wheel_event scl::viewport_resize_event

Public Member Functions

virtual ~event ()=default
 
virtual u32 GetType () const =0
 
virtual const char * GetName () const =0
 
virtual std::string ToString () const
 

Public Attributes

bool Handled { false }
 

Detailed Description

Base event class.

Definition at line 23 of file event.h.

Constructor & Destructor Documentation

◆ ~event()

virtual scl::event::~event ( )
virtualdefault

Defualt destructor.

Member Function Documentation

◆ GetName()

virtual const char * scl::event::GetName ( ) const
inlinepure virtual
  • Get string name of event.
Parameters
None.
Returns
name of event type as string.

◆ GetType()

virtual u32 scl::event::GetType ( ) const
inlinepure virtual
  • Get type of specific event function.
Parameters
None.
Returns
type of specific event.

◆ ToString()

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

Reimplemented in scl::keyboard_event, scl::mouse_button_event, scl::mouse_wheel_event, scl::mouse_move_event, and scl::viewport_resize_event.

Definition at line 54 of file event.h.

54{ return GetName(); };
virtual const char * GetName() const =0

Member Data Documentation

◆ Handled

bool scl::event::Handled { false }

Event handled flag.

Definition at line 27 of file event.h.


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