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

概要

assembly([active=string], [activeLabel=string], [canCreate=string], [createOptionBoxProc=script], [createRepresentation=string], [defaultType=string], [deleteRepresentation=string], [deregister=string], [input=string], [isAType=string], [isTrackingMemberEdits=string], [label=string], [listRepTypes=boolean], [listRepTypesProc=script], [listRepresentations=boolean], [listTypes=boolean], [name=string], [newRepLabel=string], [postCreateUIProc=script], [proc=script], [renameRepresentation=string], [repLabel=string], [repName=string], [repNamespace=string], [repPostCreateUIProc=string], [repPreCreateUIProc=string], [repType=string], [repTypeLabel=string], [repTypeLabelProc=script], [type=string])

注: オブジェクトの名前と引数を表す文字列は、カンマで区切る必要があります。これはシノプシスに示されていません。

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

アセンブリのシーン アセンブリ フレームワークへの登録、アセンブリの作成、編集、および照会を行うコマンドです。アセンブリ ノードは DAG ノードであるため、さまざまな DAG エディタ(アウトライナ、ハイパーグラフ、ノード エディタ)で表示されます。アセンブリの作成時、ノード名は既定でノード タイプの名前に設定されます。assembly コマンドでは、アセンブリ ノード ベース クラスから派生する任意のノードを作成できます。これらのタイプのレジストリとしても機能するため、さまざまなスクリプト コールバックを assembly コマンドで定義して登録できます。これらのコールバックはアセンブリ ノードの操作中に Maya によって起動され、動作のカスタマイズに使用できます。

新しいアセンブリ タイプを登録する

アセンブリ ノード ベース クラスから派生した新しいタイプのアセンブリを定義する場合、assembly コマンドを使用して多数のプロシージャを定義すると、新しいアセンブリ ノード タイプを Maya に正常に統合することができます。これらのプロシージャの大部分はアセンブリ タイプを Maya ユーザ インタフェースと統合するために使用され、非インタラクティブなスクリプト用には必要ありません。詳細については、Maya API マニュアルの MPxAssembly クラスの説明を参照してください。assembly コマンドを使用して登録することができる重要なプロシージャの一部を次に示します。
listRepTypesProc
新しいアセンブリ タイプが作成できるリプリゼンテーションタイプをリストするプロシージャです。これにより、Maya は実際にアセンブリ ノードを作成することなくアセンブリによって作成できるリプリゼンテーション タイプを照会することができます。
repTypeLabelProc
アセンブリが作成できるリプリゼンテーション タイプのユーザ インタフェースに表示される(場合によってはローカライズされた)ラベルを返すプロシージャです。ラベルは、短くわかりやすい判読可能なリプリゼンテーション タイプの説明である必要があります。
createOptionBoxProc
アセンブリ タイプの作成オプション用のオプション ボックスを生成するプロシージャです。定義されている場合、このプロシージャにより、そのアセンブリのタイプの作成に使用できるオプション ボックスが生成されます。
repPreCreateUIProc
リプリゼンテーションの作成前にダイアログを生成するプロシージャです。定義されている場合、Maya によって呼び出されるため、アセンブリのリプリゼンテーションのタイプを作成する前にユーザがインタラクティブに選択することができます。
postCreateUIProc
アセンブリの作成後にダイアログを生成するプロシージャです。定義されている場合、Maya によって呼び出されるため、アセンブリの作成後にユーザがインタラクティブに選択し、それらをアセンブリに適用することができます。

戻り値

なし

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

キーワード

representation, assembly

フラグ

