Q100242: Windows のランチャー スクリプトを使用してサードパーティのレンダラー プラグインで Katana を起動する方法

まとめ

Katanaを起動し、利用可能なさまざまなレンダラー プラグインを操作するには、いくつかの環境変数が正しく設定されていることを確認する必要があります。現時点でこれらの環境変数を管理する最も簡単な方法は、ランチャー バッチ スクリプトを使用してKatanaを起動することです。

この記事では、さまざまなレンダラー プラグインをすべてカバーし、すぐに使用できるサンプル スクリプトを以下に示します。これには十分なコメントが付けられており、ワークフローで必要のないレンダラー プラグインへの参照を削除するだけで済みます。

注:このスクリプトで使用されているさまざまなコンポーネントのパスが異なる場合は、それらのパスをシステム上の正しい場所に更新する必要があります。

Windows にKatanaをインストールしてライセンスを取得していない場合は、 「Windows へのインストールユーザー ガイド」を参照してください。

ランチャースクリプトの設定

このスクリプトを変更して使用する方法については、次の手順に従ってください。

1. 以下のスクリプトの内容 (ランチャー バッチ スクリプトの例) をコピーし、メモ帳などのテキスト エディターに貼り付けます。
   サンプルファイルも添付されていますので、添付のバッチスクリプトをダウンロードしてください。 .bat ファイルを編集するには、ファイルを右クリックして [編集] を選択します。
2. スクリプトを注意深く読み、指定されたパスがマシン上で同じであるかどうかを確認してください。そうでない場合は、正しい場所を指すように更新します。
3. レンダラーやカスタム スクリプトなど、使用しないツールに固有のセクションを削除します。
4. ファイルをKatana 6.0v2.batとして保存し、閉じます。
5. ここで、.bat ファイルをダブルクリックするか、右クリック > [開く]をクリックするとコマンドが実行され、必要な環境変数がすべて設定された状態でKatanaが起動します。
   
   たとえば、[Python] タブで次のコマンドを実行することで、それらが正しく設定されているかどうかを確認できます。
   

   import os
   print(os.environ['KATANA_RESOURCES'])

   
   これにより、ランチャー スクリプトのKATANA _RESOURCES に追加したパスが出力されるはずです。
6. デスクトップ アイコンをクリックしてKatanaを起動したい場合は、次の方法でこれを追加できます。

• .bat ファイルを右クリックし、 [ショートカットの作成] を選択します。
• 作成したショートカットをデスクトップに置きます。
• ショートカットを右クリック> [プロパティ] > [ショートカット] タブ > [アイコンの変更…]
• .bat ファイルにアイコンが含まれていないという警告が表示される場合があります。 「OK」をクリックすると、別の場所からアイコンを選択するオプションが表示されます。
• [参照…] をクリックし、 Katanaインストール ディレクトリ (KATANA_ROOT) を参照します。ファイル WindowsIcon.ico を選択し、 [開く]をクリックします。 「OK」をクリックして「アイコンの変更」ダイアログを閉じ、 「OK」をクリックして「プロパティ」ウィンドウを閉じます。
  
  これで、デスクトップ上にKatanaアイコンが表示されたKatanaランチャー スクリプトのショートカットが表示されるはずです。

KATANAランチャー スクリプト

主要なKATANA環境変数

KATANA _ROOT はKatanaインストール ディレクトリを指す必要があります。
PATHは、実行可能プログラムが配置されているディレクトリを指定する Windows システム変数です。
KATANA _RESOURCES は、プラグインやその他のカスタマイズ (シェーダーなど) を検索するためのパスのリストを提供します。詳細については、 Katanaリソースのインストール ガイドを参照してください。

いくつかのバッチファイルコマンドの説明

rem はコメントをマークします。 Windows がスクリプトを実行するとき、このコマンドで始まる行は無視されます。
@echo off は、コマンド プロンプトで実行されたコマンドの表示を無効にします。
setは環境変数を設定するコマンドです。複数のパスはセミコロン ( ; ) で区切ることができます。

最後の行"%KATANA_ROOT%\bin\katanaBin.exe" はKatana実行可能ファイルを実行します。バッチ ファイルがこの行に到達すると、 Katanaによって実行されたコマンドをエコーするコマンド プロンプトが表示されます。

ランチャーバッチスクリプトの例

@echo off
rem --------------------------------------------
rem -------- How to use this script ------------
rem --------------------------------------------

rem -- The KATANA Specific section shows some examples for how you can use the KATANA _RESOURCES environment variable --

