EnvironmentInterpreter.EnvironmentInterpreter Class Reference

#include <class_environment_interpreter_1_1_environment_interpreter.h>

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

List of all members.

Public Member Functions

  __init__ ()
  deactivate ()
  Abstract - to be implemented by the subclasses.
  LIGHT_DIRECTION_CHANGED ()
  LIGHT_POSITION_CHANGED ()
  ENVIRONMENT_EDITING_FINISHED ()
  ENVIRONMENT_GENERATE_HDR_PREVIEW ()
  ENVIRONMENT_UPDATE_PREVIEW_STARTED ()
  DOCUMENT_LOADED ()
  ENVIRONMENT_CONVERT_OLD_SCENE ()
  Create the environment converter and start the conversion.
  ENVIRONMENT_CONVERSION_DONE ()
  ENVIRONMENT_LOADING_DONE ()
  Once all the requested environments are loaded, get the current one from the converter and load it.
  ENVIRONMENT_SAVE_THUMBNAIL ()
  Save a new thumbnail for the current environment.
  APPLICATION_CLOSE_SCENE ()
  MODEL_IMPORT_LOADED ()
  MODEL_IMPORT_FAILED ()
  ENVIRONMENT_LOAD ()
  Loads the environment with the specified id.
  ENVIRONMENT_ADD_GENERIC_TO_SCENE ()
  Add a library environment to the "in" scene environments.
  ENVIRONMENT_RENAME ()
  ENVIRONMENT_DUPLICATE ()
  Duplicate the selected environment in scene.
  ENVIRONMENT_REQUEST_LIST ()
  ENVIRONMENT_ADD_TO_SCENE ()
  Add a new environment and make it as the current one.
  ENVIRONMENT_ADD_TO_SCENE_NO_LOAD ()
  To BUG 351259, when undoing the delete of an in-scene environment, ENVIRONMENT_ADD_TO_SCENE will make the restored environment as current one.
  ENVIRONMENT_REMOVE_FROM_SCENE ()
  Remove an environment from scene.
  ENVIRONMENT_DELETE_FROM_LIBRARY ()
  Deletes a given environment from the library.
  ENVIRONMENT_RESOLVE ()
  Resolves the environment that is marked as "NOT FOUND".
  ENVIRONMENT_SAVE_CURRENT ()
  Save the current environment so that all its overrides are baked into a3s file.
  ENVIRONMENTS_SAVE_WITH_SCENE ()
  Save all environments in scene with scene.
  ENVIRONMENT_SAVE_TO_LIBRARY ()
  Save the new/modified environment to library.
  ENVIRONMENT_RENAME_FROM_LIBRARY ()
  Rename an environment from library, this will rename the actual folder and all associated files in the environment folder.
  ENVIRONMENT_LIBRARY_ADD ()
  Add an new environment library into search path.
  ENVIRONMENT_LIBRARY_REMOVE ()
  Remove an environment library from search path.
  ENVIRONMENT_LIBRARY_REMOVED ()
  The library was removed from search path, then update the corresponding environments in scene.
  ENVIRONMENT_SELECTION_CHANGED ()
  onStateChanged ()
  This is a callback that is called when model import status changes.
  ENVIRONMENT_MODEL_REPLACE ()
  Replace or reload the current environment's model.
  ENVIRONMENT_MODEL_REPLACED ()
  ENVIRONMENT_UPDATE_LIST ()
  The environment list has been changed.
  NODE_CREATED ()
  MODEL_PREPAREANDIMPORT_ALLDONE ()
  Update the environment lighting on all leaf nodes that have been loaded.
  ENVIRONMENT_DELETE_LIGHTING_PARAMETER ()
  ENVIRONMENT_CHANGE_LIGHTING_PARAMETERS ()
  ENVIRONMENT_CHANGE_BACKDROP_IMAGE ()
  ENVIRONMENT_CHANGE_BACKPLATE_PARAMETERS ()
  getTextureFilenames ()
  ENVIRONMENT_IBL_IMAGES_CREATE_STARTED ()
  ENVIRONMENT_IBL_IMAGES_CREATE ()
  VIEWER_LAYOUT ()
  GROUP_COLLAPSED ()
  GROUP_EXPANDED ()
  ENVIRONMENT_SELECT ()
  Selects the current environment model's nodes according the given targetIds, based on the selection mode.
  ENVIRONMENT_APPEARANCE_PARAMETER_CHANGE ()
  Given a targetId, parameter name and parameter string value, edit the current material parameter of the node with the targetId.
  ENVIRONMENT_MATERIAL_CREATE ()
  ENVIRONMENT_MATERIAL_DELETE ()
  ENVIRONMENT_ASSIGN_EXISTING_MATERIAL ()
  ENVIRONMENT_ASSIGN_EXISTING_MATERIAL_NO_BROADCAST ()
  ENVIRONMENT_ASSIGN_LIBRARY_MATERIAL ()
  ENVIRONMENT_MATERIAL_CHANGE_PARAMETER ()
  ENVIRONMENT_MATERIAL_DELETE_PARAMETER ()
  ENVIRONMENT_PANORAMA_TOGGLE_OVERRIDE ()
  Swaps the diffuse texture between the currently applied material and a temporary material stored in the document.
  ENVIRONMENT_TEXTURE_TRANSFORM_START ()
  ENVIRONMENT_TEXTURE_TRANSFORM_FIT ()
  ENVIRONMENT_TEXTURE_TRANSFORM_GLUE ()
  ENVIRONMENT_TEXTURE_MATRIX_TRANSFORM ()
  ENVIRONMENT_TEXTURE_TRANSFORM_END ()
  ENVIRONMENT_GEOMETRY_SET_TRANSFORM ()
  Get the target nodes' ids and let the helper message do the real work.
  ENVIRONMENT_ROTATE_WORLDSPACE ()
  Get the target nodes' ids and let the helper message do the real work.
  ENVIRONMENT_TRANSLATE_WORLDSPACE ()
  Get the target nodes' ids and let the helper message do the real work.
  ENVIRONMENT_GEOMETRY_TRANSFORM_CHANGED ()
  ENVIRONMENT_TRANSLATE_WORLDSPACE_DONE ()
  ENVIRONMENT_ROTATE_WORLDSPACE_DONE ()
  ENVIRONMENT_MATERIAL_ASSIGNMENT_CHANGED ()
  ENVIRONMENT_ROOT_TRANSFORM ()
  ENVIRONMENT_POSITION_FLOOR_UNDER_MODELS ()
  ENVIRONMENT_CENTER_ON_MODELS ()
  ENVIRONMENT_ROOT_SET_DEFAULT_TRANSFORM ()
  ENVIRONMENT_CHANGE_EXPOSURE ()
  STAGE_OPENED ()
  If we are opening an old scene as stage, convert the environments.
  ENVIRONMENT_GENERIC_ADDED ()

