Modified 2013 Messages

• APPLICATION_CHANGE_VALUE - Convenience message used to send other messages that change values; handles undo and chunking.

  Parameters:

  • message id - Message id.

  • old message data - Message data tuple containing the old value. Only required on first intermediate change.

  • new message data - Message data tuple containing the new value.

  • final - True if this is the final change, and False if this is an intermediate change.

• APPLICATION_RESET_WARNING_DIALOGS - Resets all warning dialogs so that they will be shown.

• BEHAVIOR_PLAYBACK_STARTED - An animation playback from a behavior was started.

• BEHAVIOR_PLAYBACK_STOPPED - The last animation playback from the behaviors has stopped.

• CLOUD_CACHE_STATUS_CHANGED - Indicates that the Cloud Cache Status has changed. (Response message to CLOUD_CHANGE_CACHE_STATUS.)

  Parameters:

  • enabled - True if enable the cache, False if disable it.

• CLOUD_COPY_UPLOADED - Indicates that something was copied to the cloud. (Response message to CLOUD_UPLOAD_COPY.)

• CLOUD_DEFAULT_CACHE_SUBDIR_CHANGED - Indicates that the Cloud copy Subdir has changed. (Response message to CLOUD_SET_DEFAULT_CACHE_SUBDIR.)

  Parameters:

  • subDir - The path to the Cloud copy subdirectory.

• CLOUD_PREFERENCE_CHANGED - Indicates that the Cloud preference has changed. (Response message to CLOUD_CHANGE_PREFERENCE.)

  Parameters:

  • preference - The new preference that has been set.

• CLOUD_USER_INFORMATION - Internal message. Sends the cloud user inforamtion.

  Parameters:

  • firstName - First name of the signed in user.

  • lastName - Last name of the signed in user.

  • userName - User id of the signed in user.

  • brandingSuite - Branding suite name

  • isLoggedIn - True if a user is logged in, False otherwise

  • storage - A tuple with the storage information: (storageQuota, storageUsed)

• COPY_TO_URL_DONE - A local file was copied to where http://localhost:5555/ would see it.

  Parameters:

  • success - True if copied, False otherwise

  • filepaths - List of paths to the local files

  • relativeForURL - List of file locations relative to whatever the web root is.

• COPY_TO_URL_REQUEST - Take a local file and copy it to where http://localhost:5555/ would see it.

  Parameters:

  • filepaths - List of paths to the local files

  • relativeForURLs - List of file locations relative to whatever the web root is.

• DIALOG_SHOWN - A dialog sends this message when it is about to be shown or hidden.

  Parameters:

  • dialog - The dialog clas name that was shown or hidden.

  • show - A boolean, True if the dialog was shown and False if hidden.

• DISPLAY_EXPOSURE_COMPENSATION_CHANGED - Indicates that the exposure compensation value has changed.

  Parameters:

  • newValue - New exposure compensation value

• DISPLAY_PHOTOGRAPHIC_TONEMAP_CHANGED - Indicates that the photographic tonemap have changed.

  Parameters:

  • PhotographicTonemapData - PhotographicTonemapData container with all parameters needed to set tonemapping, includes: active, shutterSpeed, aperture, filmSpeed, highlights, midtones, shadows, colorSaturation,whitePoint, vignetting, gamma

• DISPLAY_SCALEFORM_SHOW - Show or hide the Scaleform interface.

  Parameters:

  • showOrHide - True for show, False for hide

• DISPLAY_SCALEFORM_SIZE_INFO - Information about what the current size of the Scaleform UI is. This does not cause an action inside of Showcase, there is no resizing - this is just an information to Showcase as to what the size is.

  Parameters:

  • width - The current width

  • height - The current height

• DISPLAY_SET_EXPOSURE_COMPENSATION - Sets the exposure compensation value.

  Parameters:

  • newValue - New exposure compensation value

• DISPLAY_SET_FOCAL_LENGTH - Adjusts the camera's focal length to the specified value (in mm). If reposition is True, the camera's location is also adjusted to keep objects at the COI distance a constant size in the view. See also DISPLAY_SET_VERTICAL_FOV.

  Parameters:

  • focalLength - The camera's new focal length (in mm), or None for the default.

  • reposition - True if the camera is to be repositioned, False otherwise.

