移動先: 概要 戻り値 キーワード. 関連項目. フラグ. Python 例.

概要

containerTemplate([addNames=boolean], [addView=string], [attributeList=string], [baseName=string], [delete=boolean], [exists=boolean], [expandCompounds=boolean], [fileName=string], [force=boolean], [fromContainer=string], [layoutMode=int], [load=boolean], [matchFile=string], [matchName=string], [removeView=string], [save=boolean], [searchPath=string], [silent=boolean], [templateList=string], [unload=boolean], [viewList=string])

注意: オブジェクト名や引数を表す文字列はカンマで区切ります。これは概要には示されていません。

containerTemplate は 「元に戻す」が不可能、「照会」が可能、「編集」が可能 です。

コンテナ テンプレートは、コンテナのパブリッシュされたインタフェースの説明です。このコマンドは、コンテナのテンプレート ファイルを作成して保存したり、既存のテンプレート ファイルをロードしたりする機能を提供します。テンプレートが存在する限り、ユーザはそのテンプレート情報を照会できます。

戻り値

なし

戻り値の型は照会モードでは照会フラグが基になります。

キーワード

container, template

関連項目

container, containerView

フラグ

addNames, addView, attributeList, baseName, delete, exists, expandCompounds, fileName, force, fromContainer, layoutMode, load, matchFile, matchName, removeView, save, searchPath, silent, templateList, unload, viewList
ロング ネーム（ショート ネーム） 引数型 プロパティ
exists(ex) boolean query
指定したテンプレートが存在するかどうかによって、true または false を返します。matchFile 引数と併用する際、テンプレートが存在し、ロード元のファイル名が指定のファイル名と一致する場合、照会は true を返します。
load(l) boolean
ファイルから既存のテンプレートをロードします。テンプレートに対するファイル名を指定すると、ファイル全体（つまりファイル内のすべてのテンプレート）がロードされます。ファイル名を指定しないと、テンプレート名に基づいて、デフォルトのファイル名が使用されます。
save(s) boolean create
ファイルに指定したテンプレートを保存します。テンプレートに対するファイル名を指定すると、ファイル全体（つまりファイルに関連付けられたすべてのテンプレート）が保存されます。ファイル名を指定しないと、テンプレート名に基づいて、デフォルトのファイル名が使用されます。
delete(d) boolean create
指定したテンプレートとそのファイルを削除します。このテンプレートにコネクトされたすべてのオブジェクト、または同じテンプレート ファイルに含まれるすべてのオブジェクトが削除されます。ファイルを完全に削除しないで単にテンプレートをアンロードするだけの場合は、このコマンドではなくアンロードを使用してください。
unload(u) boolean create
指定したテンプレートをアンロードします。このアクションは、関連するテンプレート ファイルを削除するのではなく、単にテンプレート定義をカレント セッションから削除するだけです。完全に削除する必要がある場合は、削除アクションを使用してください。
fromContainer(fc) string create
この引数は作成または編集モードで使用し、テンプレート内容の作成に使用されるコンテナ ノードを指定します。テンプレートの作成モードでは、指定したコンテナ内のパブリッシュされたアトリビュートのリストに基づいて、テンプレート定義が作成されます。編集モードで、addNames フラグと併用するか、他のフラグを使用しない場合、コンテナ上にあるパブリッシュされた名前のうち、テンプレートのアトリビュートとして存在しないものはテンプレートに追加されます。 このフラグは addView などのフラグとも併用します。
addNames(an) boolean edit
編集モードで、fromContainer フラグと併用する場合、コンテナ上にあるパブリッシュされた名前のうち、テンプレートのアトリビュートとして存在しないものはテンプレートに追加されます。
addView(av) string createedit
この引数は、新しいビューを指定した名前でテンプレートに追加するのに使用します。デフォルトでは、すべてのテンプレート アトリビュートのフラットなリストを含むビューが作成されます。layoutMode フラグでは、より詳細なレイアウト オプションを指定できます。新規ビューをテンプレート ファイルと格納する前に、テンプレートを保存する必要があります。
removeView(rv) string createedit
この引数を使用して、指定したビューをテンプレートから削除します。 ビューをテンプレート ファイルから永久に削除する前に、テンプレートを保存する必要があります。
layoutMode(lm) int create
この引数は、ビューの作成時にレイアウト モードを指定するのに使用します。値は次のとおりです。0: フラット リストでレイアウト（ビューをコンテナから作成しない場合のデフォルト） 1: ノードでグループ化したレイアウト（ビューをコンテナから作成する場合のデフォルト） ノード情報を必要とするレイアウト モードには、リファレンス コンテナを提供するために fromContainer 引数が必要です。ビューは定義済みのテンプレート アトリビュートしか参照できないことに注意してください。つまり、fromContainer フラグを使用してビューを既存のテンプレートに追加する場合、テンプレートとコンテナの両方で定義されたアトリビュートのみがビューに追加されます（つまり、テンプレートで定義されていないコンテナにパブリッシュされたアトリビュートは無視されます）。
expandCompounds(ec) boolean createedit
この引数は、複合の親アトリビュートとその子を両方ともコンテナにパブリッシュする場合に、生成されたビューにどのように追加するかを定義するのに使用します。 true の場合、コンテナにパブリッシュされた複合の親アトリビュートとすべての複合の子アトリビュートがビューに追加されます。false の場合は、親アトリビュートのみがビューに追加されます。注: 子アトリビュートのみがパブリッシュされて親はパブリッシュされない場合は、子がビューに追加されます。このフラグは親と子の両方のアトリビュートがコンテナにパブリッシュされる状況でのみ使用します。デフォルト値は false です。
fileName(fn) string createquery
テンプレートに関連付けるファイル名を指定します。この引数は、ロード、保存、または照会モードと併用できます。テンプレートに関連付けられた名前がない場合は、テンプレート名に基づいたデフォルトのファイル名が使用されます。ファイル名とテンプレート名を対応させることをお勧めしますが、必須ではありません。
matchFile(mf) string query
このフラグは、他のフラグと併用して照会モードで使用し、照会操作の一部として一致させるオプションのファイル名を指定します。