Member Function Documentation

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

EnvironmentInterpreter.EnvironmentInterpreter.LIGHT_DIRECTION_CHANGED ( )
EnvironmentInterpreter.EnvironmentInterpreter.LIGHT_POSITION_CHANGED ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_EDITING_FINISHED ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_GENERATE_HDR_PREVIEW ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_UPDATE_PREVIEW_STARTED ( )
EnvironmentInterpreter.EnvironmentInterpreter.DOCUMENT_LOADED ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_CONVERT_OLD_SCENE ( )

Create the environment converter and start the conversion.

Once all the environments are converted, the converted sends ENVIRONMENT_COVERSION_DONE message.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_CONVERSION_DONE ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_LOADING_DONE ( )

Once all the requested environments are loaded, get the current one from the converter and load it.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_SAVE_THUMBNAIL ( )

Save a new thumbnail for the current environment.

EnvironmentInterpreter.EnvironmentInterpreter.APPLICATION_CLOSE_SCENE ( )
EnvironmentInterpreter.EnvironmentInterpreter.MODEL_IMPORT_LOADED ( )
EnvironmentInterpreter.EnvironmentInterpreter.MODEL_IMPORT_FAILED ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_LOAD ( )

Loads the environment with the specified id.

The environment id must refer to an existing environment in the scene

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ADD_GENERIC_TO_SCENE ( )

Add a library environment to the "in" scene environments.

If that library environment already exists in the scene, generate a unique id for it and add it with the new id.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_RENAME ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_DUPLICATE ( )

Duplicate the selected environment in scene.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_REQUEST_LIST ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ADD_TO_SCENE ( )

Add a new environment and make it as the current one.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ADD_TO_SCENE_NO_LOAD ( )

To BUG 351259, when undoing the delete of an in-scene environment, ENVIRONMENT_ADD_TO_SCENE will make the restored environment as current one.

If we don't want this, we may not call ENVIRONMENT_LOAD, we just need copy the environment files to working directory, or else the UI will display Not Found icon for the restored environment.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_REMOVE_FROM_SCENE ( )

Remove an environment from scene.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_DELETE_FROM_LIBRARY ( )

Deletes a given environment from the library.

The environment is physically deleted from the disk.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_RESOLVE ( )

Resolves the environment that is marked as "NOT FOUND".

It replaces the environment that could not be found with the one which is in envFile. If the envFile belongs to a library that is not in the library search paths, it will also add that library to the environment search paths.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_SAVE_CURRENT ( )

Save the current environment so that all its overrides are baked into a3s file.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENTS_SAVE_WITH_SCENE ( )

Save all environments in scene with scene.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_SAVE_TO_LIBRARY ( )

