HUD.HeadsUpDisplayInterpreter Class Reference

#include <class_h_u_d_1_1_heads_up_display_interpreter.h>

Inheritance diagram for HUD.HeadsUpDisplayInterpreter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ ()
  getHud ()
  configureEventMapping ()
  Abstract - to be implemented by the subclasses.
  getDocument ()
  activate ()
  Abstract - to be implemented by the subclasses.
  deactivate ()
  Abstract - to be implemented by the subclasses.
  updateSize ()
  moveMeasurementData ()
  updateMeasurementData ()
  updateMeasurementMessage ()
  updateMessage ()
  updateInfoMessage ()
  updateHiddenSelectedMessage ()
  If there are selected objects that are also hidden, display an information message to the user indicating that he may be about to modify selected items he cannot see.
  updateHudVisibility ()
  Update hud visibility with respect to status of visibility, document, and spectating flags.
  clearInfoMessage ()
  This will set the info message to an empty string, but only if the current info message matches the provided text.
  wantsMessage ()
  If processMessage were to be called at this point would this interpreter handle it?
  processMessage ()
  Abstract - to be implemented by the subclasses.
  ALTERNATIVE_CHANGED ()
  ALTERNATIVE_DELETED ()
  ALTERNATIVE_SET_CHANGED ()
  APPLICATION_CLOSE_SCENE ()
  APPLICATION_MODE_CHANGED ()
  APPLICATION_PREFERENCES_LOADED ()
  BEHAVIOR_CREATED ()
  BEHAVIOR_DUPLICATED ()
  BOOKMARK_CREATED ()
  CLIENT_ALL_LOADED ()
  CLIENT_CONNECTION_STATUS ()
  CLIENT_DISCONNECTED ()
  CLIENT_STILL_LOADING ()
  COI_SET_MODE ()
  DISPLAY_ONE_TO_ONE ()
  DISPLAY_PROJECTION_MODE_CHANGED ()
  DOCUMENT_UNITS_CHANGED ()
  AMBIENT_OCCLUSION_SHOWN ()
  DISPLAY_STYLE_CHANGED ()
  DUPLICATED ()
  ENVIRONMENT_CONVERT_OLD_SCENE ()
  ENVIRONMENT_LOAD ()
  ENVIRONMENT_LOAD_SKIPPED ()
  ENVIRONMENT_LOADING_DONE ()
  ENVIRONMENT_TEXTURE_TRANSFORM_STARTED ()
  GEOMETRY_NORMALS_SHOWN ()
  GEOMETRY_TRANSFORM_COPIED ()
  GEOMETRY_VISIBILITY_CHANGED ()
  HEADS_UP_DISPLAY_SET_MODE ()
  HEADS_UP_DISPLAY_SET_MODE_ITEM ()
  HEADS_UP_DISPLAY_SET_MESSAGE ()
  HILIGHT_POSITION_DRAG_STARTED ()
  HILIGHT_POSITION_DRAG_ENDED ()
  LIGHT_INTERACTIVE_POSITION_START ()
  LIGHT_INTERACTIVE_POSITION_END ()
  LIGHT_POSITION_DRAG_STARTED ()
  LIGHT_POSITION_DRAG_ENDED ()
  LIGHT_INTERACTIVE_TRANSFORMING_START ()
  LIGHT_INTERACTIVE_TRANSFORMING_END ()
  LIGHT_INTERACTIVE_TRANSFORMING_DRAG_STARTED ()
  LIGHT_INTERACTIVE_TRANSFORMING_DRAG_ENDED ()
  LOCATOR_SELECTION_CHANGED ()
  MANIPULATOR_ENABLE_STATUS_CHANGED ()
  MANIPULATOR_MODE_CHANGED ()
  MANIPULATOR_SNAP_CHANGED ()
  MATERIAL_COPIED ()
  MATERIAL_OCCLUSION_COMPUTE_STARTED ()
  MATERIAL_OCCLUSION_COMPUTE_CANCELLED ()
  MATERIAL_OCCLUSION_COMPUTE_FINISHED ()
  Ambient shadows need to be applied, so display an info message so the user knows that he still needs to wait.
  MATERIAL_OCCLUSION_RECOMPILE_FINISHED ()
  MATERIAL_SELECTED ()
  MEASUREMENT_MODE_CHANGED ()
  MEASUREMENT_STEP_CHANGED ()
  MODEL_PREPARE_STARTED ()
  A translation job has started.
  MODEL_PREPARE_ALLDONE ()
  MODEL_IMPORT_DISPLAYED_ALL ()
  NAVIGATION_MODE_CHANGED ()
  NAVIGATION_SPEED_MULTIPLIER ()
  NETWORK_CONNECTION_CHANGED ()
  NEW_CLIENT_CONNECTED ()
  PATCH_MODE_CHANGED ()
  QUIT ()
  RT_SWITCH_REQUEST ()
  RT_SWITCH ()
  RT_CLUSTER_SWITCH_REQUEST ()
  DISPLAY_SCALEFORM_SIZE_INFO ()
  DISPLAY_SCALEFORM_SHOW ()
  SCREEN_SET_MODE ()
  SELECT_UNCHANGED ()
  SELECTION_CHANGED ()
  SELECTION_DISALLOWED ()
  SERVER_STATUS ()
  DOCUMENT_LOADED ()
  SET_2D_UI_ROOT ()
  SHADOW_POSITION_START ()
  SHADOW_POSITION_END ()
  SHADOW_POSITION_DRAG_STARTED ()
  SHADOW_POSITION_DRAG_ENDED ()
  SHOT_CREATED ()
  SHOT_TRANSITION_SET_PARAMETERS ()
  SHOT_TRANSITION_SET_RECORDING_PARAMETERS ()
  SHOT_TRANSITION_SET_RECORDING_MODE ()
  SHOT_START_TRANSITION ()
  SHOT_UI_SET_MODE ()
  SPOTLIGHT_UI_SET_MODE ()
  STORYBOARD_UI_SET_MODE ()
  SLIDE_CREATED ()
  There are two ways a slide can be created:
  • by the user, or
  • undo of a slide deletion.

  SLIDE_DELETED ()
  If a slide is deleted and it's really undoing a slide that was just created, wipe out the 'slide created' message was displayed.
  SLIDE_ITEM_ADDED ()
  SLIDE_ITEM_REMOVED ()
  TEXTURE_TRANSFORM_STARTED ()
  TEXTURE_TRANSFORM_DRAG_STARTED ()
  TEXTURE_TRANSFORM_DRAG_ENDED ()
  TEXTURE_TRANSFORM_DONE ()
  TEXTURE_TRANSFORM_PIVOT_STARTED ()
  TEXTURE_TRANSFORM_PIVOT_DONE ()
  TEXTURE_TRANSFORM_DRAG_PIVOT_STARTED ()
  TEXTURE_TRANSFORM_DRAG_PIVOT_DONE ()
  UI_SET_HUD_DISPLAY_TIME ()
  VIEWER_LAYOUT ()
  Viewer layout has changed, eg.
  WINDOW_SHOW_BORDERS ()
  FRAME_SYNCHRONIZE_END ()
  DISPLAY_VERTICAL_FOV_CHANGED ()
  NAVIGATION_CAMERA_POSITION_CHANGED ()
  NAVIGATION_POSITION ()
  NAVIGATION_CAMERA_ROLL_CHANGED ()
  SET_DISPLAY_POSITION_AND_SIZE ()
  Resize ()
  tick ()
  Remember that since this method is invoked by a timer it is called from a different thread.
  Frame ()

