DocumentInterpreter.DocumentInterpreter Class Reference

#include <class_document_interpreter_1_1_document_interpreter.h>

Inheritance diagram for DocumentInterpreter.DocumentInterpreter:
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.
  quit ()
  wantsMessage ()
  If processMessage were to be called at this point would this interpreter handle it?
  processMessage ()
  Abstract - to be implemented by the subclasses.
  DOCUMENT_SET_STATUS ()
  getDocument ()
  documentRead ()
  Reads the contents of the file corresponding to the given filename, into the given document.
  documentWrite ()
  SET_DOCUMENT ()
  APPLICATION_LOAD_SCENE_IMPORTS_COMPLETE ()
  ENVIRONMENT_CHANGED ()
  AMBIENT_OCCLUSION_SHOWN ()
  SSAO_PARAMETER_CHANGED ()
  APPLICATION_CLOSE_SCENE ()
  DOCUMENT_REQUEST_INFO ()
  People can ask for the file name of the loaded document.
  DOCUMENT_SET_UNITS ()
  Change the units of the document.
  DOCUMENT_UNITS_CHANGED ()
  If it is a new document, we need to ensure that we save the units and precision into scene preferences.
  GEOMETRY_ALL_DELETED ()
  QUIT ()
  APPLICATION_NEW_SCENE ()
  APPLICATION_LOAD_SCENE ()
  APPLICATION_IMPORT_SCENE ()
  APPLICATION_EXPORT_SCENE ()
  APPLICATION_SAVE_SCENE ()
  APPLICATION_SAVE_SCENE_WITH_TEXTURES ()
  STAGE_SET_STAGE_LIST ()
  VIEWER_LAYOUT ()
  APPLICATION_SCENE_SAVED ()
  APPLICATION_COMPACT_SCENE_SAVED ()
  COPY_TO_URL_REQUEST ()
  LOCALHOST_URL_ROOT_REQUEST ()

Member Function Documentation

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

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

DocumentInterpreter.DocumentInterpreter.quit ( )
DocumentInterpreter.DocumentInterpreter.wantsMessage ( )

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

Reimplemented from MessageInterpreter.MessageInterpreter.

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

DocumentInterpreter.DocumentInterpreter.DOCUMENT_SET_STATUS ( )
DocumentInterpreter.DocumentInterpreter.getDocument ( )
DocumentInterpreter.DocumentInterpreter.documentRead ( )

Reads the contents of the file corresponding to the given filename, into the given document.

Returns True if it read the file successfully; False otherwise.

DocumentInterpreter.DocumentInterpreter.documentWrite ( )
DocumentInterpreter.DocumentInterpreter.SET_DOCUMENT ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_LOAD_SCENE_IMPORTS_COMPLETE ( )
DocumentInterpreter.DocumentInterpreter.ENVIRONMENT_CHANGED ( )
DocumentInterpreter.DocumentInterpreter.AMBIENT_OCCLUSION_SHOWN ( )
DocumentInterpreter.DocumentInterpreter.SSAO_PARAMETER_CHANGED ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_CLOSE_SCENE ( )
DocumentInterpreter.DocumentInterpreter.DOCUMENT_REQUEST_INFO ( )

People can ask for the file name of the loaded document.

The second argument is if the file has changed since being loaded (e.g., if we need to save.)

DocumentInterpreter.DocumentInterpreter.DOCUMENT_SET_UNITS ( )

Change the units of the document.

DocumentInterpreter.DocumentInterpreter.DOCUMENT_UNITS_CHANGED ( )

If it is a new document, we need to ensure that we save the units and precision into scene preferences.

DocumentInterpreter.DocumentInterpreter.GEOMETRY_ALL_DELETED ( )
DocumentInterpreter.DocumentInterpreter.QUIT ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_NEW_SCENE ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_LOAD_SCENE ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_IMPORT_SCENE ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_EXPORT_SCENE ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_SAVE_SCENE ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_SAVE_SCENE_WITH_TEXTURES ( )
DocumentInterpreter.DocumentInterpreter.STAGE_SET_STAGE_LIST ( )
DocumentInterpreter.DocumentInterpreter.VIEWER_LAYOUT ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_SCENE_SAVED ( )
DocumentInterpreter.DocumentInterpreter.APPLICATION_COMPACT_SCENE_SAVED ( )
DocumentInterpreter.DocumentInterpreter.COPY_TO_URL_REQUEST ( )
DocumentInterpreter.DocumentInterpreter.LOCALHOST_URL_ROOT_REQUEST ( )

DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter
DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter DocumentInterpreter.DocumentInterpreter