nodeOutliner

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

Synopsis

nodeOutliner( [string] , [addCommand=script], [addObject=name], [attrAlphaOrder=string], [connectivity=name], [currentSelection=boolean], [lastMenuChoice=string], [longNames=boolean], [menuCommand=script], [menuMultiOption=boolean], [multiSelect=boolean], [niceNames=boolean], [noConnectivity=boolean], [nodesDisplayed=boolean], [pressHighlightsUnconnected= boolean], [remove=string], [removeAll=boolean], [replace=name], [selectCommand=script], [showConnectedOnly=boolean], [showHidden=boolean], [showInputs=boolean], [showNonConnectable=boolean], [showNonKeyable=boolean], [showOutputs=boolean], [showPublished=boolean], [showReadOnly=boolean])

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

nodeOutliner is undoable, queryable, and editable.

Return value

None

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
addCommand(ac)	script
Command executed when the node outliner adds something. String commands use substitution of the term %node for whatever is added, eg, if you want to print the object added, the command should be "print(\"%node \\n\")". Callable python objects are passed the node name.
addObject(a)	name
add the given object to the display
remove(rm)	string
remove the given object from the display
removeAll(rma)	boolean
remove all objects from the display
replace(rpl)	name
replace what's displayed with the given objects
showInputs(si)	boolean
show only UI visible attributes that can be connected to
showOutputs(so)	boolean
show only UI visible attributes that can be connected from
showPublished(sp)	boolean
Show only published attributes for an asset or a member of an asset. This flag is ignored on nodes not related to assets.
showReadOnly(sro)	boolean
show only read only attributes attributes that can be connected from
showHidden(sh)	boolean
show (true) or hide (false) UI invisible attributes that match the input/output criteria
showNonKeyable(snk)	boolean
show (true) or hide (false) non keyframeable (animatable) attributes that match the input/output criteria
showNonConnectable(snc)	boolean
show (true) or hide (false) non connectable attributes that match the input/output criteria
showConnectedOnly(sco)	boolean
show (true) or hide (false) only attributes that are connected matching input/output criteria
connectivity(c)	name
Takes an attribute argument ("nodeName.attributeName"), dims any attributes that can't connect to the given, and highlights any attributes already connected
noConnectivity(nc)	boolean
Reset the node outliner to not show any connectivity, ie, redraw all rows normally.
multiSelect(ms)	boolean
Allow multiSelect; more than one thing to be selected at a time
selectCommand(sc)	script
Command issued by selecting. Different from the c flag in that this command will only be issued if something is selected.
currentSelection(cs)	boolean
Retruns a string array containing what is currently selected
nodesDisplayed(nd)	boolean
Returns a string array containing the list of nodes showing in the node Outliner
menuCommand(mc)	script
Attaches the given command to each item in the popup menu.
lastMenuChoice(lmc)	string
Returns the text of the most recent menu selection.
menuMultiOption(mmo)	boolean
Sets whether a menu option labelled "next available" will appear as the first option on any multi-attribute's right mouse button menu. Defaults to True.
pressHighlightsUnconnected( phu)	boolean
Sets whether clicking on an unconnected plug will select it or not. Default is True.
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.
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.

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.

Python examples

import maya.cmds as cmds

mywindow = cmds.window()
myform = cmds.formLayout( numberOfDivisions=100 )

# Create an outliner that will print the name of
# every object added to it to history pane of the
# script editor, then display all available input
# plugs on the node.
def onAddNode(name):
    print name
myoutliner = cmds.nodeOutliner( showInputs=True, addCommand=onAddNode )

# Attach the nodeOutliner to the layout
cmds.formLayout( myform, edit=True, attachForm=((myoutliner, 'top', 5), (myoutliner, 'left', 5), (myoutliner, 'bottom', 5), (myoutliner, 'right', 5)) )

# Display the window with the node Outliner
cmds.showWindow( mywindow )

# Create a sphere
objectName = cmds.sphere()

# Have the outliner display the sphere
cmds.nodeOutliner( myoutliner, e=True, a='nurbsSphere1' )