containerTemplate

ジャンプ先: 概要. 戻り値. キーワード. 関連. フラグ. MEL 例.

概要

containerTemplate [-addBindingSet string] [-addNames] [-addView string] [-allKeyable] [-attribute string] [-attributeList string] [-baseName string] [-bindingSetList string] [-childAnchor] [-delete] [-exists] [-expandCompounds boolean] [-fileName string] [-force] [-fromContainer string] [-fromSelection] [-layoutMode int] [-load] [-matchFile string] [-matchName string] [-parentAnchor] [-publishedNodeList string] [-removeBindingSet string] [-removeView string] [-rootTransform] [-save] [-searchPath string] [-silent] [-templateList string] [-unload] [-updateBindingSet string] [-useHierarchy] [-viewList string]

containerTemplate は、取り消し不可能、照会可能、および編集可能です。

戻り値

なし

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

キーワード

関連

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
-addBindingSet(-abs)	string
この引数を使用して、指定した名前の新しいバインド セットをテンプレートに追加します。既定のバインド セットが作成されます。バインド セットがすでに存在する場合、既存のバインド セットを置き換えるには force フラグを使用する必要があります。fromContainer オプションと一緒に使用すると、指定したコンテナの既存のバインドをもとに既定のバインドが開始されます。リファレンス コンテナなしで使用すると、バインド セットはプレースホルダ エントリが含まれた状態で作成されます。新規バインド セットをテンプレート ファイルに永久保存するには、テンプレートを保存する必要があります。
-addNames(-an)
編集モードで、fromContainer フラグと一緒に使用する場合、コンテナ上にあるパブリッシュされた名前のうち、テンプレートのアトリビュートとして存在しないものはテンプレートに追加されます。
-addView(-av)	string
この引数は、新しいビューを指定した名前でテンプレートに追加するのに使用します。既定では、すべてのテンプレート アトリビュートのフラットなリストを含むビューが作成されます。layoutMode フラグでは、より詳細なレイアウト オプションを指定できます。新規ビューをテンプレート ファイルと格納する前に、テンプレートを保存する必要があります。
-allKeyable(-ak)
fromSelection フラグが true で fromContainer が false のとき使用されます。true の場合、すべてのキー設定可能なアトリビュートを使用してテンプレートまたはビューを定義します。false の場合、アトリビュート フラグに渡されるアトリビュートを使用します。
-attribute(-at)	string
fromSelection が true で allKeyable が false の場合、このアトリビュート名を使用し、テンプレート ファイルにアトリビュート項目が作成されます。
-attributeList(-al)	string
照会モードで使用して、テンプレート定義に含まれるアトリビュートのリストを返します。
-baseName(-bn)	string
照会モードで使用して、テンプレートのベース名を返します。ベース名はすべての修飾語句を除いたテンプレート名です。
-bindingSetList(-bsl)	string
照会モードで使用するこのフラグは、テンプレートに定義されたすべてのバインド セットのリストを返します。
-childAnchor(-can)
このフラグは publishedNodeList を照会する場合に、オプションとして指定できます。結果のリストには、childAnchor タイプのパブリッシュされたノードのみが表示されます。
-delete(-d)
指定したテンプレートとそのファイルを削除します。このテンプレートに接続されたすべてのオブジェクト、または同じテンプレート ファイルに含まれるすべてのオブジェクトが削除されます。ファイルを完全に削除しないで単にテンプレートをアンロードするだけの場合は、このコマンドではなくアンロードを使用してください。
-expandCompounds(-ec)	boolean
この引数は、複合の親アトリビュートとその子を両方ともコンテナにパブリッシュする場合に、生成されたビューにどのように追加するかを定義するのに使用します。true の場合、コンテナにパブリッシュされた複合の親アトリビュートとすべての複合の子アトリビュートがビューに追加されます。false の場合は、親アトリビュートのみがビューに追加されます。注: 子アトリビュートのみがパブリッシュされて親はパブリッシュされない場合は、子がビューに追加されます。このフラグは親と子の両方のアトリビュートがコンテナにパブリッシュされる状況でのみ使用します。既定値は false です。
-fromContainer(-fc)	string
この引数は作成または編集モードで使用し、テンプレート内容の作成に使用されるコンテナ ノードを指定します。テンプレートの作成モードでは、指定したコンテナ内のパブリッシュされたアトリビュートのリストに基づいて、テンプレート定義が作成されます。編集モードで、addNames フラグと一緒に使用するか、他のフラグを使用しない場合、コンテナ上にあるパブリッシュされた名前のうち、テンプレートのアトリビュートとして存在しないものはテンプレートに追加されます。このフラグは addView などのフラグとも一緒に使用します。
-fromSelection(-fs)
true の場合、アクティブなセレクション リストを使用してテンプレートまたはビューを作成します。allKeyable も true の場合、セレクション内のキー設定可能なアトリビュートからテンプレートを作成するか、アトリビュート フラグで指定したアトリビュートを使用し、テンプレートを作成します。
-layoutMode(-lm)	int
この引数は、ビューの作成時にレイアウト モードを指定するのに使用します。値は次のとおりです。0: フラット リストでレイアウト(ビューをコンテナから作成しない場合の既定) 1: ノードでグループ化したレイアウト(ビューをコンテナから作成する場合の既定)ノード情報を必要とするレイアウト モードには、リファレンス コンテナまたはセレクションを提供するために fromContainer または fromSelection 引数が必要です。ビューは定義済みのテンプレート アトリビュートしか参照できないことに注意してください。つまり、fromContainer フラグまたは fromSelection フラグを使用してビューを既存のテンプレートに追加する場合、テンプレートとコンテナの両方で定義されたアトリビュートまたは現在のセレクションのみがビューに追加されます(つまり、テンプレートで定義されていないコンテナにパブリッシュされたアトリビュートは無視されます)。
-matchName(-mn)	string
このフラグは、他のフラグと一緒に使用して照会モードで使用し、照会操作の一部として一致させるオプションのテンプレート名を指定します。ベース テンプレート名は一致に使用され、同じベース名を持つすべてのテンプレートは異なるパッケージを渡って一致されます。 照会モードでは、このフラグに値が必要になります。
-parentAnchor(-pan)
このフラグは publishedNodeList を照会する場合に、オプションとして指定できます。結果のリストには、parentAnchor タイプのパブリッシュされたノードのみが表示されます。
-publishedNodeList(-pnl)	string
照会モードで使用するこのフラグは、テンプレート定義に含まれるパブリッシュ済みノードのリストを返します。既定では、テンプレートにあるすべてのパブリッシュされたノードを返します。パブリッシュされたノードのリストは、childAnchor、parentAnchor、rootTransform フラグを使って特定のタイプのパブリッシュされたノードに限定することができます。オプションのフラグを指定すると、指定したタイプのノードのみが返されます。
-removeBindingSet(-rbs)	string
この引数を使用して、指定したバインド セットをテンプレートから除去します。バインド セットをテンプレート ファイルから永久に除去するには、テンプレートを保存する必要があります。
-removeView(-rv)	string
この引数を使用して、指定したビューをテンプレートから除去します。ビューをテンプレート ファイルから永久に除去する前に、テンプレートを保存する必要があります。
-rootTransform(-rtn)
このフラグは publishedNodeList を照会する場合に、オプションとして指定できます。結果のリストには、rootTransform タイプのパブリッシュされたノードのみが表示されます。
-save(-s)
ファイルに指定したテンプレートを保存します。テンプレートに対するファイル名を指定すると、ファイル全体(つまりファイルに関連付けられたすべてのテンプレート)が保存されます。ファイル名を指定しないと、テンプレート名に基づいて、既定のファイル名が使用されます。
-searchPath(-sp)	string
テンプレートの検索パスは、テンプレート ファイルが検索されるすべての場所を、最初に検索される場所から最後に検索される場所までの順番に列挙するリストです。テンプレートの検索パス設定は現在のワークスペースに格納され、「テンプレート」のファイル規則のエントリとして設定、照会することができます(詳細については、workspace コマンドを参照してください)。編集モードでは、このフラグで検索パス設定をカスタマイズすることができます。検索パスの値を設定する場合、リストは現在のプラットフォームが要求するパス リストのフォーマットに準拠している必要があります。つまり Windows の場合はパスをセミコロン「;」で分け、Linux と Mac OSX の場合はコロン「:」で分けます。環境変数を使用することもできます。Maya がカスタマイズした設定にビルトイン パスを自動的に追加することがあります。照会モードでは、このフラグは検索パスの現在のコンテンツを返します。カスタマイズ、ビルトイン双方のすべてのパスが、照会の戻り値に含まれます。
-templateList(-tl)	string
照会モードで使用して、ロードされたすべてのテンプレートのリストを返します。この照会はオプションの matchFile フラグおよび matchName フラグと一緒に使用できます。matchFile フラグと一緒に使用すると、テンプレートのリストは、指定したファイルに接続されたものに限定されます。matchName フラグと一緒に使用すると、テンプレートのリストは、指定したテンプレート名に一致するものに限定されます。
-updateBindingSet(-ubs)	string
この引数を使用して、既存のバインド セットを新規のバインドに更新します。fromContainer 引数と一緒に使用すると、指定コンテナのバインドをもとに、バインド セット エントリはバインド セット内で置き換えまたはマージされます。force フラグを使用すると、バインド セットの既存エントリの値が置き換えられます。使用しないと、新規エントリのみがバインド セットにマージされ、既存エントリは変更されません。リファレンス コンテナなしで使用すると、バインド セットはプレースホルダ エントリが含まれた状態で更新されます。新規バインド セットをテンプレート ファイルに永久保存するには、テンプレートを保存する必要があります。
-useHierarchy(-uh)
true であり fromSelection フラグが設定されている場合、セレクション リストはその階層も含むよう拡張されます。
-exists(-ex)
指定したテンプレートが存在するかどうかによって、true または false を返します。matchFile 引数と一緒に使用する際、テンプレートが存在し、ロード元のファイル名が指定のファイル名と一致する場合、照会は true を返します。
-fileName(-fn)	string
テンプレートに関連付けるファイル名を指定します。この引数は、ロード、保存、または照会モードと一緒に使用できます。テンプレートに関連付けられた名前がない場合は、テンプレート名に基づいた既定のファイル名が使用されます。ファイル名とテンプレート名を対応させることをお勧めしますが、必須ではありません。
-force(-f)
このフラグは他のアクションとともに使用して、上書きや破壊的な操作を実行できるようにします。ロードで使用すると、ファイルから既存のテンプレートを再ロードできるようになります。作成モードで使用すると、既存のテンプレートを再作成することができるようになります(fromContainer 引数を使用してテンプレートを再生成する場合など)。
-load(-l)
ファイルから既存のテンプレートをロードします。テンプレートに対するファイル名を指定すると、ファイル全体(つまりファイル内のすべてのテンプレート)がロードされます。ファイル名を指定しないと、テンプレート名に基づいて、既定のファイル名が使用されます。
-matchFile(-mf)	string
このフラグは、他のフラグと一緒に使用して照会モードで使用し、照会操作の一部として一致させるオプションのファイル名を指定します。 照会モードでは、このフラグに値が必要になります。
-silent(-si)
サイレント モードは、通常はコマンドの実行でレポートされるすべてのエラーや警告メッセージを出力しないようにします。戻り値には影響しません。
-unload(-u)
指定したテンプレートをアンロードします。このアクションは、関連するテンプレート ファイルを削除するのではなく、単にテンプレート定義を現在のセッションから除去するだけです。
-viewList(-vl)	string
照会モードで使用するこのフラグは、テンプレートに定義されたすべてのビューのリストを返します。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	コマンド内でフラグを複数回使用できます。

