Selection Messages

Action Messages

  • SELECT - Adds items to or removes items from the selection list. Selection with no objects specified in Replace mode will clear the selection list. Selection with the All mode will select all nodes in the scene (regardless of what object IDs are specified). This message is undoable and broadcastable.

    Parameters:

    • objectID1, objectID2 (tuple) - The IDs of objects to select or deselect.

    • operation (unicode) - One of 'Replace', 'Add', 'Subtract' or 'All'.

  • SELECT_VISIBLE - Similar to SELECT, except that only the visible object IDs from the object list are accepted as input. Selection with the 'All' mode will select all visible nodes in the scene. This message is undoable and broadcastable.

    Parameters:

    • objectID1, objectID2 (tuple) - The IDs of objects to select or deselect.

    • operation (unicode) - One of 'Replace', 'Add', 'Subtract' or 'All'.

  • SELECTION_REQUEST_CURRENT - Requests the list of selected items.

  • SELECTION_SET_ADD_ITEMS - Adds geometry nodes to existing selection sets. This message is undoable and broadcastable.

    Parameters:

    • paths (tuple) - The paths to the selection sets to add geometry nodes to (starting from the root nodes in the hierarchies).

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

  • SELECTION_SET_CHANGE_ID - Change the id of an existing selection set or selection set folder. This message is undoable and broadcastable.

    Parameters:

    • path (tuple) - The path to the selection set or selection set folder to be renamed (starting from the root node in the hierarchy).

    • newId (unicode) - The new Id of the selection set or selection set folder.

  • SELECTION_SET_CHANGE_LABEL - Change the label of an existing selection set or selection set folder. This message is undoable and broadcastable.

    Parameters:

    • path (tuple) - The path to the selection set or selection set folder to be renamed (starting from the root node in the hierarchy).

    • newLabel (unicode) - The new label of the selection set or selection set folder.

  • SELECTION_SET_CREATE - Creates a new selection set containing the specified geometry nodes. The new selection set is added under the folder specified by the path. If no geometry nodes are specified, then the selection set will be empty. This message is undoable and broadcastable.

    Parameters:

    • path (tuple) - The path to the folder being modified (starting from the root node in the hierarchy).

    • newName (unicode) - The name of the new selection set.

    • geometry_list (tuple) - The list of geometry nodes to be added to the selection set.

  • SELECTION_SET_CREATE_FOLDER - Creates a new selection set folder, adds the specified nodes to the folder and moves the specified selection sets or folders under the folder. The new folder is added under the folder specified by the path right before the given sibling. If the sibling name is empty, then the new folder will be added as the last member of its parent. This message is undoable and broadcastable.

    Parameters:

    • path (tuple) - The path to the folder being modified (starting from the root node in the hierarchy).

    • newName (unicode) - The name of the new selection set folder.

    • siblingName (unicode) - The name of the sibling indicating where to insert the new folder.

    • pathsToSubItems (tuple) - The list of selection sets or folders to be moved under the new folder.

    • nodeIDs (tuple) - The list of node identifers of nodes to be added to the new folder.

  • SELECTION_SET_CREATE_FROM_TEMPLATE - Creates a selection set hierarchy underneath the root folder from a template. This message is undoable and broadcastable.

    Parameters:

    • template (int) - The template from which to create the selection sets.

    • name (unicode) - The name of the folder at the root of the hierarchy.

  • SELECTION_SET_DELETE - Deletes existing selection sets or selection set folders. This message is undoable and broadcastable.

    Parameters:

    • paths (tuple) - The paths to the selection sets or selection set folders to be deleted (starting from the root nodes in the hierarchies).

  • SELECTION_SET_DUPLICATE - Duplicates existing selection sets or selection set folders, creating new sets and folders referring to the same geometry as the original selection sets and folders. If a set or folder to be duplicated is in a locked folder, then the resulting duplicate will be added at the top folder level. This message is undoable and broadcastable.

    Parameters:

    • paths (tuple) - The paths to existing selection sets or selection set folders to be duplicated (starting from the root nodes in the hierarchies).

  • SELECTION_SET_DUPLICATE_FOLDER - Duplicates an existing selection set folder. This message is undoable and broadcastable. This message will trigger the following response messages: SELECTION_SET_CHANGED. This default maximum wait time for this message is 10.

    Parameters:

    • path (tuple) - The path to the selection set folder to be duplicated (starting from the root node in the hierarchy).

    • newName (unicode) - The name for the duplicated folder.

  • SELECTION_SET_HIDE - Hides all members of the given selection sets or selection set folders. This message is undoable and broadcastable.

    Parameters:

    • paths (tuple) - The paths to selection sets or selection set folders to hide (starting from the root nodes in the hierarchies).

  • SELECTION_SET_MOVE - Moves the given selection set or selection set folder to be under the specified folder. If a sibling is specified, then the set or folder is inserted before the sibling. If no sibling is specified, then the set or folder is added as the last member of the folder. This message is undoable and broadcastable.

    Parameters:

    • path (tuple) - The name of an existing selection set or selection set folder to be moved (starting from the root node in the hierarchy).

    • folderPath (tuple) - The path to an existing selection set folder.

    • name (unicode) - The name of one of the members of the given folder, or empty string. This member will be the sibling of the set or folder once it moves.

  • SELECTION_SET_OPEN - When displayed in the UI, makes the given selection sets or selection set folders appear open. This message is broadcastable.

    Parameters:

    • paths (tuple) - The names of existing selection sets or selection set folders to appear open (starting from the root nodes in the hierarchies).

    • openOrClosed (bool) - True for open, False for closed.

    • changeChildren (bool) - True to change the children of sets and folders too, False to leave them as is.

  • SELECTION_SET_REMOVE_ITEMS - Removes geometry nodes from existing selection sets. This message is undoable and broadcastable.

    Parameters:

    • paths (tuple) - The paths to selection sets with geometry nodes to be removed (starting from the root nodes in the hierarchies).

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

  • SELECTION_SET_SELECT - Selects all members of the given selection sets or selection set folders. This message is undoable.

    Parameters:

    • paths (tuple) - The paths to selection sets or selection set folders to be selected (starting from the root nodes in the hierarchies).

    • operation (unicode) - 'Replace', 'Add', or 'Subtract'.

    • visibleOnly (int) - 0 - select all members; 1 - restrict selection to visible members only.

  • SELECTION_SET_SHOW - Shows all members of the given selection sets or selection set folders. This message is undoable and broadcastable.

    Parameters:

    • paths (tuple) - The paths to selection sets or selection set folders to show (starting from the root nodes in the hierarchies).

  • SELECTION_SET_SORT - Sorts the children of selection set folders in ascending alphabetical order. This is an operation, not a state. This message is broadcastable.

    Parameters:

    • path (tuple) - The name of an existing selection set or folder to be sorted (starting from the root node in the hierarchy).

  • SELECTION_SET_UNGROUP - Ungroups (disbands) a selection set folder. This promotes all the children of the folder to be its siblings, then deletes the folder. This message is undoable and broadcastable.

    Parameters:

    • path (tuple) - The name of an existing selection set folder to be ungrouped (starting from the root node in the hierarchy).

