Your Ad Here

Go to: Synopsis. Flags. Return value. Python examples.

Synopsis

outlinerEditor( editorName , [allowMultiSelection=boolean], [alwaysToggleSelect=boolean], [attrAlphaOrder=string], [attrFilter=string], [autoExpand=boolean], [autoSelectNewObjects=boolean], [control=boolean], [defineTemplate=string], [directSelect=boolean], [displayMode=string], [doNotSelectNewObjects=boolean], [docTag=string], [dropIsParent=boolean], [edit=boolean], [editAttrName=boolean], [exists=boolean], [expandConnections=boolean], [expandObjects=boolean], [filter=string], [forceMainConnection=string], [highlightActive=boolean], [highlightConnection=string], [highlightSecondary=boolean], [ignoreDagHierarchy=boolean], [isChildSelected=string], [lockMainConnection=boolean], [longNames=boolean], [mainListConnection=string], [masterOutliner=string], [niceNames=boolean], [object=selectionItem], [panel=string], [parent=string], [parentObject=boolean], [query=boolean], [selectCommand=string], [selectionConnection=string], [setFilter=string], [setsIgnoreFilters=boolean], [showAnimCurvesOnly=boolean], [showAttrValues=boolean], [showAttributes=boolean], [showCompounds=boolean], [showConnected=boolean], [showDagOnly=boolean], [showLeafs=boolean], [showNamespace=boolean], [showNumericAttrsOnly=boolean], [showSelected=boolean], [showSetMembers=boolean], [showShapes=boolean], [showTextureNodesOnly=boolean], [showUVAttrsOnly=boolean], [showUnitlessCurves=boolean], [sortOrder=string], [stateString=boolean], [transmitFilters=boolean], [unParent=boolean], [unlockMainConnection=boolean], [updateMainConnection=boolean], [useTemplate=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

outlinerEditor is undoable, queryable, and editable.

This command creates an outliner editor which can be used to display a list of objects.
WARNING: some flag combinations may not behave as you expect. The command is really intended for internal use for creating the outliner used by the various editors.

Flags

allowMultiSelection, alwaysToggleSelect, attrAlphaOrder, attrFilter, autoExpand, autoSelectNewObjects, control, defineTemplate, directSelect, displayMode, doNotSelectNewObjects, docTag, dropIsParent, edit, editAttrName, exists, expandConnections, expandObjects, filter, forceMainConnection, highlightActive, highlightConnection, highlightSecondary, ignoreDagHierarchy, isChildSelected, lockMainConnection, longNames, mainListConnection, masterOutliner, niceNames, object, panel, parent, parentObject, query, selectCommand, selectionConnection, setFilter, setsIgnoreFilters, showAnimCurvesOnly, showAttrValues, showAttributes, showCompounds, showConnected, showDagOnly, showLeafs, showNamespace, showNumericAttrsOnly, showSelected, showSetMembers, showShapes, showTextureNodesOnly, showUVAttrsOnly, showUnitlessCurves, sortOrder, stateString, transmitFilters, unParent, unlockMainConnection, updateMainConnection, useTemplate
Long name (short name) [argument types] Properties
query(q) boolean query
Puts the command in query mode so that it will return the value of the specified flag.

In query mode, this flag needs a value.
edit(e) boolean edit
Puts the command in edit mode so that it will change the values of the specified flags
exists(ex) boolean create
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
defineTemplate(dt) string create
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 create
Will force the command to use a command template other than the current one.
panel(pnl) string createquery
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.

In query mode, this flag needs a value.
parent(p) string createqueryedit
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.

In query mode, this flag needs a value.
unParent(up) boolean createedit
Specifies that the editor should be removed from its layout. This cannot be used with query.
control(ctl) boolean query
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus. CAUTION: editors may not have controls at times. This flag can return "NONE" if no control is present.

In query mode, this flag needs a value.
mainListConnection(mlc) string createqueryedit
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.

In query mode, this flag needs a value.
forceMainConnection(fmc) string createqueryedit
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.

In query mode, this flag needs a value.
selectionConnection(slc) string createqueryedit
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 someone else changes the object, the editor will update to show the change.

In query mode, this flag needs a value.
highlightConnection(hlc) string createqueryedit
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 who do, it is sort of a secondary selection list.

In query mode, this flag needs a value.
filter(f) string createqueryedit
Specifies the name of a filter to be placed on this editor. This filters the information coming onto the main list of the editor.

In query mode, this flag needs a value.
lockMainConnection(lck) boolean createedit
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) boolean query
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.

In query mode, this flag needs a value.
unlockMainConnection(ulk) boolean createedit
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection(upd) boolean createedit
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
docTag(dtg) string createqueryedit
Attaches a tag to the maya editor.

In query mode, this flag needs a value.
showShapes(shp) boolean createqueryedit
Specifies whether to show shapes or not.

In query mode, this flag needs a value.
attrFilter(af) string createqueryedit
Specifies the name of a filter to be placed on this editor. This filters the attributes displayed in the editor.

In query mode, this flag needs a value.
showAttributes(atr) boolean createqueryedit
Specifies whether to show attributes or not.

In query mode, this flag needs a value.
showConnected(con) boolean createqueryedit
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.

In query mode, this flag needs a value.
showAnimCurvesOnly(aco) boolean createqueryedit
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.

In query mode, this flag needs a value.
showTextureNodesOnly(tno) boolean createqueryedit
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.

In query mode, this flag needs a value.
showDagOnly(dag) boolean createqueryedit
This flag specifies whether all dependency graph objects will be displayed, or just DAG objects.

In query mode, this flag needs a value.
ignoreDagHierarchy(hir) boolean createqueryedit
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.

In query mode, this flag needs a value.
autoExpand(xpd) boolean createqueryedit
This flag specifies whether or not objects that are loaded in should have their attributes automatically expanded

In query mode, this flag needs a value.
expandConnections(xc) boolean createqueryedit
This flag specifies whether or not attributes should be expanded to show their input connections Note: currently the expansion will only show animCurves

In query mode, this flag needs a value.
showUnitlessCurves(su) boolean createqueryedit
This flag (in combination with -expandConnections) specifies whether or not connection expansion should show unitless animCurves

In query mode, this flag needs a value.
showCompounds(cmp) boolean createqueryedit
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

In query mode, this flag needs a value.
showLeafs(laf) boolean createqueryedit
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

In query mode, this flag needs a value.
showNumericAttrsOnly(num) boolean createqueryedit
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

In query mode, this flag needs a value.
editAttrName(ean) boolean createqueryedit
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

In query mode, this flag needs a value.
showUVAttrsOnly(uv) boolean createqueryedit
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

In query mode, this flag needs a value.
highlightActive(ha) boolean createqueryedit
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

In query mode, this flag needs a value.
highlightSecondary(hs) boolean createqueryedit
This flag specifies whether or not the outliner should highlight objects that are contained in the highlightConnection

In query mode, this flag needs a value.
autoSelectNewObjects(autoSelectNewObjects) boolean createqueryedit
This flag specifies whether or not new objects added to the outliner should be automatically selected

In query mode, this flag needs a value.
doNotSelectNewObjects(dns) boolean createqueryedit
If true this flag specifies that new objects added to the outliner will not be selected, even if they are active

In query mode, this flag needs a value.
dropIsParent(dip) boolean createqueryedit
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)

