After Effects

Shotgun Engine for After Effects CC

After Effects CC への Shotgun Engine の統合
最新バージョン: v0.1.2 (ベータ)
バージョン番号は、セマンティック バージョニング基準に従っています。
システム名: tk-aftereffects

注: このドキュメントは、Toolkit の設定を管理するユーザのみが使用可能な機能について説明します。詳細については、『Shotgun 統合ユーザ ガイド』を参照してください。
概要
ドキュメント
      インタフェースの概要
      インストール
      拡張機能を有効にする
      インタフェースのコンポーネント
            コンテキスト ヘッダ
            お気に入りシェルフ
            コマンド リスト
            コンテキスト メニュー
            ロギング コンソール
      設定と技術の詳細
            PySide
            CEP 拡張機能
            お気に入りを設定する
            環境変数
            コンテキスト フィールド表示フック
            映像フックのインポート
            After Effects の API
インストール、更新、開発
設定オプション

Shotgun Engine for After Effects には、Shotgun Pipeline Toolkit アプリと After Effects を統合するための標準プラットフォームが含まれています。インストール後は、Maya、Nuke、Photoshop、および他のアプリケーションで使用している同じアプリケーションが実行できます。API がすべてアプリ開発者に公開されているため、何かをコンパイルしたり、Photoshop プラグインを作成および展開する方法を確認しなくても、Python や Qt を使用して After Effects の機能をすばやくビルドすることができます。

アプリケーションのサポート対象バージョン

この項目はテスト済みで、バージョン 2017 ~ 2019 のアプリケーションで動作することが分かっています。最新のリリースでの動作は十分可能ですが、正式なテストはまだ完了していません。

ドキュメント

Shotgun Engine for After Effects は、Shotgun を After Effects のワークフローに統合するためのプラットフォームを提供します。これは Shotgun Pipeline Toolkit の標準エンジンで構成され、tk-framework-adobe (CEP)に依存します。

有効にすると、Shotgun Adobe Panel というパネルが After Effects で使用できるようになります。そこに、現在の Shotgun コンテキストに関する情報と、そのコンテキストにインストールされたアプリの登録済みコマンドが表示されます。

インタフェースの概要

Shotgun の拡張パネルは、After Effects のネイティブ パネルと同じカラー パレットと基本レイアウトを使用します。 次の 5 つのコンポーネントで構成されています。

  1. コンテキスト ヘッダ: 現在のコンテキストのサムネイルとフィールドです。
  2. お気に入りシェルフ: 現在のコンテキストで最もよく使用するアプリを表示するように設計されています。
  3. コマンド リスト: 現在のコンテキストのお気に入りではないすべてのコマンドです。
  4. コンテキスト メニュー: 追加のコンテキスト関連コマンドとデバッグ ツールです。
  5. ロギング コンソール: デバッグのログ出力を表示するコンソール オーバーレイです。

インストール

Shotgun Engine for After Effects のインストールは、Shotgun の他の統合と同じプロトコルを使用します。エンジンやアプリのインストールについては、「Toolkit の管理」という記事を参照してください。また、統合の設定については、「既定ツールキットの構成」を例として参照してください。

拡張を有効にする

拡張をインストールしたら、After Effects の拡張メニューから起動する必要があります。

これを実行するのは 1 度だけです。それ以後の起動から Shotgun 拡張パネルが After Effects のレイアウトに表示されるようになり、逐一有効にする必要はありません。

いったん有効にすると、それ以降の起動では、Shotgun 統合のブートストラップ中に拡張パネルにロード画面が表示されます。

通常、この画面は、現在のコンテキストが決定され、コマンドが表示されるまでの数秒間表示されます。

インタフェースのコンポーネント

以降のセクションでは、Shotgun と After Effects を統合したときのコンポーネントについて説明します。

コンテキスト ヘッダ

コンテキスト ヘッダは、現在の Shotgun コンテキストに関する情報を表示するためのカスタマイズ可能な領域です。

コンテキストは現在アクティブなドキュメントによって決定されます。コンテキストがエンジンによって決定されると、ヘッダはコンテキストのサムネイル フィールドの詳細を表示するように更新されます。フィールド情報はフックで制御されます。フィールド表示のカスタマイズ方法については、「コンテキスト フィールド表示フック」を参照してください。

