This command creates/edits/queries a nodeEditor editor. The optional argument is the name of the control.
Flags:
Long Name / Short Name | Argument Types | Properties | |
---|---|---|---|
activeTab / at | int | ![]() ![]() |
|
|
|||
addNewNodes / ann | bool | ![]() ![]() ![]() |
|
|
|||
addNode / an | unicode | ![]() |
|
|
|||
additiveGraphingMode / agm | bool | ![]() ![]() ![]() |
|
|
|||
allAttributes / ala | bool | ![]() ![]() ![]() |
|
|
|||
allNodes / aln | bool | ![]() ![]() ![]() |
|
|
|||
allowNewTabs / ant | bool | ![]() |
|
|
|||
allowTabTearoff / att | bool | ![]() ![]() |
|
|
|||
autoSizeNodes / asn | bool | ![]() ![]() ![]() |
|
|
|||
beginCreateNode / bcn | bool | ![]() |
|
Begin interactive node-creation at the mouse position. This will create a control which allows quick creation of a node in the editor.The actual creation is delegated to the createNodeCommand. |
|||
beginNewConnection / bnc | unicode | ![]() |
|
|
|||
breakSelectedConnections / bsc | bool | ![]() |
|
|
|||
closeAllTabs / cat | bool | ![]() |
|
|
|||
closeTab / clt | int | ![]() |
|
Closes the tab on the tab widget at the specified index. Note: using this flag on a torn-off tab will close the node editor since there can be only a single tab. In this case the index argument is ignored. |
|||
consistentNameSize / cns | bool | ![]() ![]() ![]() |
|
When enabled, the size of the node name will consistently match the current zoom level. When disabled, the node name size will remain the same after zooming out past a certain level. Default is on. |
|||
contentsChangedCommand / cc | script | ![]() ![]() ![]() |
|
Specifies a function to be called whenever the contents of the node editor changes. Flag can have multiple arguments, passed either as a tuple or a list. |
|||
control / ctl | bool | ![]() |
|
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 NONEif no control is present. |
|||
createInfo / ci | unicode | ![]() ![]() |
|
|
|||
createNodeCommand / cnc | script | ![]() ![]() ![]() |
|
Specifies a function to be used to create nodes through the editor. The function will be passed the name of the chosen node type. This is used by the tab-create workflow. By default createNodeis used. |
|||
createTab / ct | int, unicode | ![]() ![]() |
|
Create a new tab inserting it into the tab widget at the specified index. If index is out of range (such as -1), the tab is simply appended. You can optionally (Python only) specify a tab label, otherwise it will be set with a default name. In Mel using an empty string () for the tab label will set it with a default name. The new tab becomes the current (active) tab. Note: Only certain Node Editors are allowed to create new tabs, which can be checked by using the -allowNewTabs flag. |
|||
customAttributeListEdit / cal | unicode, unicode | ![]() ![]() |
|
Create/Edit the custom attribute list for the given node by entering a special Edit Modefor the node. Note: only one node in the node editor can be in this edit mode at a time. If another node is selected the edit mode will end automatically. To end the edit mode use an empty string for node.Takes an optional edit mode command which accepts: hideall(sets all the attributes to hidden), showall(sets all the attributes to visible), preview(temporarily shows only the visible attributes), revert(restores the visibility settings of the attributes to what they were before edit mode) and reset(the visible attributes are reset so that only the interesting attributes are displayed).In query mode returns the name of the node, if any, in edit mode. Note: the optional string argument is ignored in query mode. |
|||
cycleHUD / ch | bool | ![]() ![]() |
|
|
|||
defaultPinnedState / dps | bool | ![]() ![]() ![]() |
|
|
|||
defineTemplate / dt | unicode | ![]() |
|
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. |
|||
deleteSelected / deleteSelected | bool | ![]() |
|
|
|||
docTag / dtg | unicode | ![]() ![]() ![]() |
|
|
|||
dotFormat / dot | unicode | ![]() ![]() |
|
In query mode:Get the graph information in DOT format. The flag argument specifies a file path to write to.If -is supplied, the data is returned as a string, otherwise the size in bytes of the written file is returned.In edit mode:Sets the positions of nodes in the graph from a Graphviz output file in plainformat. Only the node position, width and height information is used.If the argument starts with graph , it will be treated as the plain data instead of a filename. |
|||
downstream / ds | bool | ![]() ![]() |
|
|
|||
duplicateTab / dpt | int, int | ![]() ![]() |
|
Duplicates the tab at the specified index, placing it at the second optional (Python only) specified index. To place duplicated tab at the end use -1. The duplicated tab becomes the current (active) tab. Note: Only certain Node Editors are allowed to duplicate tabs, which can be checked by using the -allowNewTabs flag. |
|||
editorMode / em | unicode | ||
exists / ex | bool | ![]() |
|
|
|||
extendToShapes / ets | bool | ![]() ![]() ![]() |
|
|
|||
feedbackConnection / fbc | bool | ![]() |
|
Returns a description of the connection(s) at the current mouse position in the editor view, if any. The connection(s) will be returned as a list of strings, which are pairs of plugs for each connection. |
|||
feedbackNode / fbn | bool | ![]() |
|
|
|||
feedbackPlug / fbp | bool | ![]() |
|
|
|||
feedbackTabIndex / fbi | bool | ![]() |
|
|
|||
feedbackType / fbt | bool | ![]() |
|
Returns the most specific type of the feedback item (item at the current mouse position) in the editor view, if any. Will be one of plug, node, tab, connectionor an empty string. Use the other feedback* flags to query the item description. |
|||
filter / f | unicode | ![]() ![]() ![]() |
|
|
|||
filterCreateNodeTypes / fcn | script | ![]() ![]() ![]() |
|
Specifies a function to be used to filter the list of node types which appear in the inline-creation menu (tab key). The function should accept one string array argument and return a string array. |
|||
focusCommand / fc | script | ![]() ![]() ![]() |
|
|
|||
forceMainConnection / fmc | unicode | ![]() ![]() ![]() |
|
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. |
|||
frameAll / fa | bool | ![]() |
|
|
|||
frameModelSelection / fms | bool | ![]() |
|
|
|||
frameSelected / fs | bool | ![]() |
|
|
|||
getNodeList / gnl | bool | ![]() |
|
|
|||
graphSelectedConnections / gsc | bool | ![]() |
|
|
|||
graphSelection / gsl | bool | ![]() |
|
|
|||
gridSnap / gs | bool | ![]() ![]() ![]() |
|
|
|||
gridVisibility / gv | bool | ![]() ![]() ![]() |
|
|
|||
highlightConnection / hlc | unicode | ![]() ![]() ![]() |
|
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. |
|||
hudMessage / hm | unicode, int, float | ![]() |
|
Display the given message on the editor HUD. The flag arguments are (message, type, duration), where type is:upper-left corner.top center.upper-right corner.center.Duration 0 means the message stays until removed. Duration 0 means it stays for that number of seconds.An empty message erases whatever is currently displayed for the given type. |
|||
ignoreAssets / ia | bool | ![]() ![]() ![]() |
|
|
|||
inContainerView / icv | bool | ![]() |
|
Query only. Returns whether the current editor view is a display of the contents of a particular container. When in such a view, most graphing functionality will be blocked to maintain its accuracy. |
|||
isContainerNode / icn | unicode | ![]() |
|
|
|||
island / isl | bool | ![]() ![]() |
|
|
|||
keyPressCommand / kpc | script | ![]() ![]() ![]() |
|
Specifies a function to be called when a key is pressed and the editor has focus.The function will be passed the name of the editor and an (uppercase) string representation of the key that was pressed, and should return true if the key was handled, and false if it was not.Note: getModifiers can be used to query the current state of key modifiers. |
|||
keyReleaseCommand / krc | script | ![]() ![]() ![]() |
|
Specifies a function to be called when a key is released and the editor has focus.The function will be passed the name of the editor and an (uppercase) string representation of the key that was released, and should return true if the key was handled, and false if it was not.Note: getModifiers can be used to query the current state of key modifiers. |
|||
layout / lay | bool | ![]() |
|
|
|||
layoutCommand / lc | script | ![]() ![]() ![]() |
|
Specifies a function to override the default action when a graph layout is required. The function will be passed the name of editor. The function should arrange the nodes in the graph. |
|||
lockMainConnection / lck | bool | ![]() ![]() |
|
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. |
|||
mainListConnection / mlc | unicode | ![]() ![]() ![]() |
|
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. |
|||
nodeSwatchSize / nss | unicode | ![]() |
|
|
|||
nodeTitleMode / ntm | unicode | ![]() ![]() ![]() |
|
|
|||
nodeViewMode / nvm | unicode | ![]() |
|
Sets the attribute view mode of selected nodes in the active scene (all nodes if none are selected). Mode values are: simple(no attributes displayed), connected(connected attributes only), all(all interesting attributes displayed) and custom(use custom attribute view). |
|||
openContainerView / ocv | unicode, bool | ![]() |
|
Open a view of the contents of the given container node. The boolean argument determines whether or not to open it in a new tab (rather than as a child of the current container) |
|||
panView / pv | float, float | ![]() |
|
|
|||
panel / pnl | unicode | ![]() ![]() |
|
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 | unicode | ![]() ![]() ![]() |
|
|
|||
pinSelectedNodes / psn | bool | ![]() |
|
|
|||
popupMenuScript / pms | script | ![]() ![]() ![]() |
|
Set the script to be called to register the popup menu with the control for this editor. The script will be called with a string argument which gives the name of the editor whose control the popup menu should be parented to. |
|||
primary / pr | bool | ![]() |
|
|
|||
redockTab / rdt | bool | ![]() ![]() |
|
If this tab was torn-off from the primary node editor, then the tab and all its data will be re-docked back into the primary editor and this node editor will be closed. In query mode returns whether this tab was torn-off and is available to be re-docked. |
|||
removeDownstream / rd | bool | ![]() |
|
|
|||
removeNode / rem | unicode | ![]() |
|
|
|||
removeUnselected / run | bool | ![]() |
|
|
|||
removeUpstream / ru | bool | ![]() |
|
|
|||
renameNode / ren | unicode | ![]() |
|
Rename a node in the graph. Depending on the zoom level of the view, an edit field will either appear on the node item or in a popup dialog to allow the new name to be entered. |
|||
renameTab / rt | int, unicode | ![]() |
|
Renames the tab at the specified index with the (optional) name. If no name is specified (Python only) or an empty string () is used then an inline edit field is opened to rename the tab. |
|||
restoreInfo / ri | unicode | ![]() ![]() |
|
|
|||
restoreLastClosedTab / rlt | bool | ![]() ![]() |
|
|
|||
rootNode / rn | unicode | ![]() ![]() |
|
|
|||
rootsFromSelection / rfs | bool | ![]() ![]() |
|
|
|||
scaleView / sv | float | ![]() |
|
|
|||
selectAll / sa | bool | ![]() |
|
|
|||
selectConnectionNodes / scn | bool | ![]() |
|
|
|||
selectDownstream / sd | bool | ![]() |
|
|
|||
selectFeedbackConnection / sfc | bool | ![]() |
|
|
|||
selectNode / sln | unicode | ![]() ![]() |
|
|
|||
selectUpstream / su | bool | ![]() |
|
|
|||
selectionConnection / slc | unicode | ![]() ![]() ![]() |
|
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. |
|||
settingsChangedCallback / scc | script | ![]() ![]() ![]() |
|
|
|||
shaderNetworks / sns | bool | ![]() |
|
|
|||
showAllNodeAttributes / saa | unicode | ![]() |
|
Display all attributes for the given node, not just primary attributes. Passing an empty string will apply this to all currently selected nodes. If no nodes are selected, this will be applied to all displayed nodes in the graph. |
|||
showNamespace / sn | bool | ![]() ![]() ![]() |
|
|
|||
showSGShapes / ssg | bool | ![]() ![]() ![]() |
|
|
|||
showShapes / ss | bool | ![]() ![]() ![]() |
|
|
|||
showTabs / tab | bool | ![]() |
|
Creation time flag to explicitly control the visibility of the tabs. If this is set to true or false the tabs visibility will respect that setting. If this flag is not explicitly set then the tabs will be visible in the primary node editor and tear off tabs, but will not be visible for other editors that are not the primary editor. |
|||
showTransforms / st | bool | ![]() ![]() ![]() |
|
|
|||
stateString / sts | bool | ![]() |
|
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. |
|||
syncedSelection / ssl | bool | ![]() ![]() ![]() |
|
|
|||
tabChangeCommand / tcc | script | ![]() ![]() |
|
Command executed when the current (active) tab is changed. Re-selecting the current tab will not invoke this command. NOTE: This command will also be executed when switching into, out of, and between compound views. |
|||
toggleAttrFilter / taf | bool | ![]() |
|
Toggles the display of the attribute filter field on selected nodes. If any of the selected nodes have the field displayed, this operation will hide the field for all nodes in the selection. If no nodes are selected, this will apply to all displayed nodes. |
|||
toggleSelectedPins / tsp | bool | ![]() |
|
Toggles pinned state on selected nodes. If any selected nodes are unpinned, this operation will choose to pin all nodes. If no nodes are selected, this will apply to all displayed nodes. |
|||
toggleSwatchSize / tss | unicode | ![]() |
|
Toggles the swatch size of the given node between small and large. If supplied node name was empty, this will be applied to selection, and if no nodes are selected this is applied to all nodes in editor. When selection is a combination of small and large swatch sizes, this will set selection to large swatch mode. |
|||
toolTipCommand / ttc | script | ![]() ![]() ![]() |
|
Specifies a function to override the tooltip that is displayed for a node. The function will be passed the name of the node under the cursor, and should return a text string to be displayed. A simple HTML 4 subset is supported. |
|||
traversalDepthLimit / tdl | int | ![]() ![]() ![]() |
|
|
|||
unParent / up | bool | ![]() ![]() |
|
|
|||
unlockMainConnection / ulk | bool | ![]() ![]() |
|
|
|||
updateMainConnection / upd | bool | ![]() ![]() |
|
|
|||
upstream / ups | bool | ![]() ![]() |
|
|
|||
useAssets / ua | bool | ![]() ![]() ![]() |
|
|
|||
useTemplate / ut | unicode | ![]() |
|
|
|||
vnnCompound / vc | bool | ![]() |
|
|
|||
vnnDgContainer / vd | bool | ![]() |
|
|
|||
vnnRuntime / vr | bool | ![]() |
|
|
Derived from mel command maya.cmds.nodeEditor
Example:
import pymel.core as pm
pm.window()
# Result: ui.Window('window1') #
form = pm.formLayout()
p = pm.scriptedPanel(type="nodeEditorPanel", label="Node Editor")
pm.formLayout(form, e=True, af=[(p,s,0) for s in ("top","bottom","left","right")])
# Result: ui.FormLayout('window1|formLayout66') #
pm.showWindow()