ViewerInterpreter.ViewerInterpreter Class Reference

#include <class_viewer_interpreter_1_1_viewer_interpreter.h>

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

List of all members.

Public Member Functions

  __init__ ()
  deactivate ()
  Abstract - to be implemented by the subclasses.
  configureEventMapping ()
  Abstract - to be implemented by the subclasses.
  setFocus ()
  This was an experiment that seemed like a good idea since the swap barrier has issues maintaining sync when other windows are interacting with our display window.
  killFocus ()
  See comment in setFocus above.
  idleStart ()
  Idle event started, improve the draw quality.
  idleEnd ()
  Idle event ended, restore the draw quality.
  redrawEvent ()
  If we get a redraw event while in an idle state it would simply trigger another (possibly very slow) idle refresh unless we tell the display to get out of the idle state...
  SET_DISPLAY ()
  VIEWER_REDRAW_REQUEST ()
  VIEWER_CLEAR_BUTTON_STATE ()
  SET_DISPLAY_BACKGROUND_COLOR ()
  Set the display background color.
  RESET_DISPLAY_BACKGROUND_COLOR ()
  Set the display background color with default rgb.
  SET_DISPLAY_SIZE ()
  Set the display size.
  SET_DISPLAY_POSITION_AND_SIZE ()
  Set the position and size of the display.
  DOCUMENT_LOADED ()
  Override so we can call the initial LOCK_LOD/LOCK_MIN_FPS message.
  APPLICATION_CLOSE_SCENE ()
  Override so we can clear our Preference List.
  SHUTDOWN ()
  APPLICATION_MODE_CHANGED ()
  APPLICATION_LOAD_SCENE_IMPORTS_COMPLETE ()
  RT_CLUSTER_SWITCH ()
  RT_SWITCH ()
  RT_SWITCH_REQUEST ()
  RT_CLUSTER_SWITCH_REQUEST ()
  RT_CLUSTER_INIT_FAILED ()
  RT_CLUSTER_FAILED ()
  RT_CLUSTER_LICENSE_WARNING ()
  RT_CLUSTER_LICENSE_ERROR ()
  SET_DRAW_MODE ()
  MATERIAL_SET_SELECTION_STYLE ()
  LOCK_LOD ()
  LOCK_MIN_FPS ()
  DISPLAY_IMPROVE_ON_IDLE ()
  DISPLAY_LOCK_ANTIALIAS ()
  DISPLAY_AUTO_MIN_ANTIALIAS ()
  DISPLAY_ANTIALIASING_ON_IDLE ()
  DISPLAY_INCREASE_ANTIALIAS_ON_IDLE ()
  SET_RT_PRESET_QUALITY ()
  RT_SET_INTERACTIVE_QUALITY ()
  VIEWER_SET_LAYOUT ()
  Given a layout of viewports, split the window to a number of viewports.
  DISPLAY_VIEWPORT_SPLIT_CHANGED ()
  VIEWER_REQUEST_PARAMETERS ()
  Send out the viewport layout information to allow clients to sync up.
  CANT_LOAD_ENV_REFLECTION_TEXTURE ()
  BLOOM_SET_PARAMETER ()

Member Function Documentation

ViewerInterpreter.ViewerInterpreter.__init__ ( )
ViewerInterpreter.ViewerInterpreter.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 DisplayInterpreter.DisplayInterpreter.

ViewerInterpreter.ViewerInterpreter.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 DisplayInterpreter.DisplayInterpreter.

ViewerInterpreter.ViewerInterpreter.setFocus ( )

This was an experiment that seemed like a good idea since the swap barrier has issues maintaining sync when other windows are interacting with our display window.

However, if you want to run two synchronized Showcase sessions on a single display, this trick makes it impossible to sync.

if self.__mySyncWasEnabled: display = self.getDisplay() if display: display.enableSynchronizedSwap( True )

ViewerInterpreter.ViewerInterpreter.killFocus ( )

See comment in setFocus above.

display = self.getDisplay() self.__mySyncWasEnabled = (display and display.isSynchronizedSwapEnabled()) if self.__mySyncWasEnabled: display.enableSynchronizedSwap( False )

ViewerInterpreter.ViewerInterpreter.idleStart ( )

Idle event started, improve the draw quality.

ViewerInterpreter.ViewerInterpreter.idleEnd ( )

Idle event ended, restore the draw quality.

ViewerInterpreter.ViewerInterpreter.redrawEvent ( )

If we get a redraw event while in an idle state it would simply trigger another (possibly very slow) idle refresh unless we tell the display to get out of the idle state...