また、コンテキストの切り替えは、Shotgun が開く場合が使用されていた場合にのみ認識されることにもご注意ください。

お気に入りシェルフ

お気に入りシェルフは、Maya や Houdini のような他の Shotgun DCC 統合で利用できるお気に入りメニューと似ています。インタフェースのこのセクションはコンテキスト ヘッダのすぐ下にあるので、よく使用する Toolkit アプリが使いやすく、簡単に見つけられるようになります。

シェルフにはお気に入りのコマンドがボタンで表示されます。マウスを上に重ねると、灰色から色付きに変化し、上部のラベルにその名前が表示されます。マウスを上に重ねると、ボタンの説明が表示されます。

いずれかのボタンをクリックすると、実行する登録済みコマンドのコールバックがトリガされます。

コマンドをお気に入りとして指定する方法については、下記の「shelf_favorites」セクションを参照してください。

コマンド リスト

コマンド リストには、現在のコンテキストに登録されているその他の「標準」コマンドが表示されます。

通常、パイプライン設定内にインストールされたアプリはここに表示される 1 つまたは複数のコマンドを登録します。コマンドがお気に入りとして識別されず、コンテキスト メニュー コマンドとしても識別されていない場合は、ここに表示されます。

コマンド リスト ボタンは、お気に入りシェルフ内のボタンと同じように動作します。唯一異なる点は、アイコンの右側に完全な名前のリストとして表示されることです。

コンテキスト メニュー

コンテキスト メニュー コマンドとして登録されているコマンドは、Shotgun 拡張パネルのコンテキスト メニューに表示されます。

他のコマンド領域と同様に、このコマンドはコンテキストに応じて変化します。Jump to ShotgunJump to Filesystem などのコマンドは常にここから使用できます。

ロギング コンソール

ロギング コンソールは、CEP JavaScript インタプリタと Toolkit の Python プロセスの両方のログ出力をすべて表示します。

拡張機能に問題があり、サポートが必要な場合、ロギング コンソール出力は Shotgun のサポート チームが問題をデバッグするのに非常に役立ちます。

設定と技術の詳細

次のセクションでは、貴社のパイプライン固有のニーズに合わせて統合を設定できるよう、統合の技術的な側面について少し説明します。

PySide

Shotgun Engine for After Effects は PySide に依存します。 正式な手順については、「Pyside をインストールする」を参照してください。

CEP 拡張機能

拡張機能自体はエンジンにバンドルされており、After Effects の初回起動時にエンジンが自動的にインストールします。 拡張機能は、アーティストが使用するローカル マシンにある OS 固有の標準的な CEP 拡張ディレクトリにインストールされます。

# Windows
> C:\Users\[user name]\AppData\Roaming\Adobe\CEP\extensions\

# OS X
> ~/Library/Application Support/Adobe/CEP/extensions/

After Effects が起動するたびに、エンジン ブートストラップ コードが、エンジンにバンドルされている拡張機能のバージョンとマシン上にインストールされているバージョンを比較します。つまり、新しいバージョンの拡張機能がバンドルされている場合は、エンジンを更新するとインストールされている拡張機能がバンドルされている新しいバージョンに自動的にアップデートされます。

お気に入りを設定する

お気に入りシェルフは、インストールしたアプリに登録されているコマンドを表示するように設定できます。表示するには、shelf_favorites 設定を環境設定の tk-aftereffects セクションに追加するだけです。次に例を示します。

shelf_favorites:
    - {app_instance: tk-multi-workfiles2, name: File Save...}
    - {app_instance: tk-multi-workfiles2, name: File Open...}
    - {app_instance: tk-multi-publish, name: Publish...}
    - {app_instance: tk-multi-snapshot, name: Snapshot...}

設定の値は、環境設定にインストールされたアプリの 1 つで提供される、登録済みコマンドを識別するディクショナリのリストです。app_instance キーは特定のインストール済みアプリを識別し、name キーはこのアプリによって登録されたコマンドの表示名に一致します。上記の例では、4 つのお気に入りコマンドが表示されています。tk-multi-workfiles2 アプリのファイルの表示と保存のダイアログと、標準の Toolkit のパブリッシュとスナップショットのダイアログです。これら 4 つのコマンドはお気に入りシェルフに表示されます。

環境変数

