dataStructure

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

概要

dataStructure([asFile=string], [asString=string], [format=string], [name=string], [remove=boolean], [removeAll=boolean])

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

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

ストラクチャの説明を取得し、使用可能なデータ ストラクチャのリストに追加して作成します。ストラクチャの定義は、asString フラグで指定するか、または asFile フラグによって参照されるファイル内に存在します。

remove フラグが name フラグとともに指定されている場合、データ ストラクチャは除去されます。これは、データ ストラクチャの作成、除去、照会に別々のコマンドを作成するのではなく、1 つのコマンドですべてのストラクチャの操作を維持するためです。removeAll フラグを使用すると、既存のすべてのメタデータ ストラクチャが除去されます。注意して使用してください。除去されたストラクチャは除去後もメタデータ ストリーム内で使用されている可能性がありますが、新しいストリームの作成には使用できなくなります。

作成モードと除去モードは両方とも、元に戻すことができません。

既存のストラクチャの(名前を含む)完全な複製の作成が、新しいストラクチャを実際に作成することなくサイレントに成功します。既存のストラクチャと同じ名前の重複しないストラクチャを新しく作成しようとすると、同じ名前の 2 つのストラクチャを区別する方法がないため、失敗します。

モードの照会は、作成したストラクチャと登録されているストラクチャ シリアライゼーション フォーマットの両方の情報を表示するように定義されています。シリアライゼーション フォーマットでは、ストラクチャの情報をテキスト(raw、XML、JSON など)として保持します。raw ストラクチャ タイプは組み込まれているため、何も指定しない場合は raw が前提となります。

フラグを使用しない一般的な照会では、現在存在するすべてのストラクチャの名前のリストが返されます。

format フラグを照会すると、登録されているすべてのストラクチャ シリアライゼーション フォーマットのリストが返されます。

query フラグの前に format を指定して照会すると、その特定のストラクチャ シリアライゼーション フォーマットの詳細な説明が表示されます。

query フラグの前にストラクチャ名とシリアライゼーション フォーマットとともに asString フラグを照会すると、名前を指定したデータ ストラクチャを表す文字列が format フラグで指定されたシリアライゼーション フォーマットで返されます。フォーマットがストラクチャを作成したフォーマットと同じであっても、照会で返される文字列は同一でないことがあります。照会された値が標準的な方法でフォーマットされていて、元のフォーマットが保持されていないためです。

query フラグの前にストラクチャ名を指定して asFile フラグを照会すると、ストラクチャが生成された元のファイルが返されます。asString フラグまたは API を使用してストラクチャが作成された場合、空の文字列が返されます。

name フラグを照会すると、これまでに作成されたすべてのストラクチャのリストが返されます。

戻り値

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

キーワード

関連

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
name(n)	string
照会モード専用です。使用可能な名前を表示するために照会または設定するデータ ストラクチャの名前 照会モードでは、このフラグは値を受け入れることができます。
format(fmt)	string
ストラクチャの説明に要求されるデータのフォーマット。「raw」がネイティブでサポートされ、フォーマット タイプが省略されている場合の前提となります。その他のフォーマットはプラグインを介して使用できます。照会モードでこのフラグを使用すると、使用可能なフォーマットを照会できます。 照会モードでは、このフラグは値を受け入れることができます。
removeAll(ral)	boolean
すべてのメタデータ ストラクチャを除去します。このフラグは、他のフラグと一緒に使用することはできません。
remove(rem)	boolean
指定した名前のデータ ストラクチャを除去します。存在しない場合はエラーとなります。
asString(asString)	string
ストラクチャを説明するシリアル化されたデータが含まれている文字列を指定します。データのフォーマットは「format」フラグで指定されます。
asFile(af)	string
ストラクチャを説明するシリアル化されたデータが含まれているファイルを指定します。データのフォーマットは「format」フラグで指定されます。

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

Python 例

import maya.cmds as cmds

import maya.cmds as cmds
cmds.dataStructure( query=True, format=True )
# Result: ['raw', 'debug'] #
cmds.dataStructure( format='raw', asString='name=NameAndID:string=name:int32=ID' )
# Result: 'NameAndID' #
# Note that this file doesn't exist, it's just an example of how to read
# from the file after you've created it. The file contents should look
# like this:
#		name=FileBasedStructure
#		string=fileInformation
cmds.dataStructure( asFile='someFile.raw' )
cmds.dataStructure( query=True )
# Result: ['NameAndID', 'FileBasedStructure'] #
cmds.dataStructure( name='NameAndID', format='raw', query=True, asString=True )
# Result: 'name=NameAndID:string=name:int32=ID' #
cmds.dataStructure( remove=True, name='NameAndID' )
# Result: 'NameAndID' #
cmds.dataStructure( query=True )
# Result: ['FileBasedStructure'] #
cmds.dataStructure( removeAll=True )
# Result: ['FileBasedStructure'] #