pymel.core.uitypes.HyperGraph

class HyperGraph

class counterpart of mel function hyperGraph

The following is an overview of the basic features of the hypergraph. A more detailed description is given in the user manuals. The hypergraph provides the user with the ability to view and edit the maya scene graph. The hypergraph supports two types of graphs: the DAG or scene hierarchy and the dependency graph. The default view of the hypergraph editor is the DAG view. The user can show the dependency graph for a collection of nodes by first selecting the nodes and navigating to the dependency graph using one of the graph options. The user can save any view by setting a bookmark to that view. The user can also show previous views using the view options provided. The hypergraph supports a simple editing mechanism for editing hierarchy in the DAG view and connections in dependency graph view. In the DAG view, the user can reparent or reorder nodes in the graph using drag-and-drop. In the dependency graph view, the user can select connections and delete them or make new connections by dragging and dropping nodes or existing connections. The hypergraph supports two layout modes in the DAG view: automatic and freeform. In automatic mode, the graph nodes are automatically positioned according to the layout preferences. In freeform mode, the user can position nodes manually. The node position is saved in the scene. A background image can be placed behind DG or DAG in freeform mode. This can be used as a template for positioning nodes in a user-defined layout. Nodes in the DAG view can be expanded or collapsed. The state is saved in the scene. The performance of the graph drawing will increase as hierarchies are collapsed. In addition to hierachy relationships, the hypergraph can show expression, constraint and deformation relationships in the DAG. These can be enabled/disabled through the options provided. There are also additional filters for showing shape nodes and invisible nodes. The amount of detail show may affect the speed of the display of the graph. Most of the UI features of the hypergraph are addressable through the hypergraph command-line interface. The available command-line options are described in the next section.

addBookmark(val=True, **kwargs)

Create a bookmark for the current hypergraph view.

Derived from mel command maya.cmds.hyperGraph

addDependGraph(val=True, **kwargs)

Add a dependency graph starting at the named node to the view

Derived from mel command maya.cmds.hyperGraph

addDependNode(val=True, **kwargs)

Add a dependency node to the dependency graph view

Derived from mel command maya.cmds.hyperGraph

attributeEditor(val=True, **kwargs)

Launches attribute editor on selected node.

Derived from mel command maya.cmds.hyperGraph

clear(val=True, **kwargs)

Clears the current hypergraph view and deletes the graph UI. (see also -rebuild flag)

Derived from mel command maya.cmds.hyperGraph

collapseContainer(val=True, **kwargs)

Collapses containers selected in DG graph.

Derived from mel command maya.cmds.hyperGraph

connectionDrawStyle(val=True, **kwargs)

Specify how connections between nodes should be drawn. Valid values are “center” (draws connection lines from the center of one node to the center of the other) and “side” (draws connection lines from the right side of the source node to the left side of the destination node). The default is “center”. This flag does not apply to Hypershade graphs, which are always drawn with the “side” connection draw style.

Derived from mel command maya.cmds.hyperGraph

deleteBookmark(val=True, **kwargs)

Delete the bookmark with the corresponding node name.

Derived from mel command maya.cmds.hyperGraph

dependGraph(val=True, **kwargs)

Displays dependency graph iterated from specified node.

Derived from mel command maya.cmds.hyperGraph

dependNode(val=True, **kwargs)

Displays dependency node in view.

Derived from mel command maya.cmds.hyperGraph

down(val=True, **kwargs)

Navigate down to the dependency graph containing the current selection. Shows upstream and downstream connections.

Derived from mel command maya.cmds.hyperGraph

downstream(val=True, **kwargs)

Show downstream dependency graph of selected node(s).

Derived from mel command maya.cmds.hyperGraph

dragAndDropBehaviorCommand(val=True, **kwargs)

Mel proc called when a drag and drop onto a hyperGraph node has occurred. Proc signature is procName (string $editor, string $sourceNode, string $destinationNode).

Derived from mel command maya.cmds.hyperGraph

edgeDblClickCommand(val=True, **kwargs)

