ShotInterpreter.ShotInterpreter Class Reference

#include <class_shot_interpreter_1_1_shot_interpreter.h>

Inheritance diagram for ShotInterpreter.ShotInterpreter:
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.
  configureEventMapping ()
  Abstract - to be implemented by the subclasses.
  frame ()
  playingFrame ()
  configSnapper ()
  recordingFrame ()
  CreateStillShotWithHotkey ()
  APPLICATION_CLOSE_SCENE ()
  SAVE_SHOTS_AS_MOVIE_START ()
  SAVE_SHOTS_AS_MOVIE_FINISH ()
  SHOT_RECORDING_FINISHED( self, message):
  SHOT_SET_RECORDING_PARAMETERS ()
  SHOT_SET_RECORDING_BASENAME ()
  SHOT_SET_RECORDING_MODE ()
  SAVE_SHOT_AS_MOVIE_AT_RESOLUTION ()
  SHOT_SET_PROGRESS_HANDLER ()
  SHOT_COMPOSE_FRAMES ()
  SHOT_RECORDING_CLEANUP ()
  Clean up files: -Canceled, delete temporary files and output files automatically.
  DOCUMENT_LOADED ()
  NEW_CLIENT_ID ()
  STAGE_SET_STAGE_LIST ()
  VIEWER_LAYOUT ()
  MODEL_DELETED ()
  TRIGGER_ITEM_ADDED ()
  SHOT_REMOVE_MODEL_ID ()
  SHOT_ADD_MODEL_ID ()
  SHOT_CREATE ()
  SHOT_CREATE_FOR_MODEL ()
  SHOT_CREATE_FROM_TEMPLATE ()
  SHOT_CREATE_PARAMETRIC ()
  SHOT_EDIT ()
  CLIENT_CONNECTION_STATUS ()
  SHOT_COPY ()
  SHOT_PASTE ()
  HOTKEY_ASSIGNED ()
  SHOT_DELETE ()
  SHOT_RENAME ()
  SHOT_PLAY_SINGLE ()
  SHOT_PLAY_ALL ()
  SHOT_PLAY ()
  SHOT_PLAY_BYLABEL ()
  SHOT_PLAY_SINGLE_BYLABEL ()
  SHOT_START_PLAYING ()
  SHOT_STOP_PLAYING ()
  SHOT_PAUSE_PLAYBACK ()
  SHOT_RESUME_PLAYBACK ()
  SHOT_TRANSITION_DONE ()
  SHOT_REQUEST_LIST ()
  SHOT_SET_LOOP_MODE ()
  SHOT_REQUEST_LOOP_MODE ()
  SHOT_CHANGE_TYPE ()
  SHOT_SET_PARAMETERS ()
  SHOT_SET_PARAMETERS_FOR_MODEL ()
  SHOT_POSITION_AFTER ()
  SHOT_MOVE_TO_KEYFRAME ()
  SHOT_REFRESH_THUMBNAIL ()
  SHOT_REFRESH_THUMBNAIL_FOR_MODEL ()
  SAVE_SHOTS_AS_SCREEN ()
  SHOT_SAVE_THUMBNAIL ()
  SHOT_IMPORT ()
  This is the entry message of a shot import workflow.
  SHOT_IMPORT_COROUTINE ()
  This message is used by the Coroutine class to implement a transfer from the UI thread to the Message thread.
  NAVIGATION_USER_IS_NAVIGATING ()
  NAVIGATION_GOTO_PREVIOUS_VIEW ()
  NAVIGATION_GOTO_ORTHO_VIEW ()
  BOOKMARK_GOTO ()
  BOOKMARK_HOME ()
  FIT_TO_VIEW ()
  FIT_TO_VIEW_WITH_TARGETS ()
  adjustShotName ()
  Add stageId to the shot name.
  playShots ()

Member Function Documentation

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

ShotInterpreter.ShotInterpreter.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.

ShotInterpreter.ShotInterpreter.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.

ShotInterpreter.ShotInterpreter.frame ( )
ShotInterpreter.ShotInterpreter.playingFrame ( )
ShotInterpreter.ShotInterpreter.configSnapper ( )
ShotInterpreter.ShotInterpreter.recordingFrame ( )
ShotInterpreter.ShotInterpreter.CreateStillShotWithHotkey ( )
ShotInterpreter.ShotInterpreter.APPLICATION_CLOSE_SCENE ( )
ShotInterpreter.ShotInterpreter.SAVE_SHOTS_AS_MOVIE_START ( )
ShotInterpreter.ShotInterpreter.SAVE_SHOTS_AS_MOVIE_FINISH ( )

SHOT_RECORDING_FINISHED( self, message):

ShotInterpreter.ShotInterpreter.SHOT_SET_RECORDING_PARAMETERS ( )
ShotInterpreter.ShotInterpreter.SHOT_SET_RECORDING_BASENAME ( )
ShotInterpreter.ShotInterpreter.SHOT_SET_RECORDING_MODE ( )
ShotInterpreter.ShotInterpreter.SAVE_SHOT_AS_MOVIE_AT_RESOLUTION ( )
ShotInterpreter.ShotInterpreter.SHOT_SET_PROGRESS_HANDLER ( )
ShotInterpreter.ShotInterpreter.SHOT_COMPOSE_FRAMES ( )
ShotInterpreter.ShotInterpreter.SHOT_RECORDING_CLEANUP ( )

Clean up files: -Canceled, delete temporary files and output files automatically.

