Blender  V3.3
Public Member Functions | Protected Attributes | List of all members
GHOST_Event Class Reference

#include <GHOST_Event.h>

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

Public Member Functions

 GHOST_Event (uint64_t msec, GHOST_TEventType type, GHOST_IWindow *window)
 
GHOST_TEventType getType ()
 
uint64_t getTime ()
 
GHOST_IWindowgetWindow ()
 
GHOST_TEventDataPtr getData ()
 
- Public Member Functions inherited from GHOST_IEvent
virtual ~GHOST_IEvent ()
 

Protected Attributes

GHOST_TEventType m_type
 
uint64_t m_time
 
GHOST_IWindowm_window
 
GHOST_TEventDataPtr m_data
 

Detailed Description

Base class for events received the operating system.

Definition at line 16 of file GHOST_Event.h.

Constructor & Destructor Documentation

◆ GHOST_Event()

GHOST_Event::GHOST_Event ( uint64_t  msec,
GHOST_TEventType  type,
GHOST_IWindow window 
)
inline

Constructor.

Parameters
msecThe time this event was generated.
typeThe type of this event.
windowThe generating window (or NULL if system event).

Definition at line 24 of file GHOST_Event.h.

Member Function Documentation

◆ getData()

GHOST_TEventDataPtr GHOST_Event::getData ( )
inlinevirtual

Returns the event data.

Returns
The event data.

Implements GHOST_IEvent.

Definition at line 61 of file GHOST_Event.h.

References m_data.

◆ getTime()

uint64_t GHOST_Event::getTime ( )
inlinevirtual

Returns the time this event was generated.

Returns
The event generation time.

Implements GHOST_IEvent.

Definition at line 42 of file GHOST_Event.h.

References m_time.

◆ getType()

GHOST_TEventType GHOST_Event::getType ( )
inlinevirtual

Returns the event type.

Returns
The event type.

Implements GHOST_IEvent.

Definition at line 33 of file GHOST_Event.h.

References m_type.

◆ getWindow()

GHOST_IWindow* GHOST_Event::getWindow ( )
inlinevirtual

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

Returns
The generating window.

Implements GHOST_IEvent.

Definition at line 52 of file GHOST_Event.h.

References m_window.

Member Data Documentation

◆ m_data

GHOST_TEventDataPtr GHOST_Event::m_data
protected

◆ m_time

uint64_t GHOST_Event::m_time
protected

The time this event was generated.

Definition at line 70 of file GHOST_Event.h.

Referenced by getTime().

◆ m_type

GHOST_TEventType GHOST_Event::m_type
protected

Type of this event.

Definition at line 68 of file GHOST_Event.h.

Referenced by getType().

◆ m_window

GHOST_IWindow* GHOST_Event::m_window
protected

Pointer to the generating window.

Definition at line 72 of file GHOST_Event.h.

Referenced by getWindow().


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