Patch Messages

Action Messages

• PATCH_CURRENT_OBJECT - Tells the object patches interpreter which object to operate on. Used to differentiate between patch operation selections and change of object selections.

  Parameters:

  • objectId (unicode) - The ID of the object to operate on. This must be a leaf level, level of detail object.

• PATCH_EXTRACT - Extracts specified patches form a given lod node into a new lod node. This message is undoable and broadcastable.

  Parameters:

  • nodeId (unicode) - Lod node id from which patches are being extracted.

  • patchIndices (tuple) - Indices of patches to extract

• PATCH_KEYMAPPING - Enables or disables the patch keymapping.

  Parameters:

  • enable (bool) - True to enable, False to disable.

• PATCH_MODE - Sets the object patches interpreter mode.

  Parameters:

  • operation (unicode) - The interpreter mode: 'Delete', 'Reverse', or 'Nop' (do nothing).

• PATCH_OPERATION - Performs a patch delete or normal reverse on an object. This message is undoable and broadcastable.

  Parameters:

  • objectId (unicode) - The ID of the object to operate on. This must be a leaf level, level of detail object.

  • index (int) - The patch index. Must be 0.

  • operation (unicode) - Delete or Reverse.

  • value (unicode) - Toggle, False or True.

• PATCH_OPERATION_EXPLICIT - Sets patch delete or patch reverse flags on the object. This message is undoable and broadcastable.

  Parameters:

  • objectId (unicode) - The ID of the object to operate on. This must be a leaf level, level of detail object.

  • operation (unicode) - Delete or Reverse.

  • value (unicode) - A space separated list of indices on which the delete or reverse flag should be set. All other indices will have that value unset. Passing an empty string will reset all values.

• PATCH_OPERATION_MULTI - Performs a patch delete or normal reverse on an object. This message is undoable and broadcastable.

  Parameters:

  • objectId (unicode) - The ID of the object to operate on. This must be a leaf level, level of detail object.

  • indices (tuple) - The list of patch indices. Each must be 0.

  • operation (unicode) - Delete or Reverse.

  • value (unicode) - Toggle, False or True.

• PATCH_REQUEST_STATE - Requests the patch reverse/delete settings for a particular object.

  Parameters:

  • objectId (unicode) - The ID of the object.

• PATCH_SHOW_SELECTED - Notifies whether the patches is showing.

  Parameters:

  • visible (bool) - True means showing the patches, and False means not.

Information Messages

• PATCH_EXTRACTED - Notifies that the PATCH_EXTRACT completed.

  Parameters:

  • sourceNodeId (unicode) - Node id from which patches have been extracted.

  • targetNodeId (unicode) - New node id created from extracted patches.

  • patchIndices (tuple) - Indices of extracted patches.

• PATCH_OPERATION_DONE - Indicates that a patch delete or normal reverse has been performed on an object.

  Parameters:

  • objectId (unicode) - The ID of the object operated on.

  • index (int) - The patch index (valid if 0, considered unspecified if < 0).

• PATCH_SELECTED_SHOWN - This message is a response to the PATCH_SHOW_SELECTED message.

  Parameters:

  • visible (bool) - True means showing the patches, and False means not.

• PATCH_STATE - Provides the patch reverse/delete settings for a particular object. This message is broadcastable.

  Parameters:

  • objectId (unicode) - The ID of the object.

  • patchesReversed (unicode) - A space separated list of indices that indicate reversed patches.

  • patchesDeleted (unicode) - A space separated list of indices that indicate deleted patches.

• PATCH_TAG_CHANGED - Notifies that tagged patches have changed.