active, activeLabel, canCreate, createOptionBoxProc, createRepresentation, defaultType, deleteRepresentation, deregister, input, isAType, isTrackingMemberEdits, label, listRepTypes, listRepTypesProc, listRepresentations, listTypes, name, newRepLabel, postCreateUIProc, proc, renameRepresentation, repLabel, repName, repNamespace, repPostCreateUIProc, repPreCreateUIProc, repType, repTypeLabel, repTypeLabelProc, type
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
active(a) string queryedit
アクティブ リプリゼンテーションを名前で設定するか、またはアクティブ リプリゼンテーションの名前を照会します。編集モードは複数のアセンブリに適用することができます。照会モードでは、単一のアセンブリのみが指定されている場合は単一の文字列を返し、複数のアセンブリが指定されている場合は文字列の配列を返します。名前として空の文字列を使用することは、現在のアクティブ リプリゼンテーションを非アクティブにすることを意味します。
activeLabel(al) string queryedit
アクティブ リプリゼンテーションをラベルで設定するか、またはアクティブ リプリゼンテーションのラベルを照会します。編集モードは複数のアセンブリに適用することができます。照会モードでは、単一のアセンブリのみが指定されている場合は単一の文字列を返し、複数のアセンブリが指定されている場合は文字列の配列を返します。
canCreate(cc) string query
特定のアセンブリが作成できるリプリゼンテーション タイプを照会します。
createOptionBoxProc(cob) script queryedit
特定のアセンブリ タイプのオプション ボックス メニュー プロシージャを設定または照会します。このアセンブリ タイプは、-type フラグを使用してアセンブリ タイプを明示的に指定しない限り、既定のタイプになります。
createRepresentation(cr) string edit
アセンブリに対して特定のリプリゼンテーション タイプを作成および追加します。リプリゼンテーション タイプが追加のパラメータを必要とする場合は、「input」フラグを使用して指定する必要があります。たとえば、Maya シーン アセンブリ リファレンス実装のキャッシュおよびシーン リプリゼンテーションは入力ファイルを必要とします。
defaultType(dt) string queryedit
既定のアセンブリのタイプを設定または照会します。assembly コマンドを使用してアセンブリ オブジェクトではなくアセンブリ タイプで操作を実行する場合、-type フラグを使用してアセンブリ タイプを明示的に指定しない限り、既定のタイプで実行されます。
deleteRepresentation(dr) string edit
特定のリプリゼンテーションをアセンブリから削除します。
deregister(d) string edit
登録されているアセンブリ タイプを登録解除します。登録解除したタイプが既定のタイプである場合、既定のタイプは空の文字列に設定されます。
input(input) string edit
リプリゼンテーション作成時のリプリゼンテーション作成プロシージャの追加パラメータを指定します。このフラグは createRepresentation フラグと一緒に使用する必要があります。
isAType(isa) string query
指定したオブジェクトがアセンブリ タイプかどうかを照会します。
isTrackingMemberEdits(ite) string query
指定したオブジェクトがメンバー編集をトラッキングするかどうかを照会します。
label(lbl) string queryedit
アセンブリ タイプのラベルを設定または照会します。アセンブリ タイプはフラグ「type」で指定されます。タイプが指定されていない場合、既定のタイプが使用されます。
listRepTypes(lrt) boolean query
指定したアセンブリ タイプでサポートされているリプリゼンテーション タイプを照会します。このアセンブリ タイプは、-type フラグを使用してアセンブリ タイプを明示的に指定しない限り、既定のタイプになります。
listRepTypesProc(lrp) script queryedit
アセンブリ タイプでサポートされるリプリゼンテーション タイプのリストを提供するプロシージャを設定または照会します。この手順では引数を使用せず、このアセンブリ タイプで作成できるリプリゼンテーション タイプの完全なセットを表すリプリゼンテーション タイプの文字列配列を返します。このプロシージャが適用されるアセンブリ タイプは、type フラグを使用してアセンブリ タイプを明示的に指定しない限り、既定のタイプになります。
listRepresentations(lr) boolean query
特定のアセンブリの作成したリプリゼンテーション リストを照会します。-repType フラグを使用すると、リストをフィルタし、1つのリプリゼンテーション タイプのリプリゼンテーションを返すことができます。-repType フラグを使用しない場合、作成したすべてリプリゼンテーションが返されます。
listTypes(lt) boolean query
サポートされているアセンブリ タイプを照会します。
name(n) string create
アセンブリの作成時の名前を指定します。
newRepLabel(nrl) string edit
リプリゼンテーション ラベルの編集時に設定するリプリゼンテーション ラベルを指定します。
postCreateUIProc(aoc) script queryedit
指定したアセンブリ タイプの UI 作成後プロシージャを設定または照会します。このプロシージャは、指定したタイプのアセンブリがスクリプトではなく UI から作成されるとすぐに Maya によって起動されます。このプロシージャを使用してダイアログを起動し、新しく作成したアセンブリの初期パラメータを取得および設定することができます。このアセンブリ タイプは、-type フラグを使用してアセンブリ タイプを明示的に指定しない限り、既定のタイプになります。
proc(prc) script edit
指定したアセンブリ タイプのリプリゼンテーション UI 作成後または作成前プロシージャを設定するときのプロシージャを指定します。このアセンブリ タイプは、-type フラグを使用してアセンブリ タイプを明示的に指定しない限り、既定のタイプになります。
renameRepresentation(rnr) string edit
このフラグの引数であるリプリゼンテーションの名前を変更します。新しい名前を提供するには repName フラグを使用しなければなりません。
repLabel(rl) string queryedit
指定したアセンブリについて、このフラグの引数であるリプリゼンテーションのラベルを照会または編集します。照会モードと編集モードの両方で、-repLabel フラグはリプリゼンテーションの名前を指定します。編集モードでは、-newRepLabel フラグを使用して新しいリプリゼンテーション ラベルを指定する必要があります。

