Node Messages

Action Messages

• DELETE - Deletes specified nodes. If no nodes are specified, then the selected nodes will be deleted. Each node and all of its children are marked as deleted. This message is undoable and broadcastable.

  Parameters:

  • target1, ..., targetN (tuple) - The IDs of objects to be deleted.

• DUPLICATE - Duplicates specified nodes at the file level (referencing the file rather than duplicating the geometry in the scene). If no nodes are specified, then the selected nodes are duplicated. The node duplicates become selected. This message is undoable and broadcastable. This message will trigger the following response messages: MODEL_IMPORT_DISPLAYED_ALL. This default maximum wait time for this message is 60.

  Parameters:

  • nodeIdList (tuple) - List of nodes to duplicate.

• HIDE - Hides the specified nodes. If no nodes are specified, then the selected nodes are operated on. Each node and all of its children are marked as hidden. This message is undoable and broadcastable.

  Parameters:

  • objects (tuple) - Explicit list of nodes, or the selected objects if empty.

  • removeFromSelection (bool) - True to remove the objects to hide from the selection list (if present).

• HIDE_UNSELECTED - Hides all but the specified nodes. If no nodes are specified, then the selected nodes are operated on. This message is undoable and broadcastable.

  Parameters:

  • objects (tuple) - Explicit list of nodes, or the selected objects if empty.

• MIRROR_DUPLICATE - Mirrors specified nodes. If no nodes are specified, then the selected nodes are mirrored. The nodes mirrored become selected. This message is undoable and broadcastable. This message will trigger the following response messages: MODEL_IMPORT_DISPLAYED_ALL. This default maximum wait time for this message is 60.

  Parameters:

  • axis (unicode) - Axis over which the mirror operation is performed: X, Y, Z.

  • nodeIdList (tuple) - List of nodes to mirror.

• NODE_PARENT - Puts the specified node under the specified parent. This message is undoable and broadcastable.

  Parameters:

  • args (tuple) - Tuples of parenting operations. Each parenting operation is specified by: nodeId - The ID of the node to get a new parent. parentId - The ID of the new parent. maintain3dLocation - If True, the object will not move on the screen, but its local transformation may change. If False, it may move, but its local transformation remains the same. index - If < 0, the node is inserted as the last child of the parent. Otherwise, we try to insert it as the specified child.

• NODE_PARENT_FLAGS - Puts the specified node under the specified parent, with additional control for parent nodes. This message is undoable and broadcastable.

  Parameters:

  • args (tuple) - Tuples of parenting operations. Each parenting operation is specified by: nodeId - The ID of the node to get a new parent. parentId - The ID of the new parent. maintain3dLocation - If True, the object will not move on the screen, but its local transformation may change. If False, it may move, but its local transformation remains the same. old parent maintain scene hierarchy values - Tuple of boolean values representing the flag values up to the root for the original parent of the node in question. new parent maintain scene hierarchy values - Tuple of boolean values representing the flag values up to the root for the new parent of the node in question. index - If < 0, node is inserted as the last child of the parent. Otherwise, we try to insert it as the specified child.

• NODE_RENAME - Renames the specified target nodes. This message is undoable and broadcastable.

  Parameters:

  • targetIds (tuple) - Nodes to rename

  • name (unicode) - New name.

• NODE_SET_PRIORITY - Set priority on passed nodes. This message is undoable and broadcastable.

  Parameters:

  • ids (tuple) - Ids of nodes to assign new priority.

  • priority (int) - Priority to assign to passed nodes: 0 - Undefined, 1 - Excluded, 2 - Low, 3 - Medium, 4 - High.

• SHOW - Makes the specified nodes visible, if they are hidden. Each node's parents are made visible as well. This message is undoable and broadcastable.

  Parameters:

  • nodeId1, ..., nodeIdN (tuple) - The IDs of nodes to show. If none are specified, uses the currently selected objects.

• SHOW_ALL - Shows all nodes. This message is undoable and broadcastable.

• SWAP_HIDDEN_AND_SHOWN - Inverts the visibility of all the nodes. When hidden nodes are made visible, all of their parents are made visible as well. This message is undoable and broadcastable.

• UNDELETE - Marks the specified nodes undeleted. Each node and all of its children are marked as deleted. This message is undoable and broadcastable.

  Parameters:

  • nodeId1, ..., nodeIdN (tuple) - The IDs of nodes to undelete.

Information Messages

• DUPLICATED - Indicates that something was duplicated.

  Parameters:

  • importNodeIds (tuple) - List of IDs of import nodes created by the duplication.

• GEOMETRY_ALL_DELETED - Indicates that all the nodes of the scene graph have been deleted. Sent after APPLICATION_CLOSE_SCENE initiated the deletion of the scene graph, once all the nodes are deleted.

• NODE_PARENTED - Indicates that the specified node has been put under the specified parent.

  Parameters:

  • node (unicode) - The ID of the node that was re-parented.

  • parent (unicode) - The ID of the node that became the new parent.

  • prevParent (unicode) - The ID of the node that was the parent.

  • index (int) - The index of the node as the new child.

• NODE_PRIORITY_CHANGED - Indicates that the priority has changed on the nodes. This message is broadcastable.

• NODE_RENAMED - Indicates that nodes were renamed.

  Parameters:

  • targetIds (tuple) - Nodes renamed

  • name (unicode) - New name.

• REMOVED - Notifies listeners of nodes that have been really removed.

  Parameters:

  • nodeId1, ..., nodeIdN (tuple) - The IDs of nodes that have been removed.

• UNDELETED - Notifies listeners of nodes that have been undeleted.

  Parameters:

  • nodeId1, ..., nodeIdN (tuple) - The IDs of nodes that have been undeleted.

Response Messages

• DELETED - Notifies listeners of nodes that have been deleted.

  Parameters:

  • nodeId1, ..., nodeIdN (tuple) - The IDs of nodes that have been deleted.

• NODE_CREATED - Indicates that a node with the given ID was just created. This message is undoable and broadcastable.

  Parameters:

  • nodeId (unicode) - The ID of the node that was created.

  • index (int) - The index of the node as the child of its parent.