• DISPLAY_SET_PHOTOGRAPHIC_TONEMAP - Set photographic tonemap parameters for display.

  Parameters:

  • PhotographicTonemapData - PhotographicTonemapData container with all parameters needed to set tonemapping, includes: active, shutterSpeed, aperture, filmSpeed, highlights, midtones, shadows, colorSaturation,whitePoint, vignetting, gamma

• DISPLAY_SET_TONEMAP_PARAMETER - Set photographic tonemap parameter for display.

  Parameters:

  • paramName - Name of the tonemap parameter to change.

  • paramValue - New value for the tonemap parameter.

• ENVIRONMENT_CENTER_ON_MODELS - Translates the environment so that the environment's (x,y) center the same as the bounding box (x, y) center of the model root. If there is no geometry in the scene, the call has no effect.

• ENVIRONMENT_CHANGE_EXPOSURE - Set the new exposure value on the environment.

  Parameters:

  • exposure - The new exposure value.

• ENVIRONMENT_EXPOSURE_CHANGED - Indicates that the environment exposure has been upadated.

  Parameters:

  • exposure - The new exposure value.

• LIGHT_GLOBAL_PHYSICAL_SCALE_CHANGED - Indicates that the physical scale of all non photometric lightsources have changed.

  Parameters:

  • scale - The new global physical scale.

• LIGHT_GRIPS_SET_SIZE - Sets the size of the light grips.

  Parameters:

  • newSize - New size for the light grips.

• LIGHT_GRIPS_SIZE_CHANGED - Indicates that the size of the light grips has changed.

  Parameters:

  • newSize - New size for the light grips.

• LIGHT_SET_GLOBAL_PHYSICAL_SCALE - Sets the physical scale of all non photometric lightsources. The scale is used as a multiplier to tell how many candela the rgb color 1,1,1 is.

  Parameters:

  • scale - The value of the global physical scale.

• LIGHT_VISIBILITY_CHANGED - Indicates that the visibility of some extra light in the scene was modified.

• LINEARIZE_INPUT - Sets whether to linearize input color and texture.

  Parameters:

  • newValue - True if want to linearize color and texture

• LINEARIZE_INPUT_CHANGED - Indicates that the toggle of linearization has been changed.

  Parameters:

  • newValue - True if want to linearize color and texture

• LOCALHOST_URL_ROOT_INFO - Local path to the WebRoot. If not there, empty string.

  Parameters:

  • directorypath - Path to the WebRoot directory

• LOCALHOST_URL_ROOT_REQUEST - Ask for the local path to the WebRoot

• LOCATOR_DECAL_GRIPS_SET_SIZE - Sets the size of the decal grips.

  Parameters:

  • newSize - New size for the decal grips.

• LOCATOR_DECAL_GRIPS_SIZE_CHANGED - Indicates that the size of the decal grips has changed.

  Parameters:

  • newSize - New size for the decal grips.

• MATERIAL_RENAME_ON_NODE - Renames the material of selected node. If the material does not exist, the operation does nothing.

  Parameters:

  • nodeId - The id of node in the scene.

  • newName - The new name of the material on node.

• MODEL_IMPORT_POSTPROCESS_DONE - Indicates that import post-import processing has been completed for these models.

  Parameters:

  • modelIds - The ids of the models that were processed.

• MODEL_PREPARE - Prepares a model for import.

  Parameters:

  • modelImportId - The unique identifier of the model import associated with the geometry to be imported. If this is an empty string, a new model import will be created.

  • inputFileName - The name of the model file to be prepared.

  • journalFileName - The name of the journal file containing tessellation settings. (Default files are in the installation directory.)

• MODEL_PREPARE_BYLABEL - Prepares a model for import.

  Parameters:

  • modelImportId - The unique identifier of the model import associated with the geometry to be imported. If this is an empty string, a new model import will be created.

  • inputFileName - The name of the model file to be prepared.

  • journalFileName - The name of the journal file containing tessellation settings. (Default files are in the installation directory.)

