OverlayInterpreter.OverlayInterpreter Class Reference


Detailed Description

OverlayCommmands process requests to produce various types of statistics, logs, performace data, etc.

#include <class_overlay_interpreter_1_1_overlay_interpreter.h>

Inheritance diagram for OverlayInterpreter.OverlayInterpreter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ ()
  activate ()
  Abstract - to be implemented by the subclasses.
  deactivate ()
  Abstract - to be implemented by the subclasses.
  getSelector ()
  getUiInterpreters ()
  isMenubarToggleEnabled ()
  activateNewUi ()
  configureEventMapping ()
  Abstract - to be implemented by the subclasses.
  Resize ()
  tick ()
  Remember that since this method is invoked by a timer it is called from a different thread.
  Frame ()
  UiSelect ()
  Handle a select (eg button press) event.
  UiRelease ()
  Handle a mouse up event.
  MoveInUI ()
  Handle a move (eg button drag) event.
  ScrollUpRequest ()
  Handle a scroll (eg mouse wheel up) event.
  ScrollDownRequest ()
  Handle a scroll (eg mouse wheel down) event.
  ContextMenuReplace ()
  ContextMenuAdd ()
  ContextMenuRemove ()
  APPLICATION_CLOSE_SCENE ()
  QUIT ()
  MENUBAR_UI_SET_MODE ()
  MATERIAL_UI_SET_MODE ()
  ALTERNATIVE_UI_SET_MODE ()
  LIGHT_UI_SET_MODE ()
  CLIP_UI_SET_MODE ()
  BEHAVIOR_UI_SET_MODE ()
  ENVIRONMENT_UI_SET_MODE ()
  SCREENSNAP_UI_SET_MODE ()
  SPOTLIGHT_UI_SET_MODE ()
  SHOT_UI_SET_MODE ()
  STORYBOARD_UI_SET_MODE ()
  RT_UI_SET_MODE ()
  STYLES_UI_SET_MODE ()
  CUSTOM_OVERLAY_SET_MODE ()
  COMPARISON_UI_SET_MODE ()
  MANIPULATOR_MODE_CHANGED ()
  MANIPULATOR_ENABLE_STATUS_CHANGED ()
  AUTOCAM_INTERFACE_CHANGED ()
  VIEW_CUBE_PROPERTIES_CHANGED ()
  APPLICATION_MODE_CHANGED ()
  APPLICATION_INTERACTION_MODE_CHANGED ()
  CLIENT_CONNECTION_STATUS ()
  SCREEN_SET_MODE ()
  DISPLAY_VIEWPORT_SPLIT_CHANGED ()
  UI_RENAME_IN_PLACE ()
  VIEWER_LAYOUT ()
  Inform each comparison ui about the new view layout.
  FRAME_END_NOTIFICATION ()
  SET_2D_UI_ROOT ()
  UI_SELECTOR_RESIZE ()
  UI_SELECTOR_RESIZE_WIDTH ()
  APPLICATION_PREFERENCES_LOADED ()

Member Function Documentation

OverlayInterpreter.OverlayInterpreter.__init__ ( )
OverlayInterpreter.OverlayInterpreter.activate ( )

Abstract - to be implemented by the subclasses.

Performs the operations necessary to place this interpreter into a ready, active state. Ensure that this base class implementation is called by the subclass implementation.

Reimplemented from MessageInterpreter.MessageInterpreter.

OverlayInterpreter.OverlayInterpreter.deactivate ( )

Abstract - to be implemented by the subclasses.

Performs the operations necessary to place this interpreter into a passive state. Ensure that this base class implementation is called by the subclass implementation.

Reimplemented from MessageInterpreter.MessageInterpreter.

OverlayInterpreter.OverlayInterpreter.getSelector ( )
OverlayInterpreter.OverlayInterpreter.getUiInterpreters ( )
OverlayInterpreter.OverlayInterpreter.isMenubarToggleEnabled ( )
OverlayInterpreter.OverlayInterpreter.activateNewUi ( )
OverlayInterpreter.OverlayInterpreter.configureEventMapping ( )

