selectionConnection is undoable, queryable, and editable.
This command creates a named selectionConnection object. This
object is simply a shared selection list. It may be used by editors
to share their highlight data. For example, an outliner may attach
its selected list to one of these objects, and a graph editor may
use the same object as a list source. Then, the graph editor would
only display objects that are selected in the outliner. Selection
connections are UI objects which contain a list of model objects.
Selection connections are useful for specifying which objects are
to be displayed within a particular editor. Editor's have three
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-exists(-ex) |
|
 |
|
Returns true|false depending upon whether the specified object
exists. Other flags are ignored. |
|
-defineTemplate(-dt) |
string |
 |
|
Puts a command in a mode where any other flags and args are
parsed and added to the command template specified in the argument.
They will be used as default arguments in any subsequent
invocations of the command when templateName is set as the current
template. |
|
-useTemplate(-ut) |
string |
 |
|
Force the command to use a command template other than the
current one. |
|
-parent(-p) |
string |
   |
|
The name of a UI object this should be attached to. When the
parent is destroyed, the selectionConnection will auto-delete. If
no parent is specified, the connection is created in the current
controlLayout. |
|
-filter(-f) |
string |
   |
|
Optionally specifies an itemFilter for this connection. An
empty string ("") clears the current filter. If a filter is
specified, all the information going into the selectionConnection
must first pass through the filter before being accepted. NOTE:
filters can only be attached to regular selectionConnections. They
cannot be attached to any connection created using the -act, -mdl,
-key, -wl, -sl, -cl, -lst, -obj, or -ren flags. We strongly
recommend that you do not attach filters to a selectionConnection
--- it is better to attach your filter to the editor that is using
the selectionConnection instead. |
|
-global(-g) |
boolean |
   |
|
A global selection connection cannot be deleted by any script
commands. |
|
-activeList(-act) |
|
 |
|
Specifies that this connection should reflect the active list
(geometry objects and keys). |
|
-modelList(-mdl) |
|
 |
|
Specifies that this connection should reflect the modeling
(i.e. excluding keys) portion of the active list. |
|
-keyframeList(-key) |
|
 |
|
Specifies that this connection should reflect the animation
portion of the active list. |
|
-worldList(-wl) |
|
 |
|
Specifies that this connection should reflect all objects in
the world. |
|
-object(-obj) |
name |
   |
|
Specifies that this connection should wrap around the specified
object (which may be a set). Query will return all the members of
the selection connection (if the connection wraps a set, the set
members will be returned) |
|
-setList(-sl) |
|
 |
|
Specifies that this connection should reflect all the sets in
the world. |
|
-characterList(-cl) |
|
 |
|
Specifies that this connection should reflect all the
characters in the world. |
|
-activeCharacterList(-acl) |
|
 |
|
Specifies that this connection should reflect the characters
that objects on the active list belong to. |
|
-activeCacheList(-atc) |
|
 |
|
Specifies that this connection should reflect the cache that
objects on the active list belong to. |
|
-highlightList(-hl) |
|
 |
|
Specifies that this connection is being used as a highlight
list. |
|
-connectionList(-lst) |
|
  |
|
Specifies that this connection should contain a list of
selection connections. |
|
-switch(-sw) |
|
  |
|
Acts as a modifier to -connectionList which sets the list of
objects to be the first non-empty selection connection. selection
connections are tested in the order in which they are added. |
|
-editor(-ed) |
string |
   |
|
Specifies that this connection should reflect the
-mainListConnection of the specified editor. |
|
-addTo(-add) |
string |
  |
|
The name of a selection connection that should be added to this
list of connections. |
|
-remove(-rm) |
string |
  |
|
The name of a selection connection that should be removed from
this list of connections. |
|
-findObject(-fo) |
name |
 |
|
Find a selection connection in this list that wraps the
specified object. |
|
-identify(-id) |
|
 |
|
Find out what type of selection connection this is. May be:
activeList | modelList | keyframeList | worldList | objectList
listList | editorList | connection | unknown |
|
-lock(-lck) |
boolean |
   |
|
For activeList connections, locking the connection means that
it will not listen to activeList changes. |
|
-clear(-clr) |
|
  |
|
Remove everything from the selection connection. |
|
-addScript(-as) |
script |
   |
|
Specify a script to be called when something is added to the
selection. |
|
-removeScript(-rs) |
script |
   |
|
Specify a script to be called when something is removed from
the selection. |
|
-select(-s) |
name |
  |
|
Add something to the selection. This does not replace the
existing selection. |
|
-deselect(-d) |
name |
  |
|
Remove something from the selection. |
|