ViewerInterpreter.ViewerInterpreter.SET_DISPLAY ( )
ViewerInterpreter.ViewerInterpreter.VIEWER_REDRAW_REQUEST ( )
ViewerInterpreter.ViewerInterpreter.VIEWER_CLEAR_BUTTON_STATE ( )
ViewerInterpreter.ViewerInterpreter.SET_DISPLAY_BACKGROUND_COLOR ( )

Set the display background color.

Message data arguments: red - red channel value between 0.0 and 1.0 green - green channel value between 0.0 and 1.0 blue - blue channel value between 0.0 and 1.0

ViewerInterpreter.ViewerInterpreter.RESET_DISPLAY_BACKGROUND_COLOR ( )

Set the display background color with default rgb.

ViewerInterpreter.ViewerInterpreter.SET_DISPLAY_SIZE ( )

Set the display size.

If the arguments are invalid, the display size will remain unchanged.

Message data arguments: width - the width of the display. height - the height of the display.

ViewerInterpreter.ViewerInterpreter.SET_DISPLAY_POSITION_AND_SIZE ( )

Set the position and size of the display.

Message data arguments: x - x coordinate of the display position. y - y coordinate of the display position. width - the width of the display. height - the height of the display.

ViewerInterpreter.ViewerInterpreter.DOCUMENT_LOADED ( )

Override so we can call the initial LOCK_LOD/LOCK_MIN_FPS message.

Reimplemented from DisplayInterpreter.DisplayInterpreter.

ViewerInterpreter.ViewerInterpreter.APPLICATION_CLOSE_SCENE ( )

Override so we can clear our Preference List.

Reimplemented from DisplayInterpreter.DisplayInterpreter.

ViewerInterpreter.ViewerInterpreter.SHUTDOWN ( )
ViewerInterpreter.ViewerInterpreter.APPLICATION_MODE_CHANGED ( )
ViewerInterpreter.ViewerInterpreter.APPLICATION_LOAD_SCENE_IMPORTS_COMPLETE ( )
ViewerInterpreter.ViewerInterpreter.RT_CLUSTER_SWITCH ( )
ViewerInterpreter.ViewerInterpreter.RT_SWITCH ( )
ViewerInterpreter.ViewerInterpreter.RT_SWITCH_REQUEST ( )
ViewerInterpreter.ViewerInterpreter.RT_CLUSTER_SWITCH_REQUEST ( )
ViewerInterpreter.ViewerInterpreter.RT_CLUSTER_INIT_FAILED ( )
ViewerInterpreter.ViewerInterpreter.RT_CLUSTER_FAILED ( )
ViewerInterpreter.ViewerInterpreter.RT_CLUSTER_LICENSE_WARNING ( )
ViewerInterpreter.ViewerInterpreter.RT_CLUSTER_LICENSE_ERROR ( )
ViewerInterpreter.ViewerInterpreter.SET_DRAW_MODE ( )
ViewerInterpreter.ViewerInterpreter.MATERIAL_SET_SELECTION_STYLE ( )
ViewerInterpreter.ViewerInterpreter.LOCK_LOD ( )
ViewerInterpreter.ViewerInterpreter.LOCK_MIN_FPS ( )
ViewerInterpreter.ViewerInterpreter.DISPLAY_IMPROVE_ON_IDLE ( )
ViewerInterpreter.ViewerInterpreter.DISPLAY_LOCK_ANTIALIAS ( )
ViewerInterpreter.ViewerInterpreter.DISPLAY_AUTO_MIN_ANTIALIAS ( )
ViewerInterpreter.ViewerInterpreter.DISPLAY_ANTIALIASING_ON_IDLE ( )
ViewerInterpreter.ViewerInterpreter.DISPLAY_INCREASE_ANTIALIAS_ON_IDLE ( )
ViewerInterpreter.ViewerInterpreter.SET_RT_PRESET_QUALITY ( )
ViewerInterpreter.ViewerInterpreter.RT_SET_INTERACTIVE_QUALITY ( )
ViewerInterpreter.ViewerInterpreter.VIEWER_SET_LAYOUT ( )

Given a layout of viewports, split the window to a number of viewports.

The information message VIEWER_LAYOUT is sent once the number of viewports has been changed.

ViewerInterpreter.ViewerInterpreter.DISPLAY_VIEWPORT_SPLIT_CHANGED ( )
ViewerInterpreter.ViewerInterpreter.VIEWER_REQUEST_PARAMETERS ( )

Send out the viewport layout information to allow clients to sync up.

ViewerInterpreter.ViewerInterpreter.CANT_LOAD_ENV_REFLECTION_TEXTURE ( )
ViewerInterpreter.ViewerInterpreter.BLOOM_SET_PARAMETER ( )

ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter
ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter ViewerInterpreter.ViewerInterpreter