outlinerEditor is undoable, queryable, and editable.
This command creates an outliner editor which can be used to display a list
of objects.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.
|
|
-panel(-pnl)
|
string
|
|
|
Specifies the panel that the editor belongs to. By default if
an editor is created in the create callback of a scripted panel it
will belong to that panel. If an editor doesn't belong to a panel
it will be deleted when the window that it is in is deleted.
|
|
-parent(-p)
|
string
|
|
|
Specifies the parent layout for this editor. This flag will only
have an effect if the editor is currently un-parented.
|
|
-unParent(-up)
|
|
|
|
Specifies that the editor should be removed from its layout.
This cannot be used with query.
|
|
-control(-ctl)
|
|
|
|
Query only. Returns the top level control for this editor.
Usually used for getting a parent to attach popup menus.
Caution: It is possible, at times, for an editor to exist without a
control. This flag returns "NONE" if no control is present.
|
|
-mainListConnection(-mlc)
|
string
|
|
|
Specifies the name of a selectionConnection object which the
editor will use as its source of content. The editor will
only display items contained in the selectionConnection object.
|
|
-forceMainConnection(-fmc)
|
string
|
|
|
Specifies the name of a selectionConnection object which the
editor will use as its source of content. The editor will only
display items contained in the selectionConnection object. This is
a variant of the -mainListConnection flag in that it will force a
change even when the connection is locked. This flag is used to
reduce the overhead when using the -unlockMainConnection
, -mainListConnection, -lockMainConnection flags in immediate
succession.
|
|
-selectionConnection(-slc)
|
string
|
|
|
Specifies the name of a selectionConnection object which the
editor will synchronize with its own selection list. As the user
selects things in this editor, they will be selected in the
selectionConnection object. If the object undergoes changes, the
editor updates to show the change.
|
|
-highlightConnection(-hlc)
|
string
|
|
|
Specifies the name of a selectionConnection object which
the editor will synchronize with its highlight list. Not all
editors have a highlight list. For those that do, it is a secondary
selection list.
|
|
-filter(-f)
|
string
|
|
|
Specifies the name of an itemFilter object to be placed on this editor.
This filters the information coming onto the main list
of the editor.
|
|
-lockMainConnection(-lck)
|
|
|
|
Locks the current list of objects within the mainConnection,
so that only those objects are displayed within the editor.
Further changes to the original mainConnection are ignored.
|
|
-stateString(-sts)
|
|
|
|
Query only flag. Returns the MEL command that will edit an
editor to match the current editor state. The returned command string
uses the string variable $editorName in place of a specific name.
|
|
-unlockMainConnection(-ulk)
|
|
|
|
Unlocks the mainConnection, effectively restoring the original
mainConnection (if it is still available), and dynamic updates.
|
|
-updateMainConnection(-upd)
|
|
|
|
Causes a locked mainConnection to be updated from the orginal
mainConnection, but preserves the lock state.
|
|
-docTag(-dtg)
|
string
|
|
|
Attaches a tag to the Maya editor.
|
|
-showShapes(-shp)
|
boolean
|
|
|
Specifies whether to show shapes or not.
|
|
-showReferenceNodes(-rn)
|
boolean
|
|
|
Specifies whether to show reference nodes or not.
|
|
-showReferenceMembers(-rm)
|
boolean
|
|
|
Specifies whether to show reference node members under the reference node in the outliner.
|
|
-attrFilter(-af)
|
string
|
|
|
Specifies the name of an itemFilter object to be placed on this editor.
This filters the attributes displayed in the editor.
|
|
-showAttributes(-atr)
|
boolean
|
|
|
Specifies whether to show attributes or not.
|
|
-showConnected(-con)
|
boolean
|
|
|
This flag modifies the showAttributes flag. If showAttributes
is set to true then this flag will cause display of only
those attributes that are connected in the dependency graph.
If showAttributes is set to false then this flag does nothing.
|
|
-showAnimCurvesOnly(-aco)
|
boolean
|
|
|
This flag modifies the showConnected flag. If showConnected
is set to true then this flag will cause display of only
those attributes that are connected to an animCurve. If
showConnected is set to false then this flag does nothing.
|
|
-showTextureNodesOnly(-tno)
|
boolean
|
|
|
This flag modifies the showConnected flag. If showConnected is set to true then
this flag will cause display of only those attributes that are connected to a
texture node. If showConnected is set to false then this flag does nothing.
|
|
-showDagOnly(-dag)
|
boolean
|
|
|
This flag specifies whether all dependency graph objects will
be displayed, or just DAG objects.
|
|
-showAssets(-a)
|
boolean
|
|
|
This flags specifies whether assets should be shown in the outliner
|
|
-showContainerContents(-scc)
|
boolean
|
|
|
This flags specifies whether the contents of the container should be
shown under the container node in the outliner
|
|
-showContainedOnly(-sco)
|
boolean
|
|
|
This flags specifies whether nodes belonging to containers should be show
under the container node only. Otherwise, it will show up under the world
as well.
|
|
-showPublishedAsConnected(-spc)
|
boolean
|
|
|
This flags enables attributes that are published to be displayed in italics;
otherwise, only attributes connected as a destination are shown in italics.
|
|
-ignoreDagHierarchy(-hir)
|
boolean
|
|
|
This flag specifies whether or not DAG objects are displayed
in their DAG hierarchy. Warning: using this flag without
some other form of sensible filtering will lead to a very
confusing outliner.
|
|
-autoExpand(-xpd)
|
boolean
|
|
|
This flag specifies whether or not objects that are loaded
in should have their attributes automatically expanded
|
|
-expandConnections(-xc)
|
boolean
|
|
|
This flag specifies whether or not attributes should be
expanded to show their input connections
Note: currently the expansion will only show animCurves
|
|
-showUpstreamCurves(-suc)
|
boolean
|
|
|
Specifies exactly which attributes are displayed when showAttributes
and expandConnections are both true.
If true, the dependency graph is searched upstream for all curves
that drive the selected plugs (showing multiple curves for example
in a typical driven key setup, where first the driven key curve is
encountered, followed by the actual animation curve that drives the
source object). If false, only the first curves encountered
will be shown. Note that, even if false, multiple curves can be shown
if e.g. a blendWeighted node is being used to combine multiple curves.
|
|
-showUnitlessCurves(-su)
|
boolean
|
|
|
This flag (in combination with -expandConnections) specifies
whether or not connection expansion should show unitless
animCurves
|
|
-showCompounds(-cmp)
|
boolean
|
|
|
This flag specifies whether or not compound attributes should be
displayed, or just the leaf attributes
Note: if showConnected is true, and the compound attribute
is connected, it will still be displayed
|
|
-showLeafs(-laf)
|
boolean
|
|
|
This flag specifies whether or not leaf attributes should be
displayed, or just the compound attributes
Note: if showConnected is true, and the leaf attribute
is connected, it will still be displayed
|
|
-showNumericAttrsOnly(-num)
|
boolean
|
|
|
This flag specifies whether or not all attributes should be
displayed, or just numeric attributes
Note: if showConnected is true, and the attribute
is connected, it will still be displayed
|
|
-editAttrName(-ean)
|
boolean
|
|
|
This flag specifies whether or not attribute names can be edited.
By default double-clicking on an attribute will open the expression
editor for that attribute
|
|
-showUVAttrsOnly(-uv)
|
boolean
|
|
|
This flag specifies whether or not all attributes should be displayed, or
just uv attributes Note: currently the only attribute which will be
displayed is Shape.uvSet.uvSetName
|
|
-highlightActive(-ha)
|
boolean
|
|
|
This flag specifies whether or not the outliner should highlight
objects that are active
Note: if the outliner is driving the contents of another editor
setting highlightActive to true may produce unexpected behavior
|
|
-highlightSecondary(-hs)
|
boolean
|
|
|
This flag specifies whether or not the outliner should highlight objects
that are contained in the highlightConnection
|
|
-autoSelectNewObjects(-as)
|
boolean
|
|
|
This flag specifies whether or not new objects added to the outliner
should be automatically selected
|
|
-doNotSelectNewObjects(-dns)
|
boolean
|
|
|
If true this flag specifies that new objects added to the outliner
will not be selected, even if they are active
|
|
-dropIsParent(-dip)
|
boolean
|
|
|
This flag specifies the mode for drag'n'drop. If the flag is true,
dropping items will do a reparent; if it is false, dropping will
reorder items. By default, the flag is true (parent)
|
|
-transmitFilters(-tf)
|
boolean
|
|
|
This flag specifies how the selectionConnection is populated
when attribute filters are enabled. If this flag is set to
true, then all the attributes that pass the filter will be
placed on the selectionConnection. By default this flag is
false
|
|
-showSelected(-sc)
|
boolean
|
|
|
If true then the selected items are expanded in the outliner
|
|
-setFilter(-sf)
|
string
|
|
|
Specifies the name of a filter which is used to filter
which (if any) sets to display.
|
|
-showSetMembers(-ssm)
|
boolean
|
|
|
If true then when a set is expanded, the set members
will be displayed. If false, then only other sets will be
displayed.
|
|
-organizeByLayer(-obl)
|
boolean
|
|
|
If true then when a node with animation layer is displayed, attributes
will be displayed according to the layer(s) it belongs to:
eg:
Layer1
Attr1
Attr2
Layer2
Attr1
If it is false then the outliner will be organized primarily by attributes.
eg:
Attr1
Layer1
Layer2
Attr2
Layer1
|
|
-showAnimLayerWeight(-saw)
|
boolean
|
|
|
If true then when a node with animation layer is displayed, the
weight of the layer will be displayed if it is keyed.
|
|
-autoExpandLayers(-ael)
|
boolean
|
|
|
If true then when a node with animation layer is displayed, all
the animation layers will show up in expanded form.
|
|
-allowMultiSelection(-ams)
|
boolean
|
|
|
If true then multiple selection will be allowed in the outliner.
|
|
-alwaysToggleSelect(-ats)
|
boolean
|
|
|
If true, then clicking on an item in the outliner will select or
deselect it without affecting the selection of other items (unless
allowMultiSelection is false). If false, clicking on an item in the
outliner will replace the current selection with the selected item.
|
|
-directSelect(-ds)
|
boolean
|
|
|
If true then clicking on an item in the outliner will add or
remove just that item from the selection connection. If false then
clicking on an item in the outliner causes the selection connection
to be reloaded with the currently selected items in the outliner.
|
|
-parentObject(-po)
|
|
|
|
-object(-obj)
|
name
|
|
|
This flags is used together with the parentObject flag to get
the name of the parent object for the specified object.
|
|
-displayMode(-dm)
|
string
|
|
|
Affects how the outliner displays when a filter is applied. List mode
is a non-indented flat list. DAG mode indents to represent the
hierarchical structure of the model.
|
|
-expandObjects(-eo)
|
boolean
|
|
|
This flag specifies whether or not objects that are loaded
in should be automatically expanded.
|
|
-setsIgnoreFilters(-sif)
|
boolean
|
|
|
This flag specifies whether or not the filter should be ignored
for expanding sets to show set members (default is true).
|
|
-containersIgnoreFilters(-cif)
|
boolean
|
|
|
This flag specifices whether or not filters should be ignored
when displaying container contents.
|
|
-showAttrValues(-av)
|
boolean
|
|
|
This flag specifies whether attribute values or attribute names should
be displayed. Note: currently only string attributes can have their
values displayed
|
|
-masterOutliner(-mst)
|
string
|
|
|
This flag is the name of an outliner that this outliner will share the objects
and state from. When an outliner is shared, all of its state information
comes from, and is applied to, the master outliner.
|
|
-isChildSelected(-ics)
|
name
|
|
|
This flag allows you to query if one or more of the children of the
specified item is selected in the outliner. The item should be
specified using a unique DAG path. Note that if the specified item
appears multiple times in the outliner, the result will be true if one
or more children of any occurrence of the specified item in the
outliner is/are selected.
|
|
-attrAlphaOrder(-aao)
|
string
|
|
|
Specify how attributes are to be sorted. Current recognised values
are "default" for no sorting and "ascend" to sort attributes from 'a' to ''z' and
"descend" to sort from 'z' to 'a'.
Notes: a) this only applies to top level attributes.
|
|
-animLayerFilterOptions(-alf)
|
string
|
|
|
Specifies whether a filter is to be applied when displaying animation layers.
If so, the options can be "allAffecting" (no filter), "active" (only the active
layers on the object will be displayed) and "animLayerEditor" (the settings will
be taken from the animation layer editor).
|
|
-sortOrder(-so)
|
string
|
|
|
Specify how objects are to be sorted. Current recognised values
are "none" for no sorting and "dagName" to sort DAG objects by name.
Notes: a) non-DAG objects are always sorted by nodeType and name.
b) when sortOrder is set to "dagName", objects cannot be reordered
using drag-and-drop, they can however be reparented
|
|
-longNames(-ln)
|
boolean
|
|
|
Controls whether long or short attribute names will be used
in the interface. Note that this flag is ignored if the -niceNames
flag is set. Default is short names. Queried, returns a boolean.
|
|
-niceNames(-nn)
|
boolean
|
|
|
Controls whether the attribute names will be displayed in
a more user-friendly, readable way. When this is on, the longNames
flag is ignored. When this is off, attribute names will be displayed
either long or short, according to the longNames flag.
Default is on. Queried, returns a boolean.
|
|
-selectCommand(-sec)
|
script
|
|
|
A command to be executed when an item is selected.
|
|
-showNamespace(-sn)
|
boolean
|
|
|
This flag specifies whether all objects will have their
namespace displayed, if namespace different than root.
|
|
-pinPlug(-pin)
|
name
|
|
|
Pins the named plug, so it always appears in the outliner, irrespective
of the incoming selection connection.
In query mode, returns a list of the pinned plugs.
|
|
-unpinPlug(-unp)
|
name
|
|
|
-showPinIcons(-spi)
|
boolean
|
|
|
Sets whether pin icons are shown for unpinned plugs.
|
|
-mapMotionTrails(-mmt)
|
boolean
|
|
|
Sets whether or not we replace the motion trail in the outliner with the object it is trailing.
|
|