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

概要

addMetadata([channelName=string], [channelType=string], [indexType=string], [scene=boolean], [streamName=string], [structure=string])

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

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

1 つまたは複数の選択したオブジェクトに対するメタデータ ストラクチャのアタッチメントを定義します。これにより、後で editMetadata コマンドを使用して設定するプレースホルダと空のメタデータ ストリームが作成されます。これは、ノードにおける addAttr コマンド(データ説明が追加されるが、データは実際に設定されない)と同様の概念です。

メタデータ ストラクチャを割り当てるときは、次のフラグを指定する必要があります。channelName はメタデータのチャネル タイプ(「vertex」など)、streamName は作成するメタデータ ストリームの名前、structure はメタデータの内容を定義するストラクチャ タイプの名前です。indexType フラグはオプションです。このフラグを指定しない場合、インデックスは標準の数値と推測されます。

メタデータの情報は、さまざまなレベルで照会できます。照会可能なすべての引数の一覧については以下の表を参照してください。それぞれの場合において、非照会引数のいずれかを指定すると、照会中に調べるメタデータの一覧がフィルタされます。すべての照会で、照会する単一のオブジェクトを選択する必要があります。

たとえば、他の引数を指定せずに channelName フラグを照会すると、メタデータを含む選択されたオブジェクトのすべてのチャネル タイプの一覧が返されます。indexType フラグを指定して channelName フラグを照会すると、その特定のタイプのインデックスを使用するメタデータ ストリームを含むチャネル タイプのみ返されます。

フラグの組み合わせ:

ChannelName ndexType StreamName Structure   Create   Can Query
     0          0          0         0         X        ChannelName, StreamName, Structure
     0          0          0         1         X        ChannelName, StreamName, IndexType
     0          0          1         0         X        ChannelName, Structure, IndexType
     0          0          1         1         X        ChannelName, IndexType
     0          1          0         0         X        ChannelName, StreamName, Structure
     0          1          0         1         X        ChannelName, StreamName
     0          1          1         0         X        ChannelName, Structure
     0          1          1         1         X        ChannelName
     1          0          0         0         X        StreamName, Structure, IndexType
     1          0          0         1         X        StreamName, IndexType
     1          0          1         0         X        Structure, IndexType
     1          0          1         1        (a)       IndexType
     1          1          0         0         X        StreamName, Structure
     1          1          0         1         X        StreamName
     1          1          1         0         X        Structure
     1          1          1         1        (b)       X
    (a) 既定のインデックス タイプの空のメタデータ ストリームを割り当てる
    (b) 指定したインデックス タイプの空のメタデータ ストリームを割り当てる

戻り値

string[]新しいストリームが正常に追加されたノードの一覧(作成モード)
string[]channelName フラグを照会する場合のオブジェクトに関するメタデータを含むチャネル タイプの一覧
string[]streamName フラグを照会する場合のオブジェクト上のストリーム名の一覧
string[]structure フラグを照会する場合にオブジェクトのメタデータ ストリームで使用されるストラクチャの一覧
string[]indexType フラグを照会する場合にオブジェクトで使用されるインデックス タイプの一覧

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

キーワード

metadata, component, stream, channel, association

関連

applyMetadata, dataStructure, editMetadata, getMetadata

フラグ

channelName, channelType, indexType, scene, streamName, structure
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
channelName(cn) string createquery
ストラクチャが追加されるチャネルのチャネル タイプの名前(「vertex」など)。

照会モードでは、このフラグは値を受け入れることができます。

channelType(cht) string createquery
現在サポートしていません: 代わりに 'channelName' フラグを使用してください。

照会モードでは、このフラグは値を受け入れることができます。

indexType(idt) string createquery
新しいチャネルが使用するインデックス タイプの名前。指定しない場合、既定で単純な数値インデックスに設定されます。ネイティブ タイプの中で、メッシュの「vertexFace」チャネルのみ異なり、「pair」インデックス タイプを使用します。

照会モードでは、このフラグは値を受け入れることができます。

scene(scn) boolean createquery
個々のノードにではなくシーン全体にメタデータを追加したい場合は、このフラグを使用します。このフラグを使用してノードを選択すると、ノードは無視され、警告が表示されます。
streamName(stn) string createquery
作成する空のストリームの名前。値を指定しない照会モードでは、名前を指定したチャネル タイプのストリームのリストが返されます。

照会モードでは、このフラグは値を受け入れることができます。

structure(str) string createquery
オブジェクトにアタッチするメタデータを定義するストラクチャの名前。照会モードでは、指定したストリームでアタッチされたストラクチャの名前が返されます。

照会モードでは、このフラグは値を受け入れることができます。


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

Python 例

import maya.cmds as cmds

import maya.cmds as cmds
cmds.polyPlane( name='p', ch=False )
cmds.select( 'pShape', replace=True )
cmds.dataStructure( format='raw', asString='name=IdStruct:int32=ID' )
cmds.dataStructure( format='raw', asString='name=OffStruct:float=Offset' )
cmds.dataStructure( format='raw', asString='name=OrgStruct:float[3]=Origin Point' )
# Add three metadata streams
cmds.addMetadata( streamName='IdStream', channelName='vertex', structure='IdStruct' )
cmds.addMetadata( streamName='OffStream', channelName='vertex', structure='OffStruct' )
cmds.addMetadata( streamName='OrgStream', channelName='edge', structure='OrgStruct' )
cmds.addMetadata( streamName='VFStream', channelName='vertexFace', indexType='pair', structure='OrgStruct' )
# Query for the list of all channel types possessing metadata
cmds.addMetadata( query=True, channelName=True )
# Return: ['edge', 'vertex', 'vertexFace'] #
# Query for the structure assigned to a specific stream
cmds.addMetadata( channelName='vertex', streamName='OffStream', query=True, structure=True )
# Return: 'OffStruct' #
# Query for the list of all streams on a specific channel type
cmds.addMetadata( channelName='vertex', query=True, streamName=True )
# Return: ['IdStream', 'OffStream'] #
# Query for the list of all streams
cmds.addMetadata( query=True, streamName=True )
# Return: ['IdStream', 'OffStream', 'OrgStream', 'VFStream'] #
# You can combine queries to answer more general questions about the
# metadata on an object. For example suppose you wanted to know the
# index type used by all Streams on the 'vertex' Channel.
# First extract the list of Streams on the Channel
streams = cmds.addMetadata( channelName='vertex', query=True, streamName=True )
# Loop through each Stream, querying the IndexType only for that Stream
for stream in streams:
	indexType = cmds.addMetadata( channelName='vertex', streamName=stream, query=True, indexType=True )[0]
	print 'Index type on %s is %s' % (stream, indexType)