Go to: Synopsis. Return value. Related. Flags. MEL examples.

Synopsis

vnnChangeBracket [-close] [-open] string string

vnnChangeBracket is undoable, NOT queryable, and NOT editable.

The vnnChangeBracket command is used to postpone change notifications and graph validation while executing vnn commands. When building a graph by adding/removing nodes or connections, numerous - and usually unwanted - notifications and graph validation can greatly impact performance. It works on either a container or a compound. For a compound, both the names of the container and compound are required, For a container, only its name is needed. Without any flag (-open/-close) vnnChangeBracket can be used to check the change bracket status of said container/compound, true if any change bracket opened, false otherwise.

Return value

booleantrue/false

Related

vnnCompound, vnnConnect

Flags

close, open
Long name (short name) Argument types Properties
-close(-c) create
Close a previously opened change bracket on the container/compound.
-open(-o) create
Open a new change bracket for the container/compound. Notifications and graph validation will be postponed until the change bracket gets closed.

Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

$vnnContainer = "bifrostGraphShape1";
$vnnCompound = "/";

// creating a change bracket for a single compound
vnnChangeBracket $vnnContainer $vnnCompound -open;


// creating a change bracket for an entire container
// will postpone the notification/graph validation of all compounds and nodes
vnnChangeBracket $vnnContainer -open;

// querying the change bracket status of a container
print ("return value before close is " + `vnnChangeBracket $vnnContainer` + "\n");

// close the bracket
vnnChangeBracket $vnnContainer -close;

// querying the change bracket status of a container
print ("return value after close is " + `vnnChangeBracket $vnnContainer` + "\n");

// do stuff
vnnChangeBracket $vnnContainer $vnnCompound -close;

print ("return value after last close is " + `vnnChangeBracket $vnnContainer` + "\n");