pymel.core.windows.nodeOutliner

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Annotate the control with an extra string value.
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.
backgroundColor / bgc float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.
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 ../../../_images/create.gif
  Puts the command in a mode where any other flags and arguments 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.
docTag / dtg unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Add a documentation flag to the control. The documentation flag has a directory structure. (e.g., -dt render/multiLister/createNode/material)
dragCallback / dgc script ../../../_images/create.gif ../../../_images/edit.gif
  Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form: global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTRL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL, 3 == CTRL + SHIFT. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y, modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’
dropCallback / dpc script ../../../_images/create.gif ../../../_images/edit.gif
  Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages, x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d’
enable / en bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
enableBackground / ebg bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Enables the background color of the control.
exists / ex bool ../../../_images/create.gif
  Returns whether the specified object exists or not. Other flags are ignored.
fullPathName / fpn bool ../../../_images/query.gif
  Return the full path name of the widget, which includes all the parents.
height / h int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
highlightColor / hlc float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
isObscured / io bool ../../../_images/query.gif
  Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control’s window is invisible or iconified.
lastClickedNode / lcn bool ../../../_images/query.gif
  Returns a string with the last clicked node
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
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.
noBackground / nbg bool ../../../_images/create.gif ../../../_images/edit.gif
  Clear/reset the control’s background. Passing true means the background should not be drawn at all, false means the background should be drawn. The state of this flag is inherited by children of this control.
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 ../../../_images/query.gif
  Return the number of popup menus attached to this control.
parent / p unicode ../../../_images/create.gif ../../../_images/query.gif
  The parent layout for this control.
popupMenuArray / pma bool ../../../_images/query.gif
  Return the names of all the popup menus attached to this control.
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  If true, this flag prevents overriding the control’s attribute via the control’s right mouse button menu.
redraw / r bool ../../../_images/edit.gif
  Redraws the displayed space
redrawRow / rr bool ../../../_images/edit.gif
  Redraws the given row
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
statusBarMessage / sbm unicode ../../../_images/create.gif ../../../_images/edit.gif
  Extra string to display in the status bar when the mouse is over the control.
useTemplate / ut unicode ../../../_images/create.gif
  Forces the command to use a command template other than the current one.
visible / vis bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The visible state of the control. A control is created visible by default. Note that a control’s actual appearance is also dependent on the visible state of its parent layout(s).
visibleChangeCommand / vcc script ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Command that gets executed when visible state of the control changes.
width / w int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions. Flag can have multiple arguments, passed either as a tuple or a list.

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|formLayout69') #

# 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|formLayout69|nodeOutliner1' #