• Mari
• Nodegraph

The following methods are exposed as part of MARI Extension Pack 4 to provide easy access to

frequently used python procedures.

The methods are part of the class

mari.ExtensionPack.utils()

• mariMainWindowObject()

Will return the Mari Main Window Object

Returns:  

Mari Main Window Object

• setNodegraphContext()

This will set the Focus and Mari Context to the Nodegraph, meaning that hotkeys executed by the user will be run in 'Nodegraph Context'

if hotkeys have been defined.

This is useful to return context to the Nodegraph after a dialog was launched and closed from within the Nodegraph, since otherwise

the Context sits on the Mari Main Window

Returns:  

None

• findNodeGraphContext()

Returns the currently open nodegraph (root or graph group)

Returns:  

mari.NodeGraph() Object

• recursiveGroupNodeList( node_list )

Returns a list of all Graph Group Nodes found in a given list of nodes.

If the list includes Graph Group Nodes, the contents of these Graph Groups

are recursively checked for Group Nodes as well.

Parameters:

• node_list (lst)

A list of mari.Node objects

Returns:

List of mari.GroupNode() objects

• recursiveNodeList( node_list )

Returns a list of all Nodes found in a given list of nodes.

If the list includes Graph Group Nodes, the contents of these Graph Groups

are added to the returned list as well (recursively).

Parameters:

• node_list (lst)

A list of mari.Node objects

Returns:

List of mari.Node() objects

• findConnectedNodeOutput(graph,node_to_find, skipDotNodes = False)

Returns a list of all Nodes found connected to the Output of the specified Node

When skipDotNodes is True the method will keep traversing downstream until

a node other than a dot node is found.

Parameters:

• graph (mari.Nodegraph)

the Nodegraph to search in

• node_to_find (mari.Node)

The Node you want  to find Output Connections for.

Returns:

List of mari.Node() objects

• channelsNodeBelongsTo(node_to_find,geo,excludeDownStreamChannelLayerUse=True)

Returns a list of all channels that the given node_to_find belongs to.

Parameters:

• node_to_find (mari.Node)

the Node we want to find out what Channel it belongs to

• geo (mari.geoEntity)

the geometry the node_to_find lives on

• excludeDownStreamChannelLayerUse (bool)

If excludeDownStreamChannelLayerUse is True, the search will only go up to the first downstream hierarchy level

of channels, and not further (ignoring for example cases where a whole channel is used in another channel)

Returns:

List of mari.Channel() Objects

• getSelectedNodesOnCurrentGeoRootGraph(ReturnOnlyFirstNode=False)

Returns selected Nodes in the Root Graph of the Current Geometry

Parameters:

• ReturnOnlyFirstNode=False (bool)

If True only the first node is returned

Returns:

List of mari.Node() Objects or a single mari.Node() Object if parameter is True

• getAllNodesConnectedToNode(targetNode,nodeGraph,GroupContentMode='Include Group Node Content',returnBakePointUpstream=True,includeTargetNode=True)

Returns all Nodes upstream that are connected to a given target Node

Parameters:

• targetNode (mari.Node)

The Node to find upstream Nodes from

• nodeGraph (mari.Nodegraph)

The Nodegraph the targetNode lives in

• GroupContentMode = 'Include Group Node Content'(str)

If GroupContentMode = 'Include Group Node Content' and a node upstream from the targetNode is a GraphGroup,

all Nodes (recursively) inside the Group are returned as well

Otherwise only the Graph Group Node is included.

• returnBakePointUpstream=True (bool)

If returnBakePointUpstream is False nodes upstream from bake points will only be returned if the bake point is

disabled or does not useBake()

• includeTargetNode=True (bool)

If includeTargetNode is True, the targetNode is included in the return statement of the method

Returns:

List of mari.Node() Objects

Created with the Personal Edition of HelpNDoc: What is a Help Authoring tool?