-Failed, delete temporary files, and delete output files is a option for user. -Successful, delete temporary files used to store individual frames.

ShotInterpreter.ShotInterpreter.DOCUMENT_LOADED ( )
ShotInterpreter.ShotInterpreter.NEW_CLIENT_ID ( )
ShotInterpreter.ShotInterpreter.STAGE_SET_STAGE_LIST ( )
ShotInterpreter.ShotInterpreter.VIEWER_LAYOUT ( )
ShotInterpreter.ShotInterpreter.MODEL_DELETED ( )
ShotInterpreter.ShotInterpreter.TRIGGER_ITEM_ADDED ( )
ShotInterpreter.ShotInterpreter.SHOT_REMOVE_MODEL_ID ( )
ShotInterpreter.ShotInterpreter.SHOT_ADD_MODEL_ID ( )
ShotInterpreter.ShotInterpreter.SHOT_CREATE ( )
ShotInterpreter.ShotInterpreter.SHOT_CREATE_FOR_MODEL ( )
ShotInterpreter.ShotInterpreter.SHOT_CREATE_FROM_TEMPLATE ( )
ShotInterpreter.ShotInterpreter.SHOT_CREATE_PARAMETRIC ( )
ShotInterpreter.ShotInterpreter.SHOT_EDIT ( )
ShotInterpreter.ShotInterpreter.CLIENT_CONNECTION_STATUS ( )
ShotInterpreter.ShotInterpreter.SHOT_COPY ( )
ShotInterpreter.ShotInterpreter.SHOT_PASTE ( )
ShotInterpreter.ShotInterpreter.HOTKEY_ASSIGNED ( )
ShotInterpreter.ShotInterpreter.SHOT_DELETE ( )
ShotInterpreter.ShotInterpreter.SHOT_RENAME ( )
ShotInterpreter.ShotInterpreter.SHOT_PLAY_SINGLE ( )
ShotInterpreter.ShotInterpreter.SHOT_PLAY_ALL ( )
ShotInterpreter.ShotInterpreter.SHOT_PLAY ( )
ShotInterpreter.ShotInterpreter.SHOT_PLAY_BYLABEL ( )
ShotInterpreter.ShotInterpreter.SHOT_PLAY_SINGLE_BYLABEL ( )
ShotInterpreter.ShotInterpreter.SHOT_START_PLAYING ( )
ShotInterpreter.ShotInterpreter.SHOT_STOP_PLAYING ( )
ShotInterpreter.ShotInterpreter.SHOT_PAUSE_PLAYBACK ( )
ShotInterpreter.ShotInterpreter.SHOT_RESUME_PLAYBACK ( )
ShotInterpreter.ShotInterpreter.SHOT_TRANSITION_DONE ( )
ShotInterpreter.ShotInterpreter.SHOT_REQUEST_LIST ( )
ShotInterpreter.ShotInterpreter.SHOT_SET_LOOP_MODE ( )
ShotInterpreter.ShotInterpreter.SHOT_REQUEST_LOOP_MODE ( )
ShotInterpreter.ShotInterpreter.SHOT_CHANGE_TYPE ( )
ShotInterpreter.ShotInterpreter.SHOT_SET_PARAMETERS ( )
ShotInterpreter.ShotInterpreter.SHOT_SET_PARAMETERS_FOR_MODEL ( )
ShotInterpreter.ShotInterpreter.SHOT_POSITION_AFTER ( )
ShotInterpreter.ShotInterpreter.SHOT_MOVE_TO_KEYFRAME ( )
ShotInterpreter.ShotInterpreter.SHOT_REFRESH_THUMBNAIL ( )
ShotInterpreter.ShotInterpreter.SHOT_REFRESH_THUMBNAIL_FOR_MODEL ( )
ShotInterpreter.ShotInterpreter.SAVE_SHOTS_AS_SCREEN ( )
ShotInterpreter.ShotInterpreter.SHOT_SAVE_THUMBNAIL ( )
ShotInterpreter.ShotInterpreter.SHOT_IMPORT ( )

This is the entry message of a shot import workflow.

The message data is a tuple: ( fileName, importer, options ) fileName: the path to the file to be imported, if present and not None, the selectFile will be skipped importer: a ShotImporter instance, if present and not None, the loadFile will be skipped options: import options, if present and not None, the setOptions will

ShotInterpreter.ShotInterpreter.SHOT_IMPORT_COROUTINE ( )

This message is used by the Coroutine class to implement a transfer from the UI thread to the Message thread.

The message data is a callback with no input/output.

This message is only of implementation use and should not be sent outside SHOT_IMPORT.

See Coroutine in ImportShots.py

ShotInterpreter.ShotInterpreter.NAVIGATION_USER_IS_NAVIGATING ( )
ShotInterpreter.ShotInterpreter.NAVIGATION_GOTO_PREVIOUS_VIEW ( )
ShotInterpreter.ShotInterpreter.NAVIGATION_GOTO_ORTHO_VIEW ( )
ShotInterpreter.ShotInterpreter.BOOKMARK_GOTO ( )
ShotInterpreter.ShotInterpreter.BOOKMARK_HOME ( )
ShotInterpreter.ShotInterpreter.FIT_TO_VIEW ( )
ShotInterpreter.ShotInterpreter.FIT_TO_VIEW_WITH_TARGETS ( )
ShotInterpreter.ShotInterpreter.adjustShotName ( )

Add stageId to the shot name.

ShotInterpreter.ShotInterpreter.playShots ( )

ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter
ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter ShotInterpreter.ShotInterpreter