MEL 例

// Create a container template using the published attribute information from
// container1.
//
containerTemplate -fromContainer container1 characterRig;
//
// Save the template to a template file in the default template location.
containerTemplate -save characterRig;
//
// Load a template (the template is located along the template search path)
containerTemplate -load characterRig;
//
// Re-load a template that has already been loaded
// This is useful if you have made edits to the template outside of maya
containerTemplate -force -load characterRig;
//
// Determine the file that a template was loaded from
containerTemplate -query -fileName characterRig;
// Result: C:/myTemplates/characterRig.template //
//
// Add a view to a container template. This view will be generated from the
// given container, and will use a group-by-node hierarchical layout.
// The view can be subesequently customized if desired.
//
containerTemplate -edit -addView "newView" -fromContainer container1 -layoutMode 1 characterRig;
containerTemplate -save characterRig;
//
// Add another view to a container template.
// This view will be generated with a default layout and can be
// subsequently customized.
//
containerTemplate -edit -addView "newView2" characterRig;
containerTemplate -save characterRig;
//
// Get the list of attributes in the template.  This will return
// a flat list of attribute names in the order in which they appear
// in the template definition.
//
containerTemplate -query -attributeList characterRig;
// Result:  attribute1 attribute2 attribute3 ...
//
// List all loaded templates
string $list[] = `containerTemplate -query -templateList`;
// List all templates matching a a given template name
// Note that all templates with matching base name (in any package) will
// be returned.
string $matches[] = `containerTemplate -query -templateList -matchName "characterRig"`;
// Result: characterRig
//