Blender  V3.3
Public Member Functions | List of all members
GHOST_IEvent Class Referenceabstract

#include <GHOST_IEvent.h>

Inheritance diagram for GHOST_IEvent:
GHOST_Event GHOST_EventButton GHOST_EventCursor GHOST_EventDragnDrop GHOST_EventKey GHOST_EventNDOFButton GHOST_EventNDOFMotion GHOST_EventString GHOST_EventTrackpad GHOST_EventWheel

Public Member Functions

virtual ~GHOST_IEvent ()
 
virtual GHOST_TEventType getType ()=0
 
virtual uint64_t getTime ()=0
 
virtual GHOST_IWindowgetWindow ()=0
 
virtual GHOST_TEventDataPtr getData ()=0
 

Detailed Description

Interface class for events received from GHOST. You should not need to inherit this class. The system will pass these events to the GHOST_IEventConsumer::processEvent() method of event consumers.
Use the getType() method to retrieve the type of event and the getData() method to get the event data out. Using the event type you can cast the event data to the correct event data structure.

See also
GHOST_IEventConsumer::processEvent
GHOST_TEventType

Definition at line 26 of file GHOST_IEvent.h.

Constructor & Destructor Documentation

◆ ~GHOST_IEvent()

virtual GHOST_IEvent::~GHOST_IEvent ( )
inlinevirtual

Destructor.

Definition at line 31 of file GHOST_IEvent.h.

Member Function Documentation

◆ getData()

virtual GHOST_TEventDataPtr GHOST_IEvent::getData ( )
pure virtual

Returns the event data.

Returns
The event data.

Implemented in GHOST_Event.

Referenced by GHOST_GetEventData(), and Application::processEvent().

◆ getTime()

virtual uint64_t GHOST_IEvent::getTime ( )
pure virtual

Returns the time this event was generated.

Returns
The event generation time.

Implemented in GHOST_Event.

Referenced by GHOST_GetEventTime(), and GHOST_EventPrinter::processEvent().

◆ getType()

virtual GHOST_TEventType GHOST_IEvent::getType ( )
pure virtual

Returns the event type.

Returns
The event type.

Implemented in GHOST_Event.

Referenced by GHOST_GetEventType(), GHOST_EventPrinter::processEvent(), and Application::processEvent().

◆ getWindow()

virtual GHOST_IWindow* GHOST_IEvent::getWindow ( )
pure virtual

Returns the window this event was generated on, or NULL if it is a 'system' event.

Returns
The generating window.

Implemented in GHOST_Event.

Referenced by GHOST_GetEventWindow().


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