User guide

215
• shot = ts520
• show = srow
• username = name
• workstation = seat
When the function to run a custom asset plug-in command is called the asset API plug-in uses the AMS to check if the
command succeeds or fails. The function signature to run the plug-in command is:
runAssetPluginCommand(assetID: string, command: string, commandArgs: map of string): bool
The command parameter receives the command to execute, for example:
• acquireLock
• releaseLock
The commandArgs dictionary contains information about the arguments with which to customize the execution of
the given command, with names of command arguments as keys and values of command arguments as values.
The commandArgs dictionary may be empty.
Extending the User Interface with Asset Widget
Delegate
Katana provides a mechanism for configuring the asset related parts of its user interface. This is achieved by
implementing and registering an AssetWidgetDelegate.
The PyMockAssetWidgetDelegate.py provides a good reference. This file is shipped with Katana in:
${KATANA_ROOT}/plugins/Src/Resources/Examples/UIPlugins/
This allows users to:
• Configure the asset / file browser. Typically this is done by extending with a custom asset browser tab.
• Implement a custom Python QT widget for displaying and editing Asset IDs in the Parameters tab.
• Implement a custom Python QT widget for displaying and editing render output locations in the Parameters tab.
• Customize the QuickLink paths used by the file browser.
To create an AssetWidgetDelegate plug-in, create a new Python file and place it in a directory called UIPlugins in a
folder in your KATANA_RESOURCES.
NOTE: The UI4 module is the main Python module for working with the Katana user interface.
27 ASSET MANAGEMENT SYSTEM PLUG-IN API | EXTENDING THE USER INTERFACE WITH ASSET