Review Submission レビュー用にメディアを Shotgun に送信する機能を提供します。 最新バージョン: v1.1.1 (製品) バージョン番号は、セマンティック バージョニング基準に従っています。 システム名: tk-multi-reviewsubmission

ドキュメント

このアプリの使用方法

API として使用する場合

このアプリには、Multi Publish アプリのような他のアプリ内から呼び出して使用するためのモードがあります。

このモードはイメージ シーケンスから QuickTime を作成して、レビュー用にバージョンとして Shotgun に送信します。生成された QuickTime にはスレートとバーンインがあります。フォント、ロゴの位置、ムービーの圧縮オプション、バーンイン/スレート情報などの項目は現在既定のフックでハードコードされているため、動作を調整するためにフック関数を再実装することをお勧めします。

次に、スレートとバーンインの、現在の既定の形式を示します。

独自のアプリまたはフック内からこのアプリを使用する場合について、その方法の概要を簡単に説明します。

• 現在のエンジンから tk-multi-reviewsubmission アプリを取得します。これは呼び出し self.parent.engine.apps.get('tk-multi-reviewsubmission') を使用してフック内部から実行できます。
• アプリが使用可能な場合は、render_and_submit_version() メソッドを呼び出します。

次に、フック コードの内容の例を示します。

review_submission_app = self.parent.engine.apps.get("tk-multi-reviewsubmission")
if review_submission_app:
    review_submission_app.render_and_submit_version(
        template,
        fields,
        first_frame,
        last_frame,
        sg_publishes,
        sg_task,
        comment,
        thumbnail_path,
        progress_cb,
        color_space
    )

render_and_submit_version に渡す必要のある引数は次のとおりです。

• template: パブリッシュするファイルが格納される場所を定義するテンプレート
• fields: テンプレートの入力に使用されるフィールド
• first_frame: 処理するイメージ シーケンスの最初のフレーム
• last_frame: 処理するイメージ シーケンスの最後のフレーム
• sg_publishes: バージョンのリンク先の Shotgun パブリッシュ ファイル オブジェクトのリスト
• sg_task: バージョンのリンク先の Shotgun Task リンク ディクショナリ
• comment: バージョンの説明に追加するテキスト。
• thumbnail_path: ムービーが Shotgun にアップロードされていない場合にバージョンで使用するサムネイルへのパス(設定ファイルで指定)
• progress_cb: 進行状況を一緒に報告するコールバック。callback(percent, message) のような形式になります。
• color_space: 入力フレームのカラースペース。Nuke では、書き込みノードに使用するカラースペース ノブの列挙値のいずれかになります。

メニュー項目として使用する場合

このモードは、DCC 内の Shotgun メニューにメニュー項目を追加します。

また、現在のビューポートのクイック スナップショットを作成して、バージョンのドラフトとして Shotgun Create に送信します。ユーザは注釈、テキスト、または比較ノートを追加して、Shotgun Create 内でレビュー提出を拡張できます。

この機能をコンテキストに追加するには、次の操作を行う必要があります。

• display_name フィールドがメニュー項目に含まれるように設定します。
• render_media_hook フィールドを、DCC でのメディアのレンダリング方法を指示するフックに設定します(tk-photoshopcc と tk-maya で既定の実装は異なります)。
• submitter_hook フィールドを {self}/submitter_create.py に設定します。

例:

tk-multi-reviewsubmission:
  display_name: Send for review
  render_media_hook: '{self}/render_media.py:{self}/{engine_name}/render_media.py'
  submitter_hook: '{self}/submitter_create.py'
  location: 
    type: app_store
    name: tk-multi-reviewsubmission
    version: v1.0.1

関連するアプリとドキュメント

Publish アーティストは Publish アプリを使用して作品をパブリッシュすることにより、下流工程に関わるアーティストが自分の作品を使用できるようにすることができます。アーティストのコンテンツ作成ソフトウェア内における従来のパブリッシュ ワークフローと、ディスク上にある任意のファイルのスタンドアロン パブリッシュがサポートされます。コンテンツ作成ソフトウェアで作業し、基本的な Shotgun の統合を使用すると、このアプリはアーティストがパブリッシュする項目を自動的に探して表示します。さらに高度な制作上のニーズがある場合は、アーティストのワークフローを操作するカスタム パブリッシュ プラグインを作成することもできます。

Quickreview Node このアプリは、ノード グラフ内の任意の場所に追加できる Nuke ノードを追加します。 シーンに追加したら、ノードをダブル クリックしてプロパティ ページに移動し、「Send to Review」ボタンをクリックします。アプリはシーンの QuickTime をレンダリングし、バーンインとスレートを追加して Shotgun にアップロードします。