Mel proc called when an edge is double clicked. Proc signature is procName (string $editor, string $edge).

Derived from mel command maya.cmds.hyperGraph

edgeDimmedDblClickCommand(val=True, **kwargs)

Mel proc called when a dimmed edge is double clicked. Proc signature is procName (string $editor, string $edge).

Derived from mel command maya.cmds.hyperGraph

enableAutomaticLayout(val=True, **kwargs)

Rebuild the graph if a node is added or removed from the graph via drag and drop or dg messages. Default is true.

Derived from mel command maya.cmds.hyperGraph

expandContainer(val=True, **kwargs)

Expands containers selected in DG graph.

Derived from mel command maya.cmds.hyperGraph

filterDetail(val=True, **kwargs)

This flag is obsolete. Use the showConstraints, showExpressions, showDeformer, showInvisible, showShapes and showUnderworld flags instead.

Derived from mel command maya.cmds.hyperGraph

focusCommand(val=True, **kwargs)

Mel proc to be run when the mouse is clicked in the hyper graph. Primarily of use in setting the window focus.

Derived from mel command maya.cmds.hyperGraph

fold(val=True, **kwargs)

Folds (Collapses) selected object.

Derived from mel command maya.cmds.hyperGraph

forceRefresh(val=True, **kwargs)

Forces the hypergraph to refresh (redraw) its contents.

Derived from mel command maya.cmds.hyperGraph

frame(val=True, **kwargs)

Frames the selected objects

Derived from mel command maya.cmds.hyperGraph

frameBranch(val=True, **kwargs)

Frames the the branch from the selected node on downward.

Derived from mel command maya.cmds.hyperGraph

frameGraph(val=True, **kwargs)

Frames the entire graph.

Derived from mel command maya.cmds.hyperGraph

frameHierarchy(val=True, **kwargs)

Frames the hierarchy that contains the selected node.

Derived from mel command maya.cmds.hyperGraph

getAnimateTransition(**kwargs)

Turns animate transitions off and on.

Derived from mel command maya.cmds.hyperGraph

getBookmarkName(**kwargs)

Returns the bookmark name for the most recently created bookmark.

Derived from mel command maya.cmds.hyperGraph

getControl(**kwargs)

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 “NONE” if no control is present.

Derived from mel command maya.cmds.hyperGraph

getDocTag(**kwargs)

Attaches a tag to the Maya editor.

Derived from mel command maya.cmds.hyperGraph

getDropNode(**kwargs)

Returns the name of the source node in a drag and drop connection, when called during processing of a drop.

Derived from mel command maya.cmds.hyperGraph

getDropTargetNode(**kwargs)

Returns the name of the destination node in a drag and drop connection, when called during processing of a drop.

Derived from mel command maya.cmds.hyperGraph

getFeedbackGadget(**kwargs)

Returns the name of the current gadget.

Derived from mel command maya.cmds.hyperGraph

getFeedbackNode(**kwargs)

Returns the name of the current feedback or highlight node.

Derived from mel command maya.cmds.hyperGraph

getFilter(**kwargs)

Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the main list of the editor.

Derived from mel command maya.cmds.hyperGraph

