Python コマンドを使用して XGen ファイルの書き出しおよび読み込みを行う

Python コマンドを使用して、XGen のコレクション、ディスクリプション、デルタ、モディファイアのファイルを保存およびロードすることができます。Python コマンドは、Maya で実行することも、Python セッションから実行することもできます。

XGen エディタのメニュー オプションを使用して XGen ファイルの保存とロードを行う方法については、「XGen ファイルを保存およびロードする」を参照してください。

また、「XGen のファイルとフォルダを管理する」も参照してください。

コレクション ファイル

XGen Python API では、コレクションはパレットと呼ばれます。

exportPalette を使用して、コレクション(.xgen)ファイルを作成します。

xg.eportPalette(string palette, string fileName)

palette - 書き出すパレット ファイルの名前
fileName - 作成する .xgen ファイルの名前

importPalette を使用して、コレクション ファイルを読み込みます。

xg.importPalette(string palette, string deltas[], string nameSpace="")

palette - 読み込むパレット ファイルの名前
deltas - 読み込み時に適用するオプションのデルタ ファイルのリスト
nameSpace - 読み込んだパレットに適用するオプションのネームスペース

デルタ ファイル

デルタ(.xgd)ファイルを作成するには、createDeltaを使用します。

xg.createDelta(string palette, string newDelta)
palette - デルタを作成する対象となるパレットの名前
newDelta - デルタ ファイルの名前

コレクションの読み込みと同時にデルタ ファイルを適用できますが、デルタ ファイルを個別に適用することもできます。ApplyDelta コマンドを使用すると、デルタ ファイルのみを適用できます。

xg.applyDelta(string palette, string delta)

palette - デルタ ファイルを適用するパレットの名前
delta - デルタ ファイルの名前

ディスクリプション ファイル

ディスクリプション(.xdsc)ファイルを作成するには、exportDescription を使用します。

xg.exportDescription(string palette, string description, string fileName, bool guides=false)

palette - ディスクリプションが含まれているパレットの名前
description - 書き出すディスクリプションの名前
fileName - ガイドを作成するディスクリプション ファイルの名前
flag - 将来のガイド転送伝達用(未使用)

ディスクリプションを読み込む前に、既存のコレクションが存在する必要があります。ディスクリプションを読み込むには、importDescription を使用します。

xg.importDescription(string palette, string fileName)

palette - ディスクリプションの読み込み先となるパレットの名前
fileName - 読み込むディスクリプション ファイルの名前

モディファイア ファイル

XGen Python API では、モディファイアは FX モジュールと呼ばれます。

モディファイア(.xgfx)ファイルを保存するには、Python の exportFXModule コマンドを使用します。

xg.exportFXModule(string palette, string description, string name, string fileName)

palette - fx モジュールを保持するパレットの名前
description - fx モジュールを保持するディスクリプションの名前
name - 書き出す fx モジュールの名前
fileName - 作成する fx モジュール ファイルの名前

モディファイア ファイルを読み込むには、Python の importFXModule コマンドを使用します。

xg.importFXModule(string palette, string description, string fileName)
palette - 読み込み先となるパレットの名前
description - fx モジュールの読み込み先となるディスクリプションの名前
fileName - 読み込む fx モジュール ファイルの名前