In query mode, this flag needs a value.
transmitFilters(tf) boolean createqueryedit
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

In query mode, this flag needs a value.
showSelected(sc) boolean createedit
If true then the selected items are expanded in the outliner
setFilter(sf) string createqueryedit
Specifies the name of a filter which is used to filter which (if any) sets to display.

In query mode, this flag needs a value.
showSetMembers(ssm) boolean createqueryedit
If true then when a set is expanded, the set members will be displayed. If false, then only other sets will be displayed.

In query mode, this flag needs a value.
allowMultiSelection(ams) boolean createedit
If true then multiple selection will be allowed in the outliner.
alwaysToggleSelect(ats) boolean createedit
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 createedit
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) boolean
object(obj) selectionItem query
These two flags are used together to get the name of the parent object for the specified object.

In query mode, this flag needs a value.
displayMode(dm) string createqueryedit
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.

In query mode, this flag needs a value.
expandObjects(eo) boolean createqueryedit
This flag specifies whether or not objects that are loaded in should be automatically expanded.

In query mode, this flag needs a value.
setsIgnoreFilters(sif) boolean createqueryedit
This flag specifies whether or not the filter should be ignored for expanding sets to show set members (default is true).

In query mode, this flag needs a value.
showAttrValues(av) boolean createqueryedit
This flag specifies whether attribute values or attribute names should be displayed. Note: currently only string attributes can have their values displayed

In query mode, this flag needs a value.
masterOutliner(mst) string createqueryedit
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.

In query mode, this flag needs a value.
isChildSelected(ics) string query
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.

In query mode, this flag needs a value.
attrAlphaOrder(aao) string createqueryedit
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.

In query mode, this flag needs a value.
sortOrder(so) string createqueryedit
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

In query mode, this flag needs a value.
longNames(ln) boolean queryedit
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.

In query mode, this flag needs a value.
niceNames(nn) boolean queryedit
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.

In query mode, this flag needs a value.
selectCommand(sec) string createqueryedit
A command to be executed when an item is selected.

In query mode, this flag needs a value.
showNamespace(sn) boolean createqueryedit
This flag specifies whether all objects will have their namespace displayed, if namespace different than root.

In query mode, this flag needs a value.
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 have multiple arguments, passed either as a tuple or a list.

Return value


string (the name of the editor)

Python examples

import maya.cmds as cmds

# Create a new regular outliner in its own window
#
cmds.window()
cmds.frameLayout( labelVisible=False )
panel = cmds.outlinerPanel()
outliner = cmds.outlinerPanel(panel, query=True,outlinerEditor=True)
cmds.outlinerEditor( outliner, edit=True, mainListConnection='worldList', selectionConnection='modelList', showShapes=False, showAttributes=False, showConnected=False, showAnimCurvesOnly=False, autoExpand=False, showDagOnly=True, ignoreDagHierarchy=False, expandConnections=False, showNamespace=True, showCompounds=True, showNumericAttrsOnly=False, highlightActive=True, autoSelectNewObjects=False, doNotSelectNewObjects=False, transmitFilters=False, showSetMembers=True, setFilter='defaultSetFilter' )
cmds.showWindow()

Return to Autodesk Index


Your Ad Here