Alternative Messages

Action Messages

• ALTERNATIVE_ADD_ITEMS - Adds geometry nodes to an existing alternative geometry group. This message is undoable and broadcastable.

  Parameters:

  • lineupName (unicode) - The name of the lineup that the alternative belongs to.

  • alternativeName (unicode) - The name of the existing alternative to add geometry nodes to.

  • geometry_list (list) - The list of geometry nodes to be added to the alternative. If the list is empty the currently selected geometry is added.

• ALTERNATIVE_CHOICE - Selects an alternative. This message is undoable and broadcastable.

  Parameters:

  • lineupName (unicode) - The name of the lineup that the alternative to select belongs to.

  • alternativeName (unicode) - The name of the alternative to select.

  • dataList (list) - List of data to set the state to after switching to a given alternative.

• ALTERNATIVE_CHOICE_BYLABEL - Allows an ALTERNATIVE_CHOICE message to be issued by specifying labels instead of names. Since labels need not be unique, and since wildcards are allowed, more than one alternative may match; in that case, only one ALTERNATIVE_CHOICE message will be issued per lineup. This message is undoable.

  Parameters:

  • altLineupLabel (unicode) - Alternative lineup label.

  • altLabel (unicode) - Alternative label.

• ALTERNATIVE_CREATE - Creates a new alternative geometry group in the given alternative lineup. This message is undoable and broadcastable. This message will trigger the following response messages: ALTERNATIVE_SET_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • lineupName (unicode) - The name of the existing alternative lineup.

  • alternativeName (unicode) - The name of the new alternative to be added to the lineup.

  • imageName (unicode) - The name of the image to be applied to the alternative.

  • item_list (list) - The tuple of object IDs to be added to the alternative.

  • setCurrent (bool) - True to make the created set current.

• ALTERNATIVE_CREATE_DATA - Creates a new alternative geometry group in the given alternative lineup. This message is undoable and broadcastable.

  Parameters:

  • lineupName (unicode) - The name of the existing alternative lineup.

  • alternativeName (unicode) - The name of the new alternative to be added to the lineup.

  • imageName (unicode) - The name of the image to be applied to the alternative.

  • item_list (list) - The tuple of items to be added to the alternative, where each tuple is in the form (objectId, objectData). For a positional alternative, the objectData represents the object's world space inclusive transform matrix. For a material alternative, the objectData is the material's name. For a model alternative, the objectData is simply the object's ID. If the list is empty the currently selected geometry is added.

  • setCurrent (bool) - True to make the created set current.

• ALTERNATIVE_CREATE_SET - Creates a new alternative lineup. This message is undoable and broadcastable. This message will trigger the following response messages: ALTERNATIVE_SET_CREATED. This default maximum wait time for this message is 10.

  Parameters:

  • lineupName (unicode) - The name of the new alternative lineup.

  • setType (unicode) - The type of alternative, specified by AlternativeSet.AlternativeType: 'MODEL', 'POSITIONAL', 'MATERIAL'.

• ALTERNATIVE_DELETE - Deletes an existing alternative. This message is undoable and broadcastable.

  Parameters:

  • lineupName (unicode) - The name of the lineup that the alternative belongs to.

  • alternativeName (unicode) - The name of the alternative to be deleted from the lineup.

• ALTERNATIVE_DELETE_SET - Deletes an existing alternative lineup. This message is undoable and broadcastable. This message will trigger the following response messages: ALTERNATIVE_SET_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • lineupName (unicode) - The name of the alternative lineup to be deleted.

• ALTERNATIVE_DUPLICATE - Duplicates the geometry content of an existing alternative and creates a new alternative containing the duplicated geometry. This message is undoable.

  Parameters:

  • lineupName (unicode) - The name of the lineup that the existing alternative belongs to.

  • alternativeName (unicode) - The name of the alternative to be duplicated.

  • newName (unicode) - The name of the newly created alternative.

