/
select
select
Description
Enables you to isolate a module or multiple modules for operations.
Select commands are a staple of CG software. Shogun Post provides a flexible array of select functions to meet any selection requirement. This flexibility is especially powerful when deployed in scripts.
When handling scenes containing multiple characters, selection functions become even more important; select -priority
enables you to automatically operate on the identically named modules within multiple character hierarchies without having to explicitly declare verbose paths.
Functional area
Selection
Command syntax
Syntax
select "name1" "name2" ...[-all] [-a] [-r] [-removePrimary] [-invert] [-t] [-priority] [-priorityOnly] |
Arguments
Name | Type | Required | Comments |
---|---|---|---|
name2 | string | no | String name of a second module in the scene |
name1 | string | no | String name of any module in the scene |
Flags
Name | Flag arguments | Argument type | Exclusive to | Comments |
---|---|---|---|---|
all | 0 | — | — | Operates on all modules in the scene. |
a | 0 | — | r | Adds to the existing selection |
r | 0 | — | a | Removes from the existing selection |
removePrimary | 0 | — | a, r | Removes the primary module from the selection. |
invert | 0 | — | a, r, t | Selects all modules not selected and deselects all modules selected. |
t | 0 | — | a, r, invert | Toggles the selection state of the specified modules |
priority | 0 | — | — | Looks under the priority module first for the modules to select. |
priorityOnly | 0 | — | — | Looks under the priority module only for the modules to select. |
Return value
void
Examples
// module LMT1 will be the sole selection after executing this sequence. select LHEL LANK LTOE LMT1 LMT5; select -r LMT1; select -t LHEL LANK LTOE LMT1 LMT5
Additional information
Related commands
, multiple selections available,
Related content
selectByName
selectByName
More like this
setPrimary
setPrimary
More like this
selectSet
selectSet
More like this
selectByPart
selectByPart
More like this
selectBranch
selectBranch
More like this
getSelectionSets
getSelectionSets
More like this