Member Function Documentation

HUD.HeadsUpDisplayInterpreter.__init__ ( )
HUD.HeadsUpDisplayInterpreter.getHud ( )
HUD.HeadsUpDisplayInterpreter.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.

HUD.HeadsUpDisplayInterpreter.getDocument ( )
HUD.HeadsUpDisplayInterpreter.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.

HUD.HeadsUpDisplayInterpreter.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.

HUD.HeadsUpDisplayInterpreter.updateSize ( )
HUD.HeadsUpDisplayInterpreter.moveMeasurementData ( )
HUD.HeadsUpDisplayInterpreter.updateMeasurementData ( )
HUD.HeadsUpDisplayInterpreter.updateMeasurementMessage ( )
HUD.HeadsUpDisplayInterpreter.updateMessage ( )
HUD.HeadsUpDisplayInterpreter.updateInfoMessage ( )
HUD.HeadsUpDisplayInterpreter.updateHiddenSelectedMessage ( )

If there are selected objects that are also hidden, display an information message to the user indicating that he may be about to modify selected items he cannot see.

HUD.HeadsUpDisplayInterpreter.updateHudVisibility ( )

Update hud visibility with respect to status of visibility, document, and spectating flags.

HUD.HeadsUpDisplayInterpreter.clearInfoMessage ( )