照会モードでは、このフラグに値が必要になります。

repName(rnm) string edit
リプリゼンテーションの作成または名前変更時に設定するリプリゼンテーション名を指定します。このフラグは createRepresentation フラグの場合にはオプションです。省略すると、アセンブリはリプリゼンテーションに名前を付けます。これは renameRepresentation フラグの場合には必須です。
repNamespace(rns) string query
このアセンブリ ノードのリプリゼンテーションのネームスペースを照会します。返される値は、リプリゼンテーションのアクティブ化によって作成されたノードが追加されるネームスペースを作成するために Maya で使用されます。ネームスペースが親ネームスペースに追加されたときに名前の衝突が発生した場合、Maya は新しい名前で repNamespace を更新します。アセンブリ ノードを処理するときは、(このフラグが影響しない、または照会しない)アセンブリ ノード自体のネームスペースと、そのリプリゼンテーションのネームスペースの 2 つのネームスペースが関係します。リプリゼンテーションのネームスペースは、アセンブリ ノードの子のネームスペースです。アセンブリ ノードのネームスペースは、それに含まれるアセンブリによって設定されるか(ネストされている場合)、最上位のファイルによって設定されます。アセンブリ ノードのネームスペースとリプリゼンテーションのネームスペースのいずれかまたは両方は、空の文字列にすることができます。アセンブリ ノードがネストされている場合、アセンブリ ノードのネームスペースは(そのネストにより)それに含まれるアセンブリのリプリゼンテーションのネームスペースになります。
repPostCreateUIProc(poc) string queryedit
特定のリプリゼンテーション タイプ、および特定のアセンブリ タイプの UI 作成後プロシージャを設定または照会します。このプロシージャは 2 つの引数を取ります。1 つはアセンブリへの DAG パス、もう 1 つはリプリゼンテーションの名前です。値は返しません。指定したタイプのリプリゼンテーションがスクリプトからではなく UI から作成されるとすぐに Maya によって起動されます。このプロシージャを使用してダイアログを起動し、新しく作成したリプリゼンテーションの初期パラメータを取得および設定することができます。リプリゼンテーション タイプはこのフラグの引数です。プロシージャ名を指定するには、-proc フラグを使用する必要があります。このアセンブリ タイプは、-type フラグを使用してアセンブリ タイプを明示的に指定しない限り、既定のタイプになります。

照会モードでは、このフラグに値が必要になります。