Save the new/modified environment to library.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_RENAME_FROM_LIBRARY ( )

Rename an environment from library, this will rename the actual folder and all associated files in the environment folder.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_LIBRARY_ADD ( )

Add an new environment library into search path.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_LIBRARY_REMOVE ( )

Remove an environment library from search path.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_LIBRARY_REMOVED ( )

The library was removed from search path, then update the corresponding environments in scene.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_SELECTION_CHANGED ( )
EnvironmentInterpreter.EnvironmentInterpreter.onStateChanged ( )

This is a callback that is called when model import status changes.

It should only be called as a consequence of ENVIRONMENT_MODEL_REPLACE message. It sends ENVIRONMENT_MODEL_REPLACED if the passed modelImport belongs to the environment and if its status is "Loaded" and then it disconnects itself from the listener that activates this callback.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_MODEL_REPLACE ( )

Replace or reload the current environment's model.

--Replace with the specified model file when the modelImportId is empty or None. --Reload when the modelImportId is not empty. When reloading, if the model file is specified, reload with it. If not, reload with the current model's file.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_MODEL_REPLACED ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_UPDATE_LIST ( )

The environment list has been changed.

This could be at load time or by the user. Check against the current environment list, and update accordingly

EnvironmentInterpreter.EnvironmentInterpreter.NODE_CREATED ( )
EnvironmentInterpreter.EnvironmentInterpreter.MODEL_PREPAREANDIMPORT_ALLDONE ( )

Update the environment lighting on all leaf nodes that have been loaded.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_DELETE_LIGHTING_PARAMETER ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_CHANGE_LIGHTING_PARAMETERS ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_CHANGE_BACKDROP_IMAGE ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_CHANGE_BACKPLATE_PARAMETERS ( )
EnvironmentInterpreter.EnvironmentInterpreter.getTextureFilenames ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_IBL_IMAGES_CREATE_STARTED ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_IBL_IMAGES_CREATE ( )
EnvironmentInterpreter.EnvironmentInterpreter.VIEWER_LAYOUT ( )
EnvironmentInterpreter.EnvironmentInterpreter.GROUP_COLLAPSED ( )
EnvironmentInterpreter.EnvironmentInterpreter.GROUP_EXPANDED ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_SELECT ( )

Selects the current environment model's nodes according the given targetIds, based on the selection mode.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_APPEARANCE_PARAMETER_CHANGE ( )

Given a targetId, parameter name and parameter string value, edit the current material parameter of the node with the targetId.

The parameter category is one of Appearance.kParameterCategory* values. Note that not all categories may need the targetIds.

We will not process the lighting parameters here. Another interpreter will do it instead.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_MATERIAL_CREATE ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_MATERIAL_DELETE ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ASSIGN_EXISTING_MATERIAL ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ASSIGN_EXISTING_MATERIAL_NO_BROADCAST ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ASSIGN_LIBRARY_MATERIAL ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_MATERIAL_CHANGE_PARAMETER ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_MATERIAL_DELETE_PARAMETER ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_PANORAMA_TOGGLE_OVERRIDE ( )

Swaps the diffuse texture between the currently applied material and a temporary material stored in the document.

The temporary material is tagged so that it is possible to determine whether it is the original material or an override material that is applied to the panorama.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_TEXTURE_TRANSFORM_START ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_TEXTURE_TRANSFORM_FIT ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_TEXTURE_TRANSFORM_GLUE ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_TEXTURE_MATRIX_TRANSFORM ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_TEXTURE_TRANSFORM_END ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_GEOMETRY_SET_TRANSFORM ( )

Get the target nodes' ids and let the helper message do the real work.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ROTATE_WORLDSPACE ( )

Get the target nodes' ids and let the helper message do the real work.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_TRANSLATE_WORLDSPACE ( )

Get the target nodes' ids and let the helper message do the real work.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_GEOMETRY_TRANSFORM_CHANGED ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_TRANSLATE_WORLDSPACE_DONE ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ROTATE_WORLDSPACE_DONE ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_MATERIAL_ASSIGNMENT_CHANGED ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ROOT_TRANSFORM ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_POSITION_FLOOR_UNDER_MODELS ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_CENTER_ON_MODELS ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_ROOT_SET_DEFAULT_TRANSFORM ( )
EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_CHANGE_EXPOSURE ( )
EnvironmentInterpreter.EnvironmentInterpreter.STAGE_OPENED ( )

If we are opening an old scene as stage, convert the environments.

Note, that if the namespace is empty that means it is the main document. The environments have already been converted so don't do anything.

EnvironmentInterpreter.EnvironmentInterpreter.ENVIRONMENT_GENERIC_ADDED ( )

EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter
EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter EnvironmentInterpreter.EnvironmentInterpreter