Q100402：如何在 Katana 中编辑和删除架子项目以修改现有的自定义 Python 脚本

关注
  1. Foundry
  2. Katana
  3. 工作流程帮助

概括

本文介绍了编辑/自定义架子项目以及根据需要删除项目的过程。

如果您是第一次设置架子项目，请按照Q100401：如何在Katana中创建架子项目中的步骤和信息进行操作。

编辑货架物品

创建后，可以通过访问Katana中的 Shelf Item Python 脚本，或导航到.katana和相关 Shelves、ShelvesNodeSpecific 或 ShelvesScenegraph 目录，然后在其中找到脚本来编辑 Shelf 项目。

1. 要在Katana中访问脚本，请打开搁架操作，选择所需的搁架项目，然后右键单击“查看源代码”：

视图源.png

这将在文本编辑器中打开 Shelf Item Python 脚本，如下所示：

ShelfScript_NotePad.PNG

2. 要在Katana外部访问脚本，请导航至.katana/Shelves、.katana/ShelvesNodeSpecific或.katana/ShelvesScenegraph文件夹，然后找到相关的.py文件。

这将位于这些目录之一的子文件夹中，以您的架子项目命名。从那里您可以在所需的 Python 编辑器中打开该文件。

货架项目脚本的文档字符串

如果您使用Q100401：如何在Katana中创建 Shelf Item 中描述的过程创建了 Shelf Item脚本，则默认情况下它将包含一个如下所示的文档字符串： 

""" 
NAME: <the name of the script to show in the UI>
ICON: <the filename of icon to use in the UI>
KEYBOARD_SHORTCUT: <the keyboard shortcut to use in the UI to run the Shelf Item Script>
SCOPE: <names of types of nodes to target by node-specific shelf items> 
<description> 
"""

它包含有关您的脚本的信息，如下所示：

  • NAME 是您的脚本项在架子操作中显示的名称
  • ICON 是您选择的图标的图像位置。 （下面进一步讨论）
  • KEYBOARD_SHORTCUT 是您的脚本项可以运行的快捷方式
  • SCOPE 用于定义架子项适用的特定节点类型
  • <description> 是货架项目的帮助工具提示

注意：为自定义架子项目设置键盘快捷键时，您将无法使用Katana中已存在的快捷键。应显示警告，并且可以在键盘快捷键资源中找到Katana默认键盘快捷键列表。

编辑货架项目脚本

要演示如何使用上述文档字符串，请将下面的 Shelf Item 脚本复制到空白 .py 文件中，并将其保存在.katana/Shelves/Custom_Shelves/目录中： 

"""
NAME: Float Selected
ICON: Icons\Scenegraph\locator32.png
KEYBOARD_SHORTCUT: T
SCOPE: none
Float Selected Nodes via Keyboard Shortcut
"""

# Get list of selected nodes
nodeList = NodegraphAPI.GetAllSelectedNodes()

# Find Nodegraph tab and float nodes
nodegraphTab = UI4.App.Tabs.FindTopTab('Node Graph')
if nodegraphTab:
    nodegraphTab.floatNodes(nodeList)


保存脚本后，通过Katana Shelf Action 菜单中的“ Add -> Reload Shelf”重新加载 Shelf。

重新加载货架.png

您的架子项目应显示为“浮动选定”，并带有自定义键盘快捷键、图标和帮助工具提示：

FloatSelected_Tooltip.png

架子项目脚本功能是当使用键盘快捷键 (T) 或从架子操作菜单中选择架子项目触发时，浮动任何当前选定的节点。

浮动节点将跟随您的光标，直到您单击左键放开，这样就无需手动单击并拖动选定的节点或背景。

有关组合类似 Python 函数的更多信息，请参阅示例脚本开发人员指南。

选择你的货架项目图标

要替换“货架操作”菜单中显示的货架项目的图标，您可以从以下位置选择Katana的默认图标之一： $KATANA_HOME\bin\python\UI4\Resources\Icons

要使用Katana中可用的图标作为架子项目，您需要在Katana的默认资源搜索路径之后指定该图标的路径。 Katana的默认资源搜索路径是 $KATANA_HOME\bin\python\UI4\Resources。例如：

图标：Icons\Scenegraph\locator32.png

注意：如果您想使用其他自定义图标，则需要将完整的图标路径添加到 Python 脚本的 ICON 部分。

拆除架子

如果您希望从架子操作中删除架子，可以通过从 .katana\Shelves 文件夹中删除架子文件夹来完成。如果您打开Katana并希望查看更改或希望从下拉架中删除架子，请单击“重新加载架子”，对 .katana/shelf 文件所做的任何更改都将在您的Katana场景中更新。

mceclip2.png

注意：如果您想重命名架子，可以通过找到 .katana/shelf 文件，然后重命名文件夹 [自定义文件夹] 来完成。

移除货架上的物品

如果您希望删除货架项，可以通过删除包含货架项脚本的 Python 文件或使用货架操作弹出菜单来完成。要从Katana中删除自身项目：

导航至架子操作菜单，右键单击要删除的架子项目，然后选择“删除... ”。

删除书架.png

按下后，将弹出一个窗口要求您确认删除。单击“删除”可删除架子项目。

删除ShelfWindow.png

注意：如上面的弹出窗口所示， Katana不会删除 Shelf Item 脚本，而是会附加扩展名“.bak”，以便脚本不再在Katana中加载。

它将保存为备份文件，以便在需要时恢复。

架子备份.PNG

如果您希望将其添加回书架，请导航到其位置并删除“.bak”扩展名，书架项目脚本将被加载并可用。

注意：删除 .bak 后，转到“货架操作”并使用“添加->重新加载... ”，以便Katana重新加载所有可用的货架项目以在会话中显示。

延伸阅读

有关Katana中的货架项目脚本的概述，请访问货架项目脚本用户指南。

如果您是第一次设置货架项目，请参阅Q100401：如何在Katana中创建货架项目。

    我们很遗憾听到

    请告诉我们