getForceMainConnection(**kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

getFreeform(**kwargs)

Enable freeform layout mode.

Derived from mel command maya.cmds.hyperGraph

getFromAttr(**kwargs)

Returns the name of the source attribute in a drag and drop connection, when called during processing of a drop.

Derived from mel command maya.cmds.hyperGraph

getGetNodeList(**kwargs)

Returns a string array that represents a list of all the nodes in the graph.

Derived from mel command maya.cmds.hyperGraph

getGetNodePosition(**kwargs)

Returns the position of a specified node in x,y graph coords. This flag and its argument must be passed to the command before the -q flag (see examples). In query mode, this flag can accept a value.

Derived from mel command maya.cmds.hyperGraph

getGraphLayoutStyle(**kwargs)

Selects the graph layout style : “circularLayout”|”hierarchicalLayout”|”orthogonalLayout”|”symmetricLayout”|”treeLayout”

Derived from mel command maya.cmds.hyperGraph

getGraphType(**kwargs)

Returns the type name of the current graph in the view (either DAG or DG).

Derived from mel command maya.cmds.hyperGraph

getHighlightConnection(**kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

getIconSize(**kwargs)

Set or query the icon size for this hyper graph editor. The currently allowed icon sizes are “small”, “medium” and “large”.

Derived from mel command maya.cmds.hyperGraph

getImage(**kwargs)

Specify background image to be loaded from the project image directory.

Derived from mel command maya.cmds.hyperGraph

getImageEnabled(**kwargs)

Enable display of a loaded background image (Freeform DAG view or DG view)

Derived from mel command maya.cmds.hyperGraph

getImageForContainer(**kwargs)

Specify that the following flags work on selected containers instead of the whole image: -imageScale,-imagePosition, fitImageToWidth, -fitImageToHeight, -image

Derived from mel command maya.cmds.hyperGraph

getImagePosition(**kwargs)

Position of the background image.

Derived from mel command maya.cmds.hyperGraph

getImageScale(**kwargs)

Uniform scale of the background image.

Derived from mel command maya.cmds.hyperGraph

getIsHotkeyTarget(**kwargs)

For internal use.

Derived from mel command maya.cmds.hyperGraph

getMainListConnection(**kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

getMergeConnections(**kwargs)

Merge groups of connections into ‘fat’ connections.

Derived from mel command maya.cmds.hyperGraph

getOpaqueContainers(**kwargs)

Sets expanded container background opacity.

Derived from mel command maya.cmds.hyperGraph

getOrientation(**kwargs)

Selects orientation style of graph: “horiz”|”vert”

Derived from mel command maya.cmds.hyperGraph

getPanel(**kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

getRange(**kwargs)

Limits the display of nodes to only those within the range. There are two float values expected, the first the lower threshold of the range and the second the upper threshold of the range. The values are absolute timing values, not percentages.

Derived from mel command maya.cmds.hyperGraph

getSelectionConnection(**kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

getShowConstraints(**kwargs)

Show constraint relationships in the DAG.

Derived from mel command maya.cmds.hyperGraph

getShowDeformers(**kwargs)

Show deformer or geometry filter relationships in the DAG.

Derived from mel command maya.cmds.hyperGraph

getShowExpressions(**kwargs)

Show expression relationships in the DAG.

Derived from mel command maya.cmds.hyperGraph

getShowInvisible(**kwargs)

Show invisible nodes in the DAG.

Derived from mel command maya.cmds.hyperGraph

getShowRelationships(**kwargs)

Show relationship (message) connections.

Derived from mel command maya.cmds.hyperGraph

getShowShapes(**kwargs)

Show shape nodes in the DAG.

Derived from mel command maya.cmds.hyperGraph

getShowUnderworld(**kwargs)

Show underworld graphs in the DAG.

Derived from mel command maya.cmds.hyperGraph

getStateString(**kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

getTransitionFrames(**kwargs)

Specify te number of transition frames for animate transitions.

Derived from mel command maya.cmds.hyperGraph

getUpdateNodeAdded(**kwargs)

Update graph when a new node is added to the database

Derived from mel command maya.cmds.hyperGraph

getUpdateSelection(**kwargs)

Update selection state in the graph when the selection state of database changes.

Derived from mel command maya.cmds.hyperGraph

getUseFeedbackList(**kwargs)

Use feedback or highlight list as the target selection when processing other hypergraph command-line options.

Derived from mel command maya.cmds.hyperGraph

getViewOption(**kwargs)

Set or query the view option for this hyper graph editor. The currently allowed views are “asIcons” and “asList”.

Derived from mel command maya.cmds.hyperGraph

layout(val=True, **kwargs)

Perform an automatic layout on the graph.

Derived from mel command maya.cmds.hyperGraph

layoutSelected(val=True, **kwargs)

Perform an automatic layout on the selected object. “circularLayout”|”hierarchicalLayout”|”orthogonalLayout”|”symmetricLayout”|”treeLayout”

Derived from mel command maya.cmds.hyperGraph

lockMainConnection(val=True, **kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

look(val=True, **kwargs)

Look at a coordinate in the graph view

Derived from mel command maya.cmds.hyperGraph

navigateHome(val=True, **kwargs)

Navigate to the home (DAG) view.

Derived from mel command maya.cmds.hyperGraph

nextView(val=True, **kwargs)

Changes the view to the next DAG view.

Derived from mel command maya.cmds.hyperGraph

nodeDropCommand(val=True, **kwargs)

Set the command to be called when a node is dropped in the hypergraph window.

Derived from mel command maya.cmds.hyperGraph

nodePressCommand(val=True, **kwargs)

Set the command to be called when the user presses a mouse button while the cursor is over a node in the hypergraph window.

Derived from mel command maya.cmds.hyperGraph

nodeReleaseCommand(val=True, **kwargs)

Set the command to be called when the user releases a mouse button while the cursor is over a node in the hypergraph window.

Derived from mel command maya.cmds.hyperGraph

popupMenuScript(val=True, **kwargs)

Set the script to be called to register the popup menu with the control for this hypergraph. The script will be called with a string argument which gives the name of the hypergraph whose control the popup menu should be parented to.

Derived from mel command maya.cmds.hyperGraph

previousView(val=True, **kwargs)

Changes the view back to the previous DAG view.

Derived from mel command maya.cmds.hyperGraph

rebuild(val=True, **kwargs)

Rebuilds graph

Derived from mel command maya.cmds.hyperGraph

removeNode(val=True, **kwargs)

Removes the node identified by string from the graph.

Derived from mel command maya.cmds.hyperGraph

resetFreeform(val=True, **kwargs)

Resets freeform position on all nodes.

Derived from mel command maya.cmds.hyperGraph

restoreBookmark(val=True, **kwargs)

Restore the view corresponding to the bookmark.

Derived from mel command maya.cmds.hyperGraph

scrollUpDownNoZoom(val=True, **kwargs)

Specify if we want to be in the scroll along y only with no free zooming mode. By default, hyper graph editor allows user to pan left and right.

Derived from mel command maya.cmds.hyperGraph

setAnimateTransition(val=True, **kwargs)

Turns animate transitions off and on.

Derived from mel command maya.cmds.hyperGraph

setDocTag(val=True, **kwargs)

Attaches a tag to the Maya editor.

Derived from mel command maya.cmds.hyperGraph

setFilter(val=True, **kwargs)

Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the main list of the editor.

Derived from mel command maya.cmds.hyperGraph

setForceMainConnection(val=True, **kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

setFreeform(val=True, **kwargs)

Enable freeform layout mode.

Derived from mel command maya.cmds.hyperGraph

setGraphLayoutStyle(val=True, **kwargs)

Selects the graph layout style : “circularLayout”|”hierarchicalLayout”|”orthogonalLayout”|”symmetricLayout”|”treeLayout”

Derived from mel command maya.cmds.hyperGraph

setHighlightConnection(val=True, **kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

setIconSize(val=True, **kwargs)

Set or query the icon size for this hyper graph editor. The currently allowed icon sizes are “small”, “medium” and “large”.

Derived from mel command maya.cmds.hyperGraph

setImage(val=True, **kwargs)

Specify background image to be loaded from the project image directory.

Derived from mel command maya.cmds.hyperGraph

setImageEnabled(val=True, **kwargs)

Enable display of a loaded background image (Freeform DAG view or DG view)

Derived from mel command maya.cmds.hyperGraph

setImageForContainer(val=True, **kwargs)

Specify that the following flags work on selected containers instead of the whole image: -imageScale,-imagePosition, fitImageToWidth, -fitImageToHeight, -image

Derived from mel command maya.cmds.hyperGraph

setImagePosition(val=True, **kwargs)

Position of the background image.

Derived from mel command maya.cmds.hyperGraph

setImageScale(val=True, **kwargs)

Uniform scale of the background image.

Derived from mel command maya.cmds.hyperGraph

setMainListConnection(val=True, **kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

setMergeConnections(val=True, **kwargs)

Merge groups of connections into ‘fat’ connections.

Derived from mel command maya.cmds.hyperGraph

setNodePosition(val=True, **kwargs)

Sets the node identified by string to the (x,y) position in the window specified by the two floats. If the node is not in the graph than it will be added to the graph and then moved to the new position.

Derived from mel command maya.cmds.hyperGraph

setOpaqueContainers(val=True, **kwargs)

Sets expanded container background opacity.

Derived from mel command maya.cmds.hyperGraph

setOrientation(val=True, **kwargs)

Selects orientation style of graph: “horiz”|”vert”

Derived from mel command maya.cmds.hyperGraph

setParent(val=True, **kwargs)

Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.

Derived from mel command maya.cmds.hyperGraph

setRange(val=True, **kwargs)

Limits the display of nodes to only those within the range. There are two float values expected, the first the lower threshold of the range and the second the upper threshold of the range. The values are absolute timing values, not percentages.

Derived from mel command maya.cmds.hyperGraph

setSelectionConnection(val=True, **kwargs)

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.

Derived from mel command maya.cmds.hyperGraph

setShowConstraints(val=True, **kwargs)

Show constraint relationships in the DAG.

Derived from mel command maya.cmds.hyperGraph

setShowDeformers(val=True, **kwargs)

Show deformer or geometry filter relationships in the DAG.

Derived from mel command maya.cmds.hyperGraph

setShowExpressions(val=True, **kwargs)

Show expression relationships in the DAG.

Derived from mel command maya.cmds.hyperGraph

setShowInvisible(val=True, **kwargs)

Show invisible nodes in the DAG.

Derived from mel command maya.cmds.hyperGraph

setShowRelationships(val=True, **kwargs)

Show relationship (message) connections.

Derived from mel command maya.cmds.hyperGraph

setShowShapes(val=True, **kwargs)

Show shape nodes in the DAG.

Derived from mel command maya.cmds.hyperGraph

setShowUnderworld(val=True, **kwargs)

Show underworld graphs in the DAG.

Derived from mel command maya.cmds.hyperGraph

setTransitionFrames(val=True, **kwargs)

Specify te number of transition frames for animate transitions.

Derived from mel command maya.cmds.hyperGraph

setUpdateNodeAdded(val=True, **kwargs)

Update graph when a new node is added to the database

Derived from mel command maya.cmds.hyperGraph

setUpdateSelection(val=True, **kwargs)

Update selection state in the graph when the selection state of database changes.

Derived from mel command maya.cmds.hyperGraph

setUseFeedbackList(val=True, **kwargs)

Use feedback or highlight list as the target selection when processing other hypergraph command-line options.

Derived from mel command maya.cmds.hyperGraph

setViewOption(val=True, **kwargs)

Set or query the view option for this hyper graph editor. The currently allowed views are “asIcons” and “asList”.

Derived from mel command maya.cmds.hyperGraph

unParent(val=True, **kwargs)

Specifies that the editor should be removed from its layout. This cannot be used with query.

Derived from mel command maya.cmds.hyperGraph

unfold(val=True, **kwargs)

Unfolds (expands) selected object.

Derived from mel command maya.cmds.hyperGraph

unfoldAll(val=True, **kwargs)

Unfolds everything under selected object.

Derived from mel command maya.cmds.hyperGraph

unlockMainConnection(val=True, **kwargs)

Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.

Derived from mel command maya.cmds.hyperGraph

updateMainConnection(val=True, **kwargs)

Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.

Derived from mel command maya.cmds.hyperGraph

upstream(val=True, **kwargs)

Show upstream dependency graph of selected node(s).

Derived from mel command maya.cmds.hyperGraph

visibility(val=True, **kwargs)

Set the visible state of the selected node(s).

Derived from mel command maya.cmds.hyperGraph

zoom(val=True, **kwargs)

Specify the zoom factor for animating transitionsFlag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.hyperGraph