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

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

概括

本文介绍了如何编辑或自定义货架项目，以及在需要时如何删除项目。

如果您是第一次想要设置货架项目，请按照Q100401 中的步骤和信息进行操作：如何在Katana中创建货架项目，以便提供易于访问的自定义 Python 脚本。

编辑书架项目

创建书架项目后，可以通过访问Katana中的书架项目 Python 脚本进行编辑，或者导航到您的.katana和相关的书架、书架节点特定或书架场景图目录，并在那里找到脚本。

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

查看源代码.png

这将使用类似这样的文本编辑器打开货架项目 Python 脚本：

ShelfScript_NotePad.PNG

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

文件会保存在其中一个目录的子文件夹中，子文件夹的名称与您的书架项目名称相同。之后，您可以使用所需的 Python 编辑器打开该文件。

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

如果您已按照Q100401：如何在Katana中创建书架项以提供易于访问的自定义 Python 脚本中描述的步骤创建了书架项脚本，则默认情况下它将包含一个如下所示的文档字符串： 

""" 
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> 
"""

这里包含了您的脚本信息，详情如下：

  • 名称是您的脚本项在书架操作中显示的名称。
  • ICON 是您所选图标的图像位置。（详见下文）
  • KEYBOARD_SHORTCUT 是运行脚本项的快捷键。
  • SCOPE 用于定义货架项目适用的特定节点类型。
  • <description> 是货架项目的帮助提示信息。

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

编辑货架项目脚本

为了演示如何使用上述文档字符串，请将下面的书架项目脚本复制到一个空白的 .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 操作菜单中的“添加 -> 重新加载 Shelf”重新加载 Shelf。

ReloadShelf.png

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

FloatSelected_Tooltip.png

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

浮动节点会跟随你的光标移动，直到你单击鼠标左键松开为止，这样就省去了手动单击和拖动选定节点或背景的麻烦。

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

选择货架商品图标

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

要使用Katana中提供的图标作为书架项目的图标，您需要在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

按下按钮后，会弹出一个窗口要求您确认删除。点击“删除”即可移除该书架项目。

删除货架窗口.png

注意：如上弹出窗口所示， Katana不会删除书架项目脚本，而是会附加扩展名“ .bak ”，这样脚本就不会再在Katana中加载。

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

书架备份.PNG

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

注意：删除.bak文件后，请转到“书架操作”，然后使用“添加->重新加载... ”功能，以便Katana重新加载会话中所有可用的书架项目以供显示。

延伸阅读

有关Katana中书架物品脚本的概述，请访问书架物品脚本用户指南。

如果您是第一次设置货架项目，请参阅Q100401：如何在Katana中创建货架项目以提供易于访问的自定义 Python 脚本。

    我们很遗憾听到

    请告诉我们