このフラグは照会モードでは値が必要になります。
matchName(mn) string query
このフラグは、他のフラグと併用して照会モードで使用し、照会操作の一部として一致させるオプションのテンプレート名を指定します。ベース テンプレート名はマッチングに使用され、同じベース名を持つすべてのテンプレートは異なるパッケージを渡ってマッチされます。

このフラグは照会モードでは値が必要になります。
force(f) boolean create
このフラグは他のアクションとともに使用して、上書きや破壊的な操作を実行できるようにします。ロードで使用すると、ファイルから既存のテンプレートを再ロードできるようになります。作成モードで使用すると、既存のテンプレートを再作成することができるようになります（fromContainer 引数を使用してテンプレートを再生成する場合など）。
attributeList(al) string createqueryedit
照会モードで使用して、テンプレート定義に含まれるアトリビュートのリストを返します。
viewList(vl) string createquery
照会モードで使用して、テンプレート上に定義されたすべてのビューのリストを返します。
baseName(bn) string createquery
照会モードで使用して、テンプレートのベース名を返します。ベース名はすべての修飾語句を除いたテンプレート名です。
templateList(tl) string query
照会モードで使用して、ロードされたすべてのテンプレートのリストを返します。この照会はオプションの matchFile フラグおよび matchName フラグと併用できます。matchFile フラグと併用すると、テンプレートのリストは、指定したファイルにコネクトされたものに限定されます。matchName フラグと併用すると、テンプレートのリストは、指定したテンプレート名にマッチするものに限定されます。
searchPath(sp) string query
照会モードで使用すると、テンプレート ファイルを検索する場所すべての検索順リストを返します。検索パスのカスタマイズはカレントのワークスペースから行います。
silent(si) boolean createqueryedit
サイレント モードは、通常はコマンドの実行でレポートされるすべてのエラーや警告メッセージを出力しないようにします。戻り値には影響しません。
: コマンドの作成モードで使用可能なフラグ : コマンドの編集モードで使用可能なフラグ
: コマンドの照会モードで使用可能なフラグ : タプルまたはリストとして渡された複数の引数を持てるフラグ

Python 例

import maya.cmds as cmds

#    Create a container template.
#
cmds.containerTemplate( 'characterRig' )
# Create a container template using the published attribute information from
# container1.
cmds.containerTemplate ( 'characterRig', fromContainer='container1');
#
# Save the template to a template file in the default template location.
cmds.containerTemplate -save characterRig;
# Load a template (the template is located along the template search path)
cmds.containerTemplate ('characterRig', load=True);
# Re-load a template that has already been loaded
# This is useful if you have made edits to the template outside of maya
cmds.containerTemplate ('characterRig', force=True, load=True);
# Determine the file that a template was loaded from
cmds.containerTemplate ('characterRig', query=True, fileName=True);
# 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.
#
cmds.containerTemplate('characterRig', edit=True, addView='newView', fromContainer='container1', layoutMode=1)
cmds.containerTemplate ('characterRig', save=True)
#
# Add another view to a container template.
# This view will be generated with a default layout and can be
# subsequently customized.
#
cmds.containerTemplate ('characterRig', edit=True, addView="newView2")
cmds.containerTemplate ('characterRig', save=True)
#
# 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.
#
cmds.containerTemplate ('characterRig', query=True, attributeList=True)
# Result: [u'attribute1', u'attribute2', u'attribute3'] #
#
# List all loaded templates
list = cmds.containerTemplate(query=True, templateList=True);
# Result: [u'Object', u'characterRig'] #
#
# List all templates matching a a given template name
# Note that all templates with matching base name (in any package) will
# be returned.
cmds.containerTemplate (query=True, templateList=True, matchName='characterRig')
# Result: [u'characterRig'] #
#