デバッグをサポートするために、エンジンの既定値の一部を変更する環境変数のセットが用意されています。

SHOTGUN_ADOBE_HEARTBEAT_INTERVAL: Python ハートビート間隔(単位は秒、既定は 1 秒)。

SHOTGUN_ADOBE_HEARTBEAT_TOLERANCE: 終了までのハートビートのエラー数(既定は 2)。従来の環境変数 SGTK_PHOTOSHOP_HEARTBEAT_TOLERANCE が設定されている場合は優先されます。

SHOTGUN_ADOBE_NETWORK_DEBUG: ログ出力時に追加のネットワーク デバッグ メッセージを含めます。従来の環境変数 SGTK_PHOTOSHOP_NETWORK_DEBUG が設定されている場合は優先されます。

SHOTGUN_ADOBE_PYTHON: エンジンの起動時に使用する Python の実行可能ファイルへのパス。設定しない場合は、システムの Python が使用されます。Photoshop が Shotgun Desktop や tk-shell エンジンなどの Python プロセスから起動される場合、このプロセスで使用する Python は Photoshop 統合で使用されます。

注: 追加の環境変数が Adobe のフレームワークに存在します。詳細は、開発者用ドキュメントを参照してください。

コンテキスト フィールド表示フック

エンジンには、パネルのコンテキスト ヘッダ セクションに表示されるフィールドを制御するフックがあります。フックには表示する内容をカスタマイズするためにオーバーライドできる 2 つのメソッドがあります。

最初のメソッドは get_entity_fields() メソッドです。このメソッドは、現在の Shotgun コンテキストを表すエンティティ タイプを受け入れます。予想される戻り値は、表示するためにクエリーの必要があるエンティティのフィールドのリストです。エンジン自体はデータのクエリーを非同期に処理します。

Shotgun からデータをクエリーすると、フックの 2 番目のメソッドが呼び出されます。この get_context_html() メソッドは、get_entity_fields() メソッドで指定されたクエリー フィールドが入力されたコンテキスト エンティティ ディクショナリを受け取ります。予想される戻り値は、クエリー対象のエンティティ フィールドを表示するためにフォーマット化された HTML を含む文字列です。

これらのメソッドで必要になることを確認するには、「既定のフックの実装」が役立ちます。

エンジンは常にエンティティのサムネイル(があれば)を表示していますので、注意してください。

映像フックの読み込み

エンジンにはフックが付属し、それにより一部のファイル タイプの読み込み動作を制御することができます。PSD ファイルを、コンポジションではなく単一レイヤとして読み込むほうが良い場合もあります。このような状況では、その動作の仕方を上書きするためにフックが使用されることがあります。

既定のフックの実装

After Effects の API

After Effects の API に関する詳細は、開発者用ドキュメントを参照してください。

インストールと更新

Shotgun Pipeline Toolkit にこのエンジンを追加する

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

> tank Project XYZ install_engine asset tk-aftereffects

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

この項目が既にプロジェクトにインストールされている場合に最新バージョンを取得するには、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-aftereffects からアクセスできます。

特殊な要件

  • 使用するには、Shotgun Pipeline Toolkit Core API のバージョン v0.18.164 以降が必要です。

環境設定

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

automatic_context_switch

タイプ: bool

既定値: True

説明: アクティブなドキュメントを変更した場合にコンテキストを変更するかどうかを制御します。

import_footage_hook

タイプ: hook

既定値: {self}/import_footage.py

説明: 映像が現在のプロジェクトに読み込まれる方法を制御するフックです。

shelf_favorites

タイプ: list

説明: Shotgun Panel のお気に入りシェルフに表示される登録済みコマンドを制御します。これはリストで、各項目は「app_instance」と「name」というキーを持つディクショナリになります。app_instance キーは、環境設定ファイルで定義された特定のアプリ インスタンスにこのエントリを接続します。「name」はお気に入りを作成するためのコマンド名です。

debug_logging

タイプ: bool

説明: デバッグ メッセージをロガーに送信するかどうかを制御します。

context_fields_display_hook

タイプ: hook

既定値: {self}/context_fields_display.py

説明: コンテキスト ヘッダでコンテキスト フィールドがクエリーおよび表示される方法を制御するフックです。

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています
フォローする

0 コメント

ログインしてコメントを残してください。