This will set the info message to an empty string, but only if the current info message matches the provided text.

This way the caller can be sure that only his own message is being cleared off, and not interfering with anyone else's.

HUD.HeadsUpDisplayInterpreter.wantsMessage ( )

If processMessage were to be called at this point would this interpreter handle it?

Reimplemented from MessageInterpreter.MessageInterpreter.

HUD.HeadsUpDisplayInterpreter.processMessage ( )

Abstract - to be implemented by the subclasses.

The default implementation should be sufficient for most intepreters. Returns True if the message was processed; False otherwise. Note, no message processing occurs if the interpreter is deactivated.

The signature of a message handler method should be:

def methodName( self, message )

where message.id == methodName

Reimplemented from MessageInterpreter.MessageInterpreter.

HUD.HeadsUpDisplayInterpreter.ALTERNATIVE_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.ALTERNATIVE_DELETED ( )
HUD.HeadsUpDisplayInterpreter.ALTERNATIVE_SET_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.APPLICATION_CLOSE_SCENE ( )
HUD.HeadsUpDisplayInterpreter.APPLICATION_MODE_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.APPLICATION_PREFERENCES_LOADED ( )
HUD.HeadsUpDisplayInterpreter.BEHAVIOR_CREATED ( )
HUD.HeadsUpDisplayInterpreter.BEHAVIOR_DUPLICATED ( )
HUD.HeadsUpDisplayInterpreter.BOOKMARK_CREATED ( )
HUD.HeadsUpDisplayInterpreter.CLIENT_ALL_LOADED ( )
HUD.HeadsUpDisplayInterpreter.CLIENT_CONNECTION_STATUS ( )
HUD.HeadsUpDisplayInterpreter.CLIENT_DISCONNECTED ( )
HUD.HeadsUpDisplayInterpreter.CLIENT_STILL_LOADING ( )
HUD.HeadsUpDisplayInterpreter.COI_SET_MODE ( )
HUD.HeadsUpDisplayInterpreter.DISPLAY_ONE_TO_ONE ( )
HUD.HeadsUpDisplayInterpreter.DISPLAY_PROJECTION_MODE_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.DOCUMENT_UNITS_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.AMBIENT_OCCLUSION_SHOWN ( )
HUD.HeadsUpDisplayInterpreter.DISPLAY_STYLE_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.DUPLICATED ( )
HUD.HeadsUpDisplayInterpreter.ENVIRONMENT_CONVERT_OLD_SCENE ( )
HUD.HeadsUpDisplayInterpreter.ENVIRONMENT_LOAD ( )
HUD.HeadsUpDisplayInterpreter.ENVIRONMENT_LOAD_SKIPPED ( )
HUD.HeadsUpDisplayInterpreter.ENVIRONMENT_LOADING_DONE ( )
HUD.HeadsUpDisplayInterpreter.ENVIRONMENT_TEXTURE_TRANSFORM_STARTED ( )
HUD.HeadsUpDisplayInterpreter.GEOMETRY_NORMALS_SHOWN ( )
HUD.HeadsUpDisplayInterpreter.GEOMETRY_TRANSFORM_COPIED ( )
HUD.HeadsUpDisplayInterpreter.GEOMETRY_VISIBILITY_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.HEADS_UP_DISPLAY_SET_MODE ( )
HUD.HeadsUpDisplayInterpreter.HEADS_UP_DISPLAY_SET_MODE_ITEM ( )
HUD.HeadsUpDisplayInterpreter.HEADS_UP_DISPLAY_SET_MESSAGE ( )
HUD.HeadsUpDisplayInterpreter.HILIGHT_POSITION_DRAG_STARTED ( )
HUD.HeadsUpDisplayInterpreter.HILIGHT_POSITION_DRAG_ENDED ( )
HUD.HeadsUpDisplayInterpreter.LIGHT_INTERACTIVE_POSITION_START ( )
HUD.HeadsUpDisplayInterpreter.LIGHT_INTERACTIVE_POSITION_END ( )
HUD.HeadsUpDisplayInterpreter.LIGHT_POSITION_DRAG_STARTED ( )
HUD.HeadsUpDisplayInterpreter.LIGHT_POSITION_DRAG_ENDED ( )
HUD.HeadsUpDisplayInterpreter.LIGHT_INTERACTIVE_TRANSFORMING_START ( )
HUD.HeadsUpDisplayInterpreter.LIGHT_INTERACTIVE_TRANSFORMING_END ( )
HUD.HeadsUpDisplayInterpreter.LIGHT_INTERACTIVE_TRANSFORMING_DRAG_STARTED ( )
HUD.HeadsUpDisplayInterpreter.LIGHT_INTERACTIVE_TRANSFORMING_DRAG_ENDED ( )
HUD.HeadsUpDisplayInterpreter.LOCATOR_SELECTION_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.MANIPULATOR_ENABLE_STATUS_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.MANIPULATOR_MODE_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.MANIPULATOR_SNAP_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.MATERIAL_COPIED ( )
HUD.HeadsUpDisplayInterpreter.MATERIAL_OCCLUSION_COMPUTE_STARTED ( )
HUD.HeadsUpDisplayInterpreter.MATERIAL_OCCLUSION_COMPUTE_CANCELLED ( )
HUD.HeadsUpDisplayInterpreter.MATERIAL_OCCLUSION_COMPUTE_FINISHED ( )