Write Node このアプリにはユーザからファイル システム パスを抽出する Nuke 用の書き込みノードのカスタム ギズモが含まれているため、特定の出力の命名に集中できます。残りの作業は Shotgun にお任せください。通常、このアプリは Publish アプリと組み合わせて使用します。Nuke 用のパブリッシュ アプリをインストールする場合は、これもインストールすることが多いでしょう。

インストールと更新

Shotgun Pipeline Toolkit にこのアプリを追加する

Project XYZ にこのアプリを追加するには、asset という名前の環境で次のコマンドを実行します。

最新バージョンに更新する

この項目が既にプロジェクトにインストールされている場合に最新バージョンを取得するには、update コマンドを実行します。特定のプロジェクトに含まれている tank コマンドに移動し、そこでこのコマンドを実行します。

> cd /my_tank_configs/project_xyz
> ./tank updates

または、tank コマンドを実行し、プロジェクトの名前を指定して、更新チェックを実行するプロジェクトを指定します。

> tank Project XYZ updates

コラボレーションと発展

Shotgun Pipeline Toolkit にアクセスできる場合は、すべてのアプリ、エンジン、およびフレームワークのソース コードにも Github からアクセスできます。これらは Github を使用して格納および管理しています。これらの項目は自由に発展させてください。さらなる独立した開発用の基盤として使用したり、変更を加えたり(その際はプル リクエストを送信してください)、 いろいろと研究してビルドの方法やツールキットの動作を確認してください。このコード リポジトリには、https://github.com/shotgunsoftware/tk-multi-reviewsubmission からアクセスできます。

特殊な要件

• 上記の操作を行うには、Shotgun Pipeline Toolkit Core API バージョン v0.19.5 以降が必要です。

環境設定

以下に、使用するすべての環境設定の概要を示します。これらの設定は、このアプリまたはエンジンを有効にするための環境設定ファイルで定義する必要があります。

movie_width

タイプ: int

既定値: 1920

説明: レンダリングするムービー ファイルの幅です。

display_name

タイプ: str

説明: メニューおよびメインで使用する名前を指定します。

render_media_hook

タイプ: hook

既定値: {self}/render_media.py:{self}/{engine_name}/render_media.py

説明: このアプリの実行中におけるメディアの生成方法を実装します。

slate_logo

タイプ: config_path

説明: 会社のログなどのスレートで使用するイメージのパスです。指定したイメージが 400 ピクセルのボックスに再フォーマットされ、ロゴの左下隅がスレートの左下隅から右に 100 ピクセル、上に 100 ピクセルの位置に配置されます。透明度を追加する場合は、アルファ チャネルを持つイメージを使用できます。現在 Nuke でサポートされているすべてのイメージ フォーマットを使用できます。この設定が空の文字列である場合、ロゴは何も適用されません。

new_version_status

タイプ: str

既定値: rev

説明: 新しいバージョンのステータスで使用する値です。

movie_path_template

タイプ: template

オプション テンプレート キー: ***

説明: ファイル システム上のムービー ファイルの出力場所を定義するテンプレートです。このテンプレートでは、render_and_submit フィールドに渡されるテンプレートで定義されたすべてのフィールドを使用できます。これとは別に、特別なフィールド(幅と高さ)も使用できます。これにはムービーの解像度が含まれます。store_on_disk 設定が false の場合は、この設定がまだ必要になりますが、ファイルが Shotgun にアップロードされるまで処理の一時的な場所として使用されます。

store_on_disk

タイプ: bool

既定値: True

説明: 作成中のムービーをディスク上に保持するかどうかを指定します。この設定と upload_to_shotgun オプションを無効にすると、ツール全体が実質的に無効になります。

upload_to_shotgun

タイプ: bool

既定値: True

説明: 作成中のムービーをバージョンとして Shotgun にアップロードするか、ディスク上にのみ保持するかを指定します。この設定と store_on_disk オプションを無効にすると、ツール全体が実質的に無効になります。

version_number_padding

タイプ: int

既定値: 3

説明: この値は、スレートやさまざまなムービーのバーンインのバージョン番号をパディングするのに使用されます。これはムービー ファイル名のバージョン番号のパディングには影響しません。movie_path_template を参照してください。パディングなしの場合には 1 を使用します。

submitter_hook

タイプ: hook

既定値: {self}/submitter_sgtk.py

説明: メディアを Shotgun に送信する方法を実装します。

movie_height

タイプ: int

既定値: 1080

説明: レンダリングしたムービー ファイルの高さです。