Equalizer  1.12.0
Parallel Rendering Framework
eq::fabric::Event Struct Reference

Event structure to report window system and other events. More...

#include <event.h>

+ Collaboration diagram for eq::fabric::Event:

Public Types

enum  Type {
  WINDOW_EXPOSE = 0, WINDOW_RESIZE, WINDOW_CLOSE, WINDOW_HIDE,
  WINDOW_SHOW, WINDOW_SCREENSAVER, CHANNEL_POINTER_MOTION, CHANNEL_POINTER_BUTTON_PRESS,
  CHANNEL_POINTER_BUTTON_RELEASE, CHANNEL_POINTER_WHEEL, WINDOW_POINTER_WHEEL, WINDOW_POINTER_MOTION,
  WINDOW_POINTER_BUTTON_PRESS, WINDOW_POINTER_BUTTON_RELEASE, WINDOW_POINTER_GRAB, WINDOW_POINTER_UNGRAB,
  KEY_PRESS, KEY_RELEASE, CHANNEL_RESIZE, STATISTIC,
  VIEW_RESIZE, EXIT, MAGELLAN_AXIS, MAGELLAN_BUTTON,
  NODE_TIMEOUT, OBSERVER_MOTION, CONFIG_ERROR, NODE_ERROR,
  PIPE_ERROR, WINDOW_ERROR, CHANNEL_ERROR, UNKNOWN,
  USER = UNKNOWN + 5, ALL
}
 The type of the event. More...
 

Public Member Functions

EQFABRIC_API Event ()
 Construct a new event. More...
 

Public Attributes

uint32_t type
 The event type.
 
uint32_t serial
 server-unique originator serial number
 
int64_t time
 The config time when the event was created. More...
 
uint128_t originator
 The identifier of the entity emitting the event. More...
 
union {
   ResizeEvent   resize
 Resize event data.
 
   ResizeEvent   show
 Window show event data.
 
   ResizeEvent   hide
 Window hide event data.
 
   PointerEvent   pointer
 Pointer event data.
 
   PointerEvent   pointerMotion
 Pointer motion data.
 
   PointerEvent   pointerButtonPress
 Mouse button press data.
 
   PointerEvent   pointerButtonRelease
 Mouse button release data.
 
   PointerEvent   pointerWheel
 Mouse wheel motion data.
 
   KeyEvent   key
 Key event data.
 
   KeyEvent   keyPress
 Key press event data.
 
   KeyEvent   keyRelease
 Key release event data.
 
   Statistic   statistic
 Statistic event.
 
   MagellanEvent   magellan
 SpaceMouse data.
 
   UserEvent   user
 User-defined event data.
 
}; 
 Data for the event corresponding to the event type. More...
 
RenderContext context
 The last rendering context for the pointer position. More...
 

Detailed Description

Event structure to report window system and other events.

Depending on the Event::Type, the corresponding specific event data is filled into the anonymous union. The originator typically contains the co::Object identifier of the entity emitting the event. The rendering context is only set for pointer events.

Version
1.0

Definition at line 105 of file event.h.

Member Enumeration Documentation

The type of the event.

Enumerator
WINDOW_EXPOSE 

A window is dirty.

WINDOW_RESIZE 

Window resize data in resize.

WINDOW_CLOSE 

A window has been closed.

WINDOW_HIDE 

A window is hidden.

WINDOW_SHOW 

A window is shown.

WINDOW_SCREENSAVER 

A window screensaver request (Win32 only) < Channel pointer movement data in pointerMotion.

CHANNEL_POINTER_BUTTON_PRESS 

Channel pointer button press data in pointerButtonPress.

CHANNEL_POINTER_BUTTON_RELEASE 

Channel pointer button release data in pointerButtonRelease.

Channel pointer Mouse wheel data in wheel

CHANNEL_POINTER_WHEEL 

Window pointer Mouse wheel data in wheel.

WINDOW_POINTER_WHEEL 

Window pointer movement data in pointerMotion.

WINDOW_POINTER_BUTTON_PRESS 

Window pointer button press data in pointerButtonPress.

WINDOW_POINTER_BUTTON_RELEASE 

Window pointer button release data in pointerButtonRelease.

WINDOW_POINTER_GRAB 

Window pointer grabbed by system window.

WINDOW_POINTER_UNGRAB 

Window pointer to be released by system window.

KEY_PRESS 

Key press data in keyPress.

KEY_RELEASE 

Key release data in keyRelease.

CHANNEL_RESIZE 

Channel resize data in resize.

STATISTIC 

Statistic event in statistic.

VIEW_RESIZE 

View resize data in resize.

EXIT 

Exit request due to runtime error.

MAGELLAN_AXIS 

SpaceMouse movement data in magellan.

MAGELLAN_BUTTON 

SpaceMouse button data in magellan.

NODE_TIMEOUT 

Node has timed out.

OBSERVER_MOTION 

Observer moved (head tracking update).

Contains observer originator identifier and 4x4 float tracking matrix.

Version
1.5.2
CONFIG_ERROR 

Config error event.

Contains the originator id, the error code and 0-n Strings with additional information.

Version
1.7.1
NODE_ERROR 

Node error event.

See also
CONFIG_ERROR
PIPE_ERROR 

Pipe error event.

See also
CONFIG_ERROR
WINDOW_ERROR 

Window error event.

See also
CONFIG_ERROR
CHANNEL_ERROR 

Channel error event.

See also
CONFIG_ERROR
UNKNOWN 

Event type not known by the event handler.

USER 

User-defined events have to be of this type or higher.

Definition at line 111 of file event.h.

Constructor & Destructor Documentation

EQFABRIC_API eq::fabric::Event::Event ( )

Construct a new event.

Member Data Documentation

union { ... }

Data for the event corresponding to the event type.

RenderContext eq::fabric::Event::context

The last rendering context for the pointer position.

Definition at line 209 of file event.h.

uint128_t eq::fabric::Event::originator

The identifier of the entity emitting the event.

Definition at line 183 of file event.h.

int64_t eq::fabric::Event::time

The config time when the event was created.

Version
1.1.1

Definition at line 180 of file event.h.


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