python.tk_katana.menu_generation module

class AppCommand(engine, name, command_dict)

Bases: object

Wraps around a single command that you get from engine.commands

add_command_to_menu(menu)

Add a new QAction representing this AppCommand to a given QMenu.

app

The command’s parent app.

app_instance_name

The instance name of the parent app.

app_name

The name of the parent app.

callback

The callback function associated with the command.

engine

The currently-running engine.

favourite

Whether the command is a favourite.

get_documentation_url_str()

Returns the documentation URL.

name

The name of the command.

properties

The command’s properties dictionary.

type

The command’s type as a string.

class MenuGenerator(engine, menu_name)

Bases: object

A Katana specific menu generator.

destroy_menu()

Destroys the Shotgun menu.

engine

The currently-running engine.

get_all_app_commands()

classmethod get_katana_main_bar()

Get Katana GUI’s main menu bar.

Raises:RuntimeError – Cannot get Katana GUI’s main menu bar. Returns:Katana GUI’s main menu bar. Return type:UI4.App.MainMenu.MainMenu

menu_name

The name of the menu to be generated.

setup_root_menu()

Attempts to find an existing menu of the specified title.

If it can’t be found, it creates one.