• MODEL_PREPARE_WITH_OPTIONS - Prepares a model for import at the specified position with the specified options.

  Parameters:

  • modelImportId - The unique identifier of the model import associated with the geometry to be imported. If this is an empty string, a new model import will be created.

  • inputFileName - The name of the model file to be prepared.

  • options - Specify the import options.

  • position - Place the model at this position.

• NEW_CLIENT_CONNECTED - Indicates that a new client has connected to the server.

  Parameters:

  • ID - The new client's ID.

  • name - The client name.

  • version - Internal version of the software for the client.

• RT_INTERACTIVE_QUALITY_CHANGED - Indicates that the requested but not promised frame rate for Rapid RT have changed.

  Parameters:

  • fpsRate - The requested frame rate: fps (1-100)

• RT_SET_INTERACTIVE_QUALITY - Sets a requested but not promised frame rate for Rapid RT.

  Parameters:

  • fpsRate - The requested frame rate: fps (1-100)

• SAVE_SHOT_AS_MOVIE_AT_RESOLUTION - Save a movie to the specified location from a specified shot. If the shot is not specified, save them all.

  Parameters:

  • width - The width of the image.

  • height - The height of the image.

  • frames per second - The number of frames per second of the movie.

  • output file type - The output file type. 0 - AVI Movie; 1 - JPEG Image Sequence; 2 - TIFF Image Sequence.

  • antialiasing - The anti-aliasing level. 0 - 9.

  • separate - If all shots are saved, setting this to False would produce a single movie, setting it to True would produce separate movies.

  • filename - The name of the destination movie file.

  • shotNames - List of shot names to save or empty for all.

  • compression - The tuple of items to be set the compressor, which is in the form (compressionName, quality): "compressionName" can be empty for full frame with uncompressed; "quality" is the compression level. 0 - 10000.

  • rtquality - The tuple of items to be set the raytracer, which is in the form (dummyValue, sampleQuality, presetTuple): "dummyValue" is a legacy dummy value. -1. "sampleQuality" defines the sample quality level. 0 - 100. 0 : 1 sample /primary ray 1 - 24: 4 samples/primary ray 25 - 49: 8 samples/primary ray 50 - 74: 16 samples/primary ray 75 - 99: 32 samples/primary ray 100 : 64 samples/primary ray "presetTuple" defines the overall quality preset, which is in the form (file, name, pos): "file" is the name of an XML file which defines a set of raytracing quality parameters. "name" is the name of the preset tag in the XML file. "pos" is the position of the preset_group tag in the XML file.

• SAVE_SLIDE_AS_PRESENTATION - Save a presentation of a selection of storyboard slides to the specified directory.

  Parameters:

  • name - The name of the presentation.

  • width - The width of the image.

  • height - The height of the image.

  • frames per second - The number of frames per second for the presentation.

  • output file type - The output file type. swf for Flash, html for HTML5.

  • individual movie file type - flv, webm or jpeg for the image sequence.

  • antialiasing - The anti-aliasing level. 0 - 9.

  • compression - The tuple of items to be set the compressor, which is in the form (compressionName, quality): "compressionName" can be empty for full frame with uncompressed; "quality" is the compression level. 0 - 10000.

  • rtquality - The tuple of items to be set the raytracer, which is in the form (dummyValue, sampleQuality, presetTuple): "dummyValue" is a legacy dummy value. -1. "sampleQuality" defines the sample quality level. 0 - 100. 0 : 1 sample /primary ray 1 - 24: 4 samples/primary ray 25 - 49: 8 samples/primary ray 50 - 74: 16 samples/primary ray 75 - 99: 32 samples/primary ray 100 : 64 samples/primary ray "presetTuple" defines the overall quality preset, which is in the form (file, name, pos): "file" is the name of an XML file which defines a set of raytracing quality parameters. "name" is the name of the preset tag in the XML file. "pos" is the position of the preset_group tag in the XML file.

  • basename - The name of the presentation. This will create basename.swf as well as basename-presentation directory.

  • slides - The list of slides to use.

  • containers - A list of containers. Each container is a four-element list of label, hide/show key, position data and controls. The position data is a list of anchor (one of CornerTopLeft, CornerTopRight, CornerBottomLeft, CornerBottomeRight, EdgeLeft, EdgeRight, EdgeTop, EdgeBottom), sizeX, sizeY, offsetX, offsetY. Controls is a list of control items. Each control item is a two-element list of a slideId and control data. Control data is a two element list of position data and the shortcut key. The position data is a list of five values for sizeX, sizeY, offsetX, offsetY all relative to the container anchor corner.

  • masks - A pair of images used as the mask for the control icons.

  • font - A pair with the font file location and font size.

  • options - Currently a list of a single value controling if the timeline should be auto-hidden (auto), or always on (on) It may change to include more global options.