repPreCreateUIProc(pec) string queryedit
特定のリプリゼンテーション タイプ、および特定のアセンブリ タイプの UI 作成前プロシージャを設定または照会します。このプロシージャは引数を取らず、Maya が -createRepresentation フラグを使用して assembly コマンドを起動したときに -input フラグに引数として渡される文字列を返します。リプリゼンテーション作成前プロシージャは、指定したタイプのリプリゼンテーションがスクリプトからではなく UI から作成される直前に Maya によって起動されます。このプロシージャを使用してダイアログを起動し、新しいリプリゼンテーションの作成引数を取得することができます。リプリゼンテーション タイプはこのフラグの引数です。プロシージャ名を指定するには、-proc フラグを使用する必要があります。このアセンブリ タイプは、-type フラグを使用してアセンブリ タイプを明示的に指定しない限り、既定のタイプになります。

照会モードでは、このフラグに値が必要になります。

repType(rt) string query
-listRepresentations 照会でフィルタとして使用するリプリゼンテーション タイプを指定します。リプリゼンテーション タイプはこのフラグの引数です。

照会モードでは、このフラグに値が必要になります。

repTypeLabel(rtl) string query
特定のリプリゼンテーション タイプのラベルを照会します。

照会モードでは、このフラグに値が必要になります。

repTypeLabelProc(rtp) script queryedit
指定したアセンブリ タイプで、リプリゼンテーション タイプのラベルを提供するプロシージャを設定または照会します。プロシージャはリプリゼンテーション タイプを唯一の引数として取り、ローカライズされたリプリゼンテーション タイプのラベルを返します。このプロシージャが適用されるアセンブリ タイプは、-type フラグを使用してアセンブリ タイプを明示的に指定しない限り、既定のタイプになります。
type(typ) string createqueryedit
指定した登録されているアセンブリ タイプのプロパティを設定または照会します。

照会モードでは、このフラグに値が必要になります。


フラグはコマンドの作成モードで表示できます フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。

Python 例

import maya.cmds as cmds

#Create a default type of assembly and name it MyAssembly.
#The assembly name is optional.
#
cmds.assembly(name='MyAssembly')
#Create an assembly of type MyAssemblyType and name it MyAssembly.
#
cmds.assembly(name='MyAssembly', type='MyAssemblyType')
#Set the default type to be MyAssemblyType.
#
cmds.assembly(edit=True, defaultType='MyAssemblyType')
#Create a representation of type "MyRepType", on assembly myAssembly, and
#name it "MyRepName"
#
cmds.assembly(myAssembly, edit=True, createRepresentation='MyRepType',
              repName='MyRepName')
#Rename representation "MyRepName" to "MyNewRepName" on assembly myAssembly.
#
cmds.assembly(myAssembly, edit=True, renameRepresentation='MyRepName',
                      repName='MyNewRepName')
#Create a representation of type "Locator", on assembly myAssembly, name it
#"myLocator", and add an annotation using the input flag.
#
cmds.assembly(myAssembly, edit=True, createRepresentation='Locator',
			  repName="myLocator", input="An Annotation")
#Create a representation of type "Scene", on assembly myAssembly,
#using file "/path/to/mayafile.mb"
#
cmds.assembly(myAssembly, edit=True, createRepresentation='Scene',
			  input="/path/to/mayafile.mb")
#Delete scene representation from assembly myAssembly
cmds.assembly(myAssembly, edit=True, deleteRepresentation="mayafile.mb")
#Delete locator representation from assembly myAssembly
cmds.assembly(myAssembly, edit=True, deleteRepresentation="myLocator")
#Set the procedure that provides the representation type label for
#an assembly type.
#
cmds.assembly(edit=True, repTypeLabelProc='MyRepTypeLabelQuery', type='MyAssembly')
#Set the label for the default assembly type.
#
cmds.assembly(edit=True, label='My Assembly Type')
#Set the procedure that provides the representation type list which the
#default assembly supports.
#
cmds.assembly(edit=True, listRepTypesProc='MyRepTypesProc')
#Set the pre-create UI procedure for a representation type, for a
#specific type of assembly.
#
cmds.assembly(edit=True, repPreCreateUIProc='MyRepresentation', proc='MyPreCreateProcedure', type='MyAssembly')
#Set the post-create UI procedure for a representation type, for the
#default assembly type.
#
cmds.assembly(edit=True, repPostCreateUIProc='MyRepresentation', proc='MyPostCreateProcedure' )