Ambient shadows need to be applied, so display an info message so the user knows that he still needs to wait.

There is a minimum time for that message to be displayed.

HUD.HeadsUpDisplayInterpreter.MATERIAL_OCCLUSION_RECOMPILE_FINISHED ( )
HUD.HeadsUpDisplayInterpreter.MATERIAL_SELECTED ( )
HUD.HeadsUpDisplayInterpreter.MEASUREMENT_MODE_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.MEASUREMENT_STEP_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.MODEL_PREPARE_STARTED ( )

A translation job has started.

Update the heads-up-display.

HUD.HeadsUpDisplayInterpreter.MODEL_PREPARE_ALLDONE ( )
HUD.HeadsUpDisplayInterpreter.MODEL_IMPORT_DISPLAYED_ALL ( )
HUD.HeadsUpDisplayInterpreter.NAVIGATION_MODE_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.NAVIGATION_SPEED_MULTIPLIER ( )
HUD.HeadsUpDisplayInterpreter.NETWORK_CONNECTION_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.NEW_CLIENT_CONNECTED ( )
HUD.HeadsUpDisplayInterpreter.PATCH_MODE_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.QUIT ( )
HUD.HeadsUpDisplayInterpreter.RT_SWITCH_REQUEST ( )
HUD.HeadsUpDisplayInterpreter.RT_SWITCH ( )
HUD.HeadsUpDisplayInterpreter.RT_CLUSTER_SWITCH_REQUEST ( )
HUD.HeadsUpDisplayInterpreter.DISPLAY_SCALEFORM_SIZE_INFO ( )
HUD.HeadsUpDisplayInterpreter.DISPLAY_SCALEFORM_SHOW ( )
HUD.HeadsUpDisplayInterpreter.SCREEN_SET_MODE ( )
HUD.HeadsUpDisplayInterpreter.SELECT_UNCHANGED ( )
HUD.HeadsUpDisplayInterpreter.SELECTION_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.SELECTION_DISALLOWED ( )
HUD.HeadsUpDisplayInterpreter.SERVER_STATUS ( )
HUD.HeadsUpDisplayInterpreter.DOCUMENT_LOADED ( )
HUD.HeadsUpDisplayInterpreter.SET_2D_UI_ROOT ( )
HUD.HeadsUpDisplayInterpreter.SHADOW_POSITION_START ( )
HUD.HeadsUpDisplayInterpreter.SHADOW_POSITION_END ( )
HUD.HeadsUpDisplayInterpreter.SHADOW_POSITION_DRAG_STARTED ( )
HUD.HeadsUpDisplayInterpreter.SHADOW_POSITION_DRAG_ENDED ( )
HUD.HeadsUpDisplayInterpreter.SHOT_CREATED ( )
HUD.HeadsUpDisplayInterpreter.SHOT_TRANSITION_SET_PARAMETERS ( )
HUD.HeadsUpDisplayInterpreter.SHOT_TRANSITION_SET_RECORDING_PARAMETERS ( )
HUD.HeadsUpDisplayInterpreter.SHOT_TRANSITION_SET_RECORDING_MODE ( )
HUD.HeadsUpDisplayInterpreter.SHOT_START_TRANSITION ( )
HUD.HeadsUpDisplayInterpreter.SHOT_UI_SET_MODE ( )
HUD.HeadsUpDisplayInterpreter.SPOTLIGHT_UI_SET_MODE ( )
HUD.HeadsUpDisplayInterpreter.STORYBOARD_UI_SET_MODE ( )
HUD.HeadsUpDisplayInterpreter.SLIDE_CREATED ( )

