spark.graph_editor.models.graph_menu_tree

spark.graph_editor.models.graph_menu_tree#

Classes#

HierarchicalMenuTree

A manager class for NodeGraphMenu's that allows for easy, hierarchical creation and access of submenus.

Module Contents#

class spark.graph_editor.models.graph_menu_tree.HierarchicalMenuTree(graph_menu)[source]#

A manager class for NodeGraphMenu’s that allows for easy, hierarchical creation and access of submenus.

Init:

graph_menu: NodeGraphMenu, base NodeGraphMenu menu of the NodeGraphQt object

Parameters:

graph_menu (NodeGraphQt.NodeGraphMenu)

graph_menu_ref: NodeGraphQt.NodeGraphMenu[source]#
children: dict[str, HierarchicalMenuTree][source]#
__getitem__(path)[source]#

Get / Create a submenu with the given name.

Input:

path: str | list[str], path of the requested submenu

Output:

HierarchicalMenuTree, requested submenu

Parameters:

path (str | list[str])

Return type:

HierarchicalMenuTree

add_command(name, func, shortcut=None)[source]#

Add a graph command to current selected menu on the hierarchy.

Input:

name: str, name for the new command func: tp.Callable, function associated with the new command shortcut: str, keyboard shortcut for the new command

Parameters:

  • name (str)

  • func (Callable)

  • shortcut (str)

Return type:

None

Contents