pymel.core.windows.nodeOutliner

static windows.nodeOutliner(*args, **kwargs)

The nodeOutliner command creates, edits and queries an outline control that shows dependency nodes and their attributes. Compound attributes are further expandable to show their children. Additional configure flags allow multi selection, customizable commands to issue upon selection, and showing connections (and connectability) to a single input attribute. There are also the abilities to add/remove/replace nodes through the command line interface, and drag/add. In some configurations, dragging a connected attribute of a node will load the node at the other end of the connection. There is a right mouse button menu and a flag to attach a command to it. The menu is used to list the specific connections of a connected attribute. Clicking over any spot but the row of a connected attribute will show an empty menu. By default, there is no command attached to the menu. In query mode, return type is based on queried flag.

Flags:
Long name (short name) Argument Types Properties
addCommand (ac) script ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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) PyNode ../../../_images/edit.gif
 
add the given object to the display
annotation (ann) unicode  
   
attrAlphaOrder (aao) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

Specify how attributes are to be sorted. Current recognised values are defaultfor no sorting and ascendto sort attributes from ‘a’ to ‘’z’ and descendto sort from ‘z’ to ‘a’. Notes: a) this only applies to top level attributes. Flag can have multiple arguments, passed either as a tuple or a list.

backgroundColor (bgc) float, float, float  
   
connectivity (c) PyNode ../../../_images/query.gif ../../../_images/edit.gif
 
Takes an attribute argument (nodeName.attributeName), dims any attributes that can’t connect to the given, and highlights any attributes already connected
currentSelection (cs) bool ../../../_images/query.gif
 
Retruns a string array containing what is currently selected
dc (dc) callable  
   
defineTemplate (dt) unicode  
   
docTag (dtg) unicode  
   
dragCallback (dgc) callable  
   
dropCallback (dpc) callable  
   
enable (en) bool  
   
enableBackground (ebg) bool  
   
exists (ex) bool  
   
fullPathName (fpn) bool  
   
height (h) int  
   
isObscured (io) bool  
   
lastClickedNode (lcn) bool  
   
lastMenuChoice (lmc) unicode ../../../_images/query.gif
 
Returns the text of the most recent menu selection.
longNames (ln) bool ../../../_images/query.gif ../../../_images/edit.gif
 

Controls whether long or short attribute names will be used in the interface. Note that this flag is ignored if the niceNamesflag is set. Default is short names. Queried, returns a boolean.

manage (m) bool  
   
menuCommand (mc) script ../../../_images/edit.gif
 
Attaches the given command to each item in the popup menu.
menuMultiOption (mmo) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Sets whether a menu option labelled next availablewill appear as the first option on any multi-attribute’s right mouse button menu. Defaults to True.
multiSelect (ms) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Allow multiSelect; more than one thing to be selected at a time
niceNames (nn) bool ../../../_images/query.gif ../../../_images/edit.gif
 

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.

noConnectivity (nc) bool ../../../_images/edit.gif
 
Reset the node outliner to not show any connectivity, ie, redraw all rows normally.
nodesDisplayed (nd) bool ../../../_images/query.gif
 
Returns a string array containing the list of nodes showing in the node Outliner
numberOfPopupMenus (npm) bool  
   
parent (p) unicode  
   
popupMenuArray (pma) bool  
   
pressHighlightsUnconnected (phu) bool ../../../_images/query.gif ../../../_images/edit.gif
 
Sets whether clicking on an unconnected plug will select it or not. Default is True.
preventOverride (po) bool  
   
redraw (r) bool  
   
redrawRow (rr) bool  
   
remove (rm) unicode ../../../_images/edit.gif
 
remove the given object from the display
removeAll (rma) bool ../../../_images/edit.gif
 
remove all objects from the display
replace (rpl) PyNode ../../../_images/query.gif ../../../_images/edit.gif
 
replace what’s displayed with the given objects
selectCommand (sc) script ../../../_images/query.gif ../../../_images/edit.gif
 
Command issued by selecting. Different from the cflag in that this command will only be issued if something is selected.
showConnectedOnly (sco) bool ../../../_images/query.gif ../../../_images/edit.gif
 
show (true) or hide (false) only attributes that are connected matching input/output criteria
showHidden (sh) bool ../../../_images/query.gif ../../../_images/edit.gif
 
show (true) or hide (false) UI invisible attributes that match the input/output criteria
showInputs (si) bool ../../../_images/query.gif ../../../_images/edit.gif
 
show only UI visible attributes that can be connected to
showNonConnectable (snc) bool ../../../_images/query.gif ../../../_images/edit.gif
 
show (true) or hide (false) non connectable attributes that match the input/output criteria
showNonKeyable (snk) bool ../../../_images/query.gif ../../../_images/edit.gif
 
show (true) or hide (false) non keyframeable (animatable) attributes that match the input/output criteria
showOutputs (so) bool ../../../_images/query.gif ../../../_images/edit.gif
 
show only UI visible attributes that can be connected from
showPublished (sp) bool ../../../_images/query.gif ../../../_images/edit.gif
 
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) bool ../../../_images/query.gif ../../../_images/edit.gif
 
show only read only attributes attributes that can be connected from
useTemplate (ut) unicode  
   
visible (vis) bool  
   
visibleChangeCommand (vcc) callable  
   
width (w) int  
   

Derived from mel command maya.cmds.nodeOutliner

Example:

import pymel.core as pm

mywindow = pm.window()
myform = pm.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 = pm.nodeOutliner( showInputs=True, addCommand=onAddNode )

# Attach the nodeOutliner to the layout
pm.formLayout( myform, edit=True, attachForm=((myoutliner, 'top', 5), (myoutliner, 'left', 5), (myoutliner, 'bottom', 5), (myoutliner, 'right', 5)) )
# Result: ui.FormLayout('window1|formLayout65') #

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

# Create a sphere
objectName = pm.sphere()

# Have the outliner display the sphere
pm.nodeOutliner( myoutliner, e=True, a='nurbsSphere1' )
# Result: u'window1|formLayout65|nodeOutliner1' #

Previous topic

pymel.core.windows.nodeIconButton

Next topic

pymel.core.windows.nodeTreeLister

Core

Core Modules

Other Modules

This Page