Information Messages

  • SELECTION_CURRENT - Lists currently selected items.

    Parameters:

    • selected (list) - The currently selected items.

  • SELECTION_DISALLOWED - Response message that is sent when the user tries to selectAll but the application is not in the right state for this type of selection yet (i.e., during loading).

    Parameters:

    • info (unicode) - Information explaining why the selection is temporarily disallowed.

  • SELECTION_SET_FOLDER_CREATED - Indicates that a new selection set folder was created.

    Parameters:

    • path (tuple) - The path to the new folder (starting from the root node in the hierarchy).

  • SELECTION_SET_OPEN_STATE_CHANGED - Indicates that the open state of an existing selection set or selection set folder was modified.

  • SELECTION_UNCHANGED - Indicates that the selection list is unchanged. This response message that is sent after a SELECT if the selection list is unchanged by the SELECT message. See also SELECTION_CHANGED.

Response Messages

  • SELECTION_CHANGED - Indicates that the selection list changed. This response message is sent after a SELECT if the selection list is changed by the SELECT message. See also SELECTION_UNCHANGED.

  • SELECTION_SET_CHANGED - Indicates that the contents of an existing selection set or selection set folder were modified.

Generated on Fri Mar 11 2011 19:56:11 by doxygen 1.7.3
Please send us your comment about this page