Nuke スクリプト (Nuke Script)
nuke -t 経由で既存の .nk スクリプトをヘッドレス実行し、アノテーションが付与された Read/Write ノードを Griptape キャンバス上の型付き入出力ポートとして展開します。
カテゴリ: Foundry Nuke
概要 (TL;DR)
script_path に .nk ファイルを指定し、Nuke 内部の Griptape Annotator パネルでその I/O ノードにアノテーション(注釈付け)を行うと、ノード上にそれらのアノテーションに対応する型付きポートが自動生成されます。
- 入力ポートは画像、動画、またはファイルパスを受け付けます。出力ポートは画像、画像シーケンス、動画、または 3D ジオメトリとなります。
- Open in Nuke ボタンをクリックすると、Annotator パネルがロードされた状態で Nuke GUI が起動します。Refresh UI ボタンをクリックすると、アノテーションの再読み込みとインストール検出が再実行されます。
- アノテーション情報は
.nk ファイルの隣にある <script>.gt.json サイドカーファイルに保存されます。サイドカーが古い状態と検知された場合はノード上で警告が表示されます。
ワークフローにおける一般的な配置 (Typical workflow position)
(画像/動画ソース) → [Nuke Script] → (画像/動画/3D の出力先)
ノードプレビュー (Node preview)
クイックスタート (Quick start)
- キャンバスに Nuke Script ノードを配置します。
- Script Path に
.nk ファイルのパスを指定します。
- Open in Nuke をクリックします — Griptape Annotator パネルがロードされ、現在のノブオーバーライドが事前適用された状態で Nuke が起動します。
- Nuke 内で、Panels > Griptape Annotator を開きます。Annotate タブで、Read ノードを入力として、Write ノードを出力としてマークし、必要に応じて他のノードのノブ(Knob)を公開(Expose)設定にして、Save Annotations をクリックします。
- Griptape エディタに戻り、Refresh UI をクリック(またはスクリプトパスを再選択)します。ノードに入出力ポートが自動生成されます。
- 入力を配線し、Frame Start / Frame End を設定してノードを実行します。
| 名前 |
型 |
必須 |
備考 |
script_path |
str |
はい |
.nk ファイルへのパス。 |
<annotated Read nodes> |
str \| ImageArtifact \| ImageUrlArtifact \| VideoUrlArtifact \| BlobArtifact |
いいえ |
入力としてアノテーションされた Read ノードごとに 1 つのポートが生成されます。URL ベースのアーティファクトはレンダリング前に一時ファイルにダウンロードされます。 |
出力 (Outputs)
出力としてアノテーションされた Write ノードは、ノード実行後に Outputs グループ内に展開されます。アーティファクトの型はアノテーション設定に依存します:
| アノテーション型 |
Griptape 出力 |
ImageArtifact / ImageUrlArtifact |
ImageUrlArtifact(レンダリングされた単一フレーム) |
VideoUrlArtifact |
VideoUrlArtifact(レンダリングされた動画ファイル、例: .mp4) |
ImageSequenceArtifact |
ImageUrlArtifact の ListArtifact(レンダリングされたフレームごと) |
ThreeDUrlArtifact / GLTFUrlArtifact |
ThreeDUrlArtifact(.obj または .glb) |
パラメータ一覧 (Parameters)
| 名前 |
型 |
デフォルト |
備考 |
nuke_installation |
選択肢 |
自動検出 |
インストール検出によって生成される Nuke Version ドロップダウン(ライブラリ概要 を参照)。 |
frame_start |
int |
スクリプトデフォルト |
レンダリング開始フレーム。 |
frame_end |
int |
スクリプトデフォルト |
レンダリング終了フレーム。 |
<exposed knobs> |
多様 |
スクリプトの値 |
Annotator パネルの Expose タブで昇格されたノブ。ノード名ごとにグループ化されます。空のままにするとスクリプト内の既存値が使用され、入力するとレンダリング前にオーバーライドされます。 |
詳細設定 (Advanced) (デフォルトでは折りたたみ)
| 名前 |
型 |
デフォルト |
備考 |
nuke_executable |
str |
"" |
Nuke バイナリへの絶対パス。このノード限定でエンジン設定の選択をオーバーライドします。 |
baked_script_path |
str |
"" |
ベイクされた .nk コピーの保存先パス。 |
save_baked_copy |
ボタン |
— |
現在のすべてのパラメータ値をノブにベイクしたスクリプトコピーを書き出します。アーカイブや手動での確認に便利です。 |
ヒントと注意点 (Tips & pitfalls)
- スクリプト編集後はアノテーションを再保存してください: アノテーション設定後に
.nk が保存された場合、サイドカーファイルが古い可能性がある旨の警告が表示されます。Nuke で再度開いて再保存してください。
- ポートはアノテーション後にのみ現れます: パスを指定した直後のスクリプトにはポートがありません。先に Annotator パネルで設定を行い、Refresh UI をクリックしてください。
- 実行前にライセンスを設定してください: Griptape シークレットパネルで
foundry_LICENSE を設定してください。ライセンスに到達できない場合、ヘッドレスレンダリングは失敗します。
- バージョン固定: マシン間でのレンダリング再現性を担保するため、
nuke_installation(または個別の nuke_executable)で Nuke の正確なビルドを明示的に指定してください。
関連項目 (See also)