• ALTERNATIVE_REMOVE_ITEMS - Removes geometry nodes from an existing alternative geometry group. This message is undoable and broadcastable.

  Parameters:

  • lineupName (unicode) - The name of the lineup that the alternative belongs to.

  • alternativeName (unicode) - The name of the existing alternative to remove the geometry from.

  • geometry_list (list) - The list of geometry nodes to be removed from the alternative. If empty the currently selected geometry is removed.

• ALTERNATIVE_RENAME - Changes the label of an existing alternative. This message is undoable and broadcastable.

  Parameters:

  • lineupName (unicode) - The name of the lineup that the alternative belongs to.

  • alternativeName (unicode) - The name of the alternative.

  • newLabel (unicode) - The new label for the alternative.

• ALTERNATIVE_RENAME_SET - Changes the label of an existing alternative lineup. This message is undoable and broadcastable.

  Parameters:

  • lineupName (unicode) - The name of the alternative lineup.

  • newLabel (unicode) - The new label for the lineup.

• ALTERNATIVE_REQUEST_SET_CREATION - Requests the creation of a new alternative lineup. This message displays a popup menu listing the types of alternative lineups to create and then creates the lineup when the user selects the type from the list.

• ALTERNATIVE_SET_IMAGE - Sets an image for an existing alternative. This message is undoable. This message will trigger the following response messages: ALTERNATIVE_IMAGE_SET. This default maximum wait time for this message is 10.

  Parameters:

  • lineupName (unicode) - The name of the lineup that the alternative belongs to.

  • alternativeName (unicode) - The name of the alternative to apply the image to.

  • image (unicode) - The name of the image.

• ALTERNATIVE_UI_SET_MODE - Shows or hides the Alternative Lineups user interface.

  Parameters:

  • visible (bool) - True to show, False to hide.

Information Messages

• ALTERNATIVE_CHANGED - Indicates that the contents of an existing alternative were modified.

  Parameters:

  • lineupType (unicode) - The type of lineup that the modified alternative belonged to, specified by AlternativeSet.AlternativeType: 'MODEL', 'POSITIONAL', 'MATERIAL'.

  • lineupName (unicode) - The name of the lineup that the modified alternative belonged to.

  • alternativeName (unicode) - The name of the alternative that was modified.

• ALTERNATIVE_DELETED - Indicates that an alternative was deleted. This message will trigger the following response messages: ALTERNATIVE_DELETED. This default maximum wait time for this message is 10.

  Parameters:

  • lineupType (unicode) - The type of lineup that the deleted alternative belonged to, specified by AlternativeSet.AlternativeType: 'MODEL', 'POSITIONAL', 'MATERIAL'.

  • lineupName (unicode) - The name of the lineup that the deleted alternative belonged to.

  • alternativeName (unicode) - The name of the alternative that was deleted.

• ALTERNATIVE_RENAMED - Indicates that the label of an alternative changed.

  Parameters:

  • lineupName (unicode) - The name of the lineup that the alternative belongs to.

  • alternativeName (unicode) - The name of the alternative.

  • newLabel (unicode) - The new label for the alternative.

Response Messages

• ALTERNATIVE_IMAGE_SET - Indicates that an image has been set for an alternative.

  Parameters:

  • lineupName (unicode) - The name of the lineup that the alternative belongs to.

  • alternativeName (unicode) - The name of the alternative that the image was applied to.

  • image (unicode) - The name of the image that was applied.

• ALTERNATIVE_SET_CHANGED - Indicates that the contents of an existing alternative lineup were modified.

  Parameters:

  • lineupType (unicode) - The type of alternative lineup that was modified, specified by AlternativeSet.AlternativeType: 'MODEL', 'POSITIONAL', 'MATERIAL'.

  • lineupName (unicode) - The name of the alternative lineup that was modified. An empty string indicates that the alternative lineup was deleted.

• ALTERNATIVE_SET_CREATED - Indicates that an alternative lineup was created.

  Parameters:

  • lineupName (unicode) - The name of the new alternative lineup.

• ALTERNATIVE_SET_DELETED - Notification that an alternative lineup has been deleted.

  Parameters:

  • lineupName (unicode) - The name of the alternative lineup that was deleted.