Q100402: Katana でシェルフ項目を編集および削除して既存のカスタム Python スクリプトを変更する方法

Bradley Webster

更新しました : 2024年08月02日 19:48

作成した : 2018年05月11日 07:35

まとめ

この記事では、シェルフアイテムの編集/カスタマイズと、必要に応じてシェルフアイテムを削除する手順について説明します。

初めてシェルフアイテムを設定する場合は、「Q100401: Katanaでシェルフアイテムを作成する方法」の手順と情報に従ってください。

シェルフアイテムの編集

シェルフアイテムは、 Katanaでシェルフアイテム Python スクリプトにアクセスするか、 .katanaおよび関連するシェルフ、ShelvesNodeSpecific または ShelvesScenegraph ディレクトリに移動して、そこでスクリプトを見つけることで、作成後に編集できます。

1. Katanaでスクリプトにアクセスするには、シェルフアクションを開き、目的のシェルフアイテムを選択して、[ソースの表示] を右クリックします。

ソースの表示.png

これにより、テキストエディターで次のようなシェルフアイテム Python スクリプトが開きます。

シェルフスクリプト_メモパッド.PNG

2. Katanaの外部でスクリプトにアクセスするには、 .katana/Shelves、.katana/ShelvesNodeSpecific 、または.katana/ShelvesScenegraphフォルダーに移動し、関連する.pyファイルを見つけます。

これは、シェルフアイテムにちなんで名付けられた、これらのディレクトリのいずれかのサブフォルダーにあります。そこから、目的の Python エディターでファイルを開くことができます。

棚アイテムスクリプトのドキュメントストリング

Q100401: Katanaでシェルフアイテムを作成する方法で説明されているプロセスを使用してシェルフアイテムスクリプトを作成した場合、デフォルトで次のような docstring が含まれます。

""" 
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 Katanaデフォルトのキーボードショートカットのリストは、キーボードショートカットリソースにあります。

棚アイテムスクリプトの編集

上記の docstring をどのように利用できるかを示すために、以下のシェルフ項目スクリプトを空の .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シェルフアクションメニュー内の「追加 -> シェルフのリロード」を使用してシェルフをリロードします。

シェルフアイテムは、カスタムキーボードショートカット、アイコン、ヘルプツールチップとともに「フロート選択済み」として表示されます。

シェルフアイテムスクリプト機能は、キーボードショートカット (T) でトリガーされるか、シェルフアクションメニューからシェルフアイテムを選択することによって、現在選択されているノードをフローティングします。

フローティングされたノードは、左クリックして放すまでカーソルに従います。これにより、選択したノードまたは背景を手動でクリックしてドラッグする必要がなくなります。

同様の Python 関数をまとめる方法の詳細については、サンプルスクリプト開発者ガイドを参照してください。

棚アイテムのアイコンを選択する

シェルフアクションメニューに表示されるシェルフアイテムのアイコンを置き換えるには、次の場所からKatanaのデフォルトアイコンの 1 つを選択できます: $KATANA_HOME\bin\python\UI4\Resources\Icons

Katanaで利用可能なアイコンをシェルフアイテムに使用するには、 Katanaのデフォルトのリソース検索パスの後にアイコンへのパスを指定する必要があります。 Katanaのデフォルトのリソース検索パスは $KATANA_HOME\bin\python\UI4\Resources です。例えば：

アイコン: アイコン\シーングラフ\locator32.png

注:他のカスタムアイコンを使用したい場合は、Python スクリプトの ICON セクションにアイコンの完全なパスを追加する必要があります。

棚の取り外し

シェルフアクションからシェルフを削除したい場合は、.katana\Shelves フォルダからシェルフフォルダを削除することで実行できます。 Katanaを開いた状態で変更を確認したい場合、またはドロップダウンシェルフからシェルフを削除したい場合は、[シェルフを再ロード] をクリックすると、.katana/shelf ファイルに加えられた変更がKatanaシーン上で更新されます。