Go to: Synopsis. Return value. Related.
Flags. MEL
examples.
partition [-addSet
name] [-name string]
[-removeSet name] [-render] [string] [string...]
partition is undoable, queryable, and editable.
This command is used to create, query or add/remove sets to a
partition. If a partition name needs to be specified, it is the
first argument, other arguments represent the set names. Without
any flags, the command will create a partition with a default name.
Any sets which are arguments to the command will be added to the
partition. A set can be added to a partition only if none of its
members are in any of the other sets in the partition. If the
-re/render flag is specified when the partition is created, only
'renderable' sets can be added to the partition. Sets can be added
and removed from a partition by using the -addSet or -removeSet
flags. Note: If a set is already selected, and the partition
command is executed, the set will be added to the created
partition.
string |
Name of the partition that was created or edited |
In query mode, return type is based on queried flag.
character, sets
addSet, name,
removeSet, render
Long name (short name) |
Argument types |
Properties |
-name(-n) |
string |
|
|
Assigns the given name to new partition. Valid only for create
mode. |
|
-render(-re) |
|
|
|
New partition can contain render sets. For use in creation mode
only. Default is false. Can also be used with query flag - returns
boolean. |
|
-addSet(-add) |
name |
|
|
Adds the list of sets to the named partition. |
|
-removeSet(-rm) |
name |
|
|
Removes the list of sets from the named partition. |
|
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. |
// To create a partition called p1 which contains set1 and set2 ...
partition -n "p1" set1 set2;
// To create an empty render partition ...
partition -render;
// To add/remove sets from partition p1 ...
partition -add p1 set3;
partition -rm p1 set1;
// To get a list of all sets in a partition ...
partition -q p1;
// To check if the partition is a render partition
partition -q -re p1;