• SELECT_BAKED - Selects items with or without baked ambient shadows.

  Parameters:

  • withAS - True if you want objects with baked ambient shadows, False if you want objects without baked ambient shadows.

• SHOT_LIST - Lists all shots in the scene.

  Parameters:

  • how - If 'classes', the internal Python classes are in shotList. If 'primitives', the tuple of primitive values are there instead.

  • shotList - List of shots in the scene. Each element is either a internal Shot class or a tuple of primitive values.

• SHOT_REQUEST_LIST - Requests that a new SHOT_LIST message be issued.

  Parameters:

  • how - If 'classes', the internal Python classes are returned in the SHOT_LIST message. If 'primitives', the tuple of primitive values is returned instead.

• START_SERVER - Starts the hosting server within the current session.

  Parameters:

  • sessionName - The name of the session the server is hosting.

  • machineName - The name of the host machine.

  • port - The port number on which to start the server.

  • hwSync, swSync - Flags for enabling hardware framelock and software synchronization.

• STEEL_WORKFLOW - STEEL workflow message.

  Parameters:

  • name - Workflow name.

  • parameters - dict of parameters. Not all apply to all workflows: CenterEnvironment : boolean, ConstraintNames : string, CreateBehaviorsFromConstraints : boolean, CreateWalkZone : boolean, CurrentDVR : string, DisplayPrecision : string, DisplayUnits : string, Environment : string, EnvironmentScale : float, EnvironmentUsed : string, FilePath : string, GroundLevel : float, LargeScaleEnvironment : string, LargeScaleEnvironmentModelRange : float, LightDirection : string (two floats as azimuth and elevation, or three floats as normalized light direction),MatchEnvironment : boolean, BoundingBoxCenter : string (three floats), BoundingBoxSize : string (three floats), ProjectFilePath : string, SetGroundLevel : boolean, SetGroundLevelBoundingBoxBottom : boolean, TessellationSettings : string, UpdateObjects : boolean, UseProjectFilePath : boolean, VisualStyle : string

  • data - STEEL workflow message data or None.

• STEEL_WORKFLOW_ENDED - Indicates that a STEEL workflow has finished.

  Parameters:

  • name - Workflow name.

  • parameters - dict of parameters.

  • data - STEEL workflow message data or None.

  • success - True if the workflow was successful.

  • message - Status message.

• UI_CONFIRM_DIALOGS_ENABLE - Enable (default) or disable all confirm dialogs.

  Parameters:

  • enable - If set to False, all confirm dialogs will be disabled during the session.

• UI_DEFER_POPUP_MENU - Causes an equivalent UI_DISPLAY_POPOP_MENU to be queued, the result being equivalent to invoking UI_DISPLAY_POPOP_MENU except that the menu is delayed by one message cycle thus allowing other messages to be processed before the modal menu is invoked.

  Parameters:

  • title - The title to display in the menu (if any).

  • popupMenu - A list of menu items. (See "Class GenericPopupMenuItem" in the Showcase API Reference documentation.)

• UI_DISPLAY_POPUP_MENU - Invokes a popup menu under the current cursor position.

  Parameters:

  • title - The title to display in the menu (if any).

  • popupMenu - A list of menu items. (See "Class GenericPopupMenuItem" in the Showcase API Reference documentation.)

• UI_SHOW_MENUBAR - Shows or hides the menu bar. This is actually a "force hide" menubar message. If "showing", there are still operations that will hide it (e.g., full screen mode), but if hiding, there are no operations that will show it.

  Parameters:

  • show - True to show the menus, False to hide them.