5.4 events -- Standard event names and classes

This module defines the names of the standard events and the corresponding event classes.

The actual event name is a capitalized version of the symbol where all underscores are removed (for example, STEP_FRAME = "StepFrame").

STEP_FRAME
This event is created whenever the timer is stepped forward one frame using timer.step(). The event takes no arguments.

RESET
This event is created to reset the simulation/animation. This effectively sets the time back to 0. Any component that has an internal state should connect to this method and reset its state whenever the event is signalled.

KEY_PRESS
A key was pressed on the keyboard. The callback function receives a KeyEvent object as argument.

KEY_RELEASE
A key was released on the keyboard. The callback function receives a KeyEvent object as argument.

LEFT_DOWN
The left mouse button was pressed. The callback function receives a MouseButtonEvent object as argument.

LEFT_UP
The left mouse button was released. The callback function receives a MouseButtonEvent object as argument.

MIDDLE_DOWN
The middle mouse button was pressed. The callback function receives a MouseButtonEvent object as argument.

MIDDLE_UP
The middle mouse button was released. The callback function receives a MouseButtonEvent object as argument.

RIGHT_DOWN
The right mouse button was pressed. The callback function receives a MouseButtonEvent object as argument.

RIGHT_UP
The right mouse button was released. The callback function receives a MouseButtonEvent object as argument.

MOUSE_BUTTON_DOWN
A mouse button other than the left, middle or right button was pressed. The callback function receives a MouseButtonEvent object as argument.

MOUSE_BUTTON_UP
A mouse button other than the left, middle or right button was released. The callback function receives a MouseButtonEvent object as argument.

MOUSE_MOVE
The mouse was moved. The callback function receives a MouseMoveEvent object as argument.

MOUSE_WHEEL
The mouse wheel was rotated. The callback function receives a MouseWheelEvent object as argument.

JOYSTICK_AXIS

JOYSTICK_BALL

JOYSTICK_HAT

JOYSTICK_BUTTON_DOWN

JOYSTICK_BUTTON_UP

SPACE_MOTION
A SpaceMouse/SpaceBall was moved or rotated. The callback function receives a SpaceMotionEvent object as argument.

SPACE_BUTTON_DOWN
A SpaceMouse/SpaceBall button was pressed. The callback function receives a SpaceButtonEvent object as argument.

SPACE_BUTTON_UP
A SpaceMouse/SpaceBall button was released. The callback function receives a SpaceButtonEvent object as argument.

SPACE_BUTTON_ZERO
The user stopped moving/rotating the SpaceMouse/SpaceBall. The event takes no arguments.

TABLET
A tablet (or similar pointing device) generated an event.

Note: It actually depends on the application used to process a scene if a particular type of event occurs or not. For example, events like a key press or mouse move do occur in the interactive viewer tool, but not in the offline rendering tool.



Subsections