There are two ways a slide can be created:

  • by the user, or
  • undo of a slide deletion.
HUD.HeadsUpDisplayInterpreter.SLIDE_DELETED ( )

If a slide is deleted and it's really undoing a slide that was just created, wipe out the 'slide created' message was displayed.

HUD.HeadsUpDisplayInterpreter.SLIDE_ITEM_ADDED ( )
HUD.HeadsUpDisplayInterpreter.SLIDE_ITEM_REMOVED ( )
HUD.HeadsUpDisplayInterpreter.TEXTURE_TRANSFORM_STARTED ( )
HUD.HeadsUpDisplayInterpreter.TEXTURE_TRANSFORM_DRAG_STARTED ( )
HUD.HeadsUpDisplayInterpreter.TEXTURE_TRANSFORM_DRAG_ENDED ( )
HUD.HeadsUpDisplayInterpreter.TEXTURE_TRANSFORM_DONE ( )
HUD.HeadsUpDisplayInterpreter.TEXTURE_TRANSFORM_PIVOT_STARTED ( )
HUD.HeadsUpDisplayInterpreter.TEXTURE_TRANSFORM_PIVOT_DONE ( )
HUD.HeadsUpDisplayInterpreter.TEXTURE_TRANSFORM_DRAG_PIVOT_STARTED ( )
HUD.HeadsUpDisplayInterpreter.TEXTURE_TRANSFORM_DRAG_PIVOT_DONE ( )
HUD.HeadsUpDisplayInterpreter.UI_SET_HUD_DISPLAY_TIME ( )
HUD.HeadsUpDisplayInterpreter.VIEWER_LAYOUT ( )

Viewer layout has changed, eg.

from single view to side by side view.

HUD.HeadsUpDisplayInterpreter.WINDOW_SHOW_BORDERS ( )
HUD.HeadsUpDisplayInterpreter.FRAME_SYNCHRONIZE_END ( )
HUD.HeadsUpDisplayInterpreter.DISPLAY_VERTICAL_FOV_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.NAVIGATION_CAMERA_POSITION_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.NAVIGATION_POSITION ( )
HUD.HeadsUpDisplayInterpreter.NAVIGATION_CAMERA_ROLL_CHANGED ( )
HUD.HeadsUpDisplayInterpreter.SET_DISPLAY_POSITION_AND_SIZE ( )
HUD.HeadsUpDisplayInterpreter.Resize ( )
HUD.HeadsUpDisplayInterpreter.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.

HUD.HeadsUpDisplayInterpreter.Frame ( )

HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter
HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter HUD.HeadsUpDisplayInterpreter