rem -- KATANA _ROOT should point to your Katana installation directory. --
rem -- KATANA _RESOURCES drives what gets loaded at startup for KATANA . --
rem -- This is how you load tools and plug-ins, both custom and non-custom ones like commercial renderer plug-ins --
rem -- DEFAULT_RENDERER is the environment variable that drives which renderer plug-in is expected by default in a Renderexporttings node. --

rem -- Delete the settings for the renderers that you do not have installed or do not want to use at the same time. --
rem -- The different renderer plug-ins' requirements for environment variables may change. --
rem -- Please refer to the installation instructions for each particular render plug-in for the most up to date information --


rem --------------------------------------------
rem ------------ KATANA Specific ---------------
rem https://learn.foundry.com/ katana /dev-guide/EnvironmentVariables.html
rem --------------------------------------------

set "KATANA_TAGLINE=Foundry Support"

rem -- Define the install location for KATANA --
set "KATANA_ROOT=C:\Program Files\Katana6.0v2"

rem -- Make the example projects like the PyMock asset plugins available in KATANA
set "KATANA_RESOURCES=%KATANA_RESOURCES%;%KATANA_ROOT%\plugins\Resources\Examples"


rem !!!!!!!!!!!!! Delete the tools you do not use from the section below !!!!!!!!!!!!! 


rem --------------------------------------------
rem ----------- 3Delight Specific --------------
rem https://www.3delight.com/documentation/display/3DFK/Installation
rem --------------------------------------------

set "DEFAULT_RENDERER=dl"

rem -- Location of where the main 3Delight package is installed --
set "DELIGHT=C:\Program Files\3Delight"

rem -- The 3Delight bin folder is needed in PATH  --
set "PATH=%PATH%;%DELIGHT%\bin"

rem -- Location of the 3Delight for KATANA plug-in --
set "KATANA_RESOURCES=%KATANA_RESOURCES%;%DELIGHT%\3DelightForKatana"


rem --------------------------------------------
rem ------------- Arnold Specific --------------
rem https://help.autodesk.com/view/ARNOL/ENU/?guid=arnold_for_katana_getting_started_ka_Installation_html
rem --------------------------------------------

set "DEFAULT_RENDERER=arnold"

rem -- Where you have installed the KtoA plug-in --
set "KTOA_HOME=C:\Program Files\ktoa\ktoa-4.2.2.1-kat6.0-windows"

rem -- The KtoA bin folder is needed in PATH --
set "PATH=%PATH%;%KTOA_HOME%\bin"

rem -- This is how to load the KtoA plug-in --
set "KATANA_RESOURCES=%KATANA_RESOURCES%;%KTOA_HOME%"


rem --------------------------------------------
rem --------- RenderMan 25 Specific ------------
rem https://rmanwiki.pixar.com/display/RFK25/Configuring+Katana
rem --------------------------------------------

set "DEFAULT_RENDERER=prman"

rem -- Location of the RenderMan Pro Server installation --
set "RMANTREE=C:\Program Files\Pixar\RenderManProServer-25.1"

rem -- Location of the PRman plugin for KATANA --
set "RFKTREE=C:\Program Files\Pixar\RenderManForKatana-25.1\plugins\katana6.0"

rem -- This is what is required to load the RfK plugin --
set "KATANA_RESOURCES=%KATANA_RESOURCES%;%RFKTREE%"

rem -- This is a workaround to prevent ImportError with Katana Queue --
set "PATH=%PATH%;%KATANA_ROOT%\bin"

rem --------------------------------------------
rem ----------- Redshift Specific --------------
rem C:\ProgramData\Redshift\Plugins\Katana\6.0v1\launchRedshift4Katana.bat
rem --------------------------------------------

set "DEFAULT_RENDERER=redshift"

rem -- Location of the RedShift bin folder --
set "REDSHIFT_HOME=C:\ProgramData\Redshift\bin"

rem -- Location of the RedShift plugin for KATANA --
set "REDSHIFT4KATANA_HOME=C:\ProgramData\Redshift\Plugins\Katana\6.0v1"

rem -- This is what is required to load the RedshiftForKatana plugin --
set "PATH=%PATH%;%REDSHIFT_HOME%"
set "KATANA_RESOURCES=%KATANA_RESOURCES%;%REDSHIFT4KATANA_HOME%"

rem !!!!!!!!!!!!! Stop deleting parts of the script. Leave the rest of this script alone !!!!!!!!!!!!!


rem --------------------------------------------
rem --------------- Start Katana ---------------
rem https://learn.foundry.com/ katana /Content/tg/launch_modes/ katana _launch_modes.html
rem --------------------------------------------
"%KATANA_ROOT%\bin\katanaBin.exe"

Katanaの起動と利用可能なさまざまな起動モードの詳細については、 Katanaドキュメントの「Windows での起動」セクションを参照してください。

添付ファイル