Abstract - to be implemented by the subclasses.

Configures the event mapping table with the events handled by this interpreter, and their respective actions

Reimplemented from MessageInterpreter.MessageInterpreter.

OverlayInterpreter.OverlayInterpreter.Resize ( )
OverlayInterpreter.OverlayInterpreter.tick ( )

Remember that since this method is invoked by a timer it is called from a different thread.

This means in general that this method must be thread safe. Typically it will just trigger a redraw or queue a message.

Reimplemented from MessageInterpreter.MessageInterpreter.

OverlayInterpreter.OverlayInterpreter.Frame ( )
OverlayInterpreter.OverlayInterpreter.UiSelect ( )

Handle a select (eg button press) event.

Return True if event is handled by the UI, False if not.

OverlayInterpreter.OverlayInterpreter.UiRelease ( )

Handle a mouse up event.

Return True if the event was handled by the UI

OverlayInterpreter.OverlayInterpreter.MoveInUI ( )

Handle a move (eg button drag) event.

Return True if event is handled by the UI, False if not.

OverlayInterpreter.OverlayInterpreter.ScrollUpRequest ( )

Handle a scroll (eg mouse wheel up) event.

Return True if event is handled by the UI, False if not.

OverlayInterpreter.OverlayInterpreter.ScrollDownRequest ( )

Handle a scroll (eg mouse wheel down) event.

Return True if event is handled by the UI, False if not.

OverlayInterpreter.OverlayInterpreter.ContextMenuReplace ( )
OverlayInterpreter.OverlayInterpreter.ContextMenuAdd ( )
OverlayInterpreter.OverlayInterpreter.ContextMenuRemove ( )
OverlayInterpreter.OverlayInterpreter.APPLICATION_CLOSE_SCENE ( )
OverlayInterpreter.OverlayInterpreter.QUIT ( )
OverlayInterpreter.OverlayInterpreter.MENUBAR_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.MATERIAL_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.ALTERNATIVE_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.LIGHT_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.CLIP_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.BEHAVIOR_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.ENVIRONMENT_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.SCREENSNAP_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.SPOTLIGHT_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.SHOT_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.STORYBOARD_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.RT_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.STYLES_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.CUSTOM_OVERLAY_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.COMPARISON_UI_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.MANIPULATOR_MODE_CHANGED ( )
OverlayInterpreter.OverlayInterpreter.MANIPULATOR_ENABLE_STATUS_CHANGED ( )
OverlayInterpreter.OverlayInterpreter.AUTOCAM_INTERFACE_CHANGED ( )
OverlayInterpreter.OverlayInterpreter.VIEW_CUBE_PROPERTIES_CHANGED ( )
OverlayInterpreter.OverlayInterpreter.APPLICATION_MODE_CHANGED ( )
OverlayInterpreter.OverlayInterpreter.APPLICATION_INTERACTION_MODE_CHANGED ( )
OverlayInterpreter.OverlayInterpreter.CLIENT_CONNECTION_STATUS ( )
OverlayInterpreter.OverlayInterpreter.SCREEN_SET_MODE ( )
OverlayInterpreter.OverlayInterpreter.DISPLAY_VIEWPORT_SPLIT_CHANGED ( )
OverlayInterpreter.OverlayInterpreter.UI_RENAME_IN_PLACE ( )
OverlayInterpreter.OverlayInterpreter.VIEWER_LAYOUT ( )

Inform each comparison ui about the new view layout.

Each comparison ui gets the associated viewportId.

OverlayInterpreter.OverlayInterpreter.FRAME_END_NOTIFICATION ( )
OverlayInterpreter.OverlayInterpreter.SET_2D_UI_ROOT ( )
OverlayInterpreter.OverlayInterpreter.UI_SELECTOR_RESIZE ( )
OverlayInterpreter.OverlayInterpreter.UI_SELECTOR_RESIZE_WIDTH ( )
OverlayInterpreter.OverlayInterpreter.APPLICATION_PREFERENCES_LOADED ( )

OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter
OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter OverlayInterpreter.OverlayInterpreter