getMetadata

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

概要

getMetadata [-channelType string] [-endIndex int] [-index string] [-indexType string] [-memberName string] [-startIndex int] [-streamName string]

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

このコマンドを使用してノードからメタデータ要素の値を取得します。以下の 2 つの基本バリエーションがあります。

1. メッシュでコンポーネント単位のメタデータを取得
2. 任意のノードで一般的なメタデータを取得

2 つの方法の違いは、最初の方法がメッシュ コンポーネントに関するある特定の知識(つまり、リーガル インデックス値)を使用する点です。たとえば、14 のエッジを持つメッシュで、エッジ インデックス 15 に対応するメタデータを要求すると、そのようなメタデータが存在する場合でも警告が生成されます。一般的なメタデータの場合、または既知のコンポーネント タイプに関連付けられていないメッシュ メタデータの場合でも、そのような警告が生成されることはありません。これは、関連付けられたデータの境界が不明であるためです。

コンポーネント単位のメタデータにアクセスする一般的な方法は、取得対象のメタデータを持つコンポーネントをコマンド ライン上で選択または指定する方法です。コマンドの 1 回の呼び出しで許可されるコンポーネント タイプは 1 つです。

一般的な使用法では、特定のメタデータを channelType および metadataIndex/startMetadataIndex/endMetadataIndex フラグを使用して選択します。metadataIndex は多目的フラグのため、このフラグを使用して同じチャネルから複数の異なる要素を選択したり、setMetadataIndex/endMetadataIndex のペアを使用して取得するインデックス値の全体の範囲を指定することができます。

metadataIndex フラグは、どのタイプのインデックスでも機能します。既定では、単純な数値インデックスに設定されます。metadataIndexType フラグを指定すると、他のインデックス タイプ(「string」など)を使用できます。 コースの startMetadataIndex フラグと endMetadataIndex フラグは、単純な数値インデックス タイプでのみ機能します。

メッシュ上のメタデータは、「vertex」、「edge」、「face」、「vertexFace」のチャネル タイプが同じ名前のコンポーネントに直接接続している点で特殊です。これらのメタデータ チャネルは、channelType および metadataIndex/startMetadataIndex/endMetadataIndex フラグを使用せずに、コマンド ライン上で対応するコンポーネントを単に選択または指定することで、より簡単に設定することができます。たとえば、「myMesh.vtx[8:10]」は、channelType = vertex、および metadataIndex = 10, 8, 10 (多目的フラグとして)または setMetadataIndex = 8, endMetadataIndex=10 のいずれかに対応します。

1 回のコマンドで許可されるノード、コンポーネント タイプ、チャネル タイプ、値タイプはそれぞれ 1 つだけです。複数の構造体メンバの値を取得するにはコマンドを複数回コールする必要がありますが、この方法によってデータをシンプルに保つことができます。

データが返されると、インデックス順序でメンバ全体が一緒に表示されます。たとえば、3 つのコンポーネントで float[3] メタデータを取得する場合、9 つの値が次の順序で返されます。index[0]-float[0]、index[0]-float[1]、index[0]-float[2]、index[1]-float[0]、index[1]-float[1]、index[1]-float[2]、index[2]-float[0]、index[2]-float[1]、index[2]-float[2]。Python の実装では、float[3] 値はそれぞれ配列となるため、3 つの float[3] 配列が返されます。

戻り値

キーワード

関連

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
-channelType(-cht)	string
メタデータの取得元となるチャネル タイプを指定します。これは、コンポーネントではなくコマンド ラインでノードを選択または指定するという一般的な形式でこのコマンドを使用する場合のみ必要となります。チャネル タイプは、検証されるメタデータの関連付けを参照します。チャネルの名前はユーザが決定するため、文字列は通常任意のものになります。メッシュ コンポーネントの特定のケースでは、予約済みのチャネル名「vertex」、「face」、「edge」、「vertexFace」を使用して、同様の名前のコンポーネントでメタデータを検索します。
-memberName(-mn)	string
取得される構造体メンバの名前。メンバの名前は、「dataStructure」コマンドで渡された説明に基づいて、または、構造の作成に使用された API を介してその構造の定義で設定されます。
-index(-idx)	string
メタデータは、インデックス リストであるストリームに保存されます。メッシュ コンポーネントが選択されている場合、メタデータのインデックスは、選択されたコンポーネントのリストで暗黙的となります。ノードのみを選択した場合、このフラグを使用して、メタデータの取得元となるインデックスを指定できます。複数のインデックスが指定されている場合は、すべてのインデックスから値が取得されます。複数のインデックスを指定する別の方法については、startIndex/endIndex フラグを参照してください。 未使用のインデックス状態は構造で定義されるため(既定値を割り当てるか割り当てなしとして扱う)、使用されているすべてのインデックスを指定する必要はありません。そのため、インデックス 0、1、2 に既に値があるかどうかに関係なく、インデックス 3 から値を取得することができます。
-indexType(-idt)	string
通常、メタデータは単純な数値を使用してインデックス化されます。特定のタイプのデータでは、他のインデックス タイプを使用する場合があります。たとえば、「頂点フェース」コンポーネントでは、「pair」インデックス タイプを使用します。このインデックス タイプは、コンポーネントのフェース ID を表す数値と頂点 ID を表す数値の 2 つの数値を表します。 index フラグは文字列で、指定された indexType に必要な形式にフォーマットされます。index フラグを使用する場合 indexType はすべて同じになります。タイプが指定されていない場合は、単純な数値と見なされます。
-startIndex(-six)	int
メタデータは、インデックス リストであるストリームに保存されます。メッシュ コンポーネントが選択されている場合、メタデータのインデックスは、選択されたコンポーネントのリストで暗黙的となります。ノードのみを選択した場合、このフラグを endMetadataIndex フラグと組み合わせて使用することで、メタデータの取得元となるインデックスの範囲を指定できます。startIndex の値が endIndex の値よりも大きくなるとエラーが発生します。複数のインデックスを指定する別の方法については、index フラグを参照してください。 未使用のインデックス状態は構造で定義されるため(既定値を割り当てるか割り当てなしとして扱う)、使用されているすべてのインデックスを指定する必要はありません。そのため、インデックス 0、1、2 に既に値があるかどうかに関係なく、インデックス 3 から値を取得することができます。
-endIndex(-eix)	int
メタデータは、インデックス リストであるストリームに保存されます。メッシュ コンポーネントが選択されている場合、メタデータのインデックスは、選択されたコンポーネントのリストで暗黙的となります。ノードのみを選択した場合、このフラグを tartIndex フラグと組み合わせて使用することで、メタデータの取得元となるインデックスの範囲を指定できます。startIndex の値が endIndex の値よりも大きくなるとエラーが発生します。複数のインデックスを指定する別の方法については、index フラグを参照してください。 未使用のインデックス状態は構造で定義されるため(既定値を割り当てるか割り当てなしとして扱う)、使用されているすべてのインデックスを指定する必要はありません。そのため、インデックス 0、1、2 に既に値があるかどうかに関係なく、インデックス 3 から値を取得することができます。
-streamName(-stn)	string
取得されているメタデータ ストリームの名前。ストリームは、このコマンドの使用時に既に作成済みである必要があります。ストリームの作成方法については、「addMetadata」コマンド、「applyMetadata」コマンド、またはメタデータ API を参照してください。

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

MEL 例

polyPlane -n smcPlane -ch off;
// Result: smcPlane //
// Create structures
dataStructure -format "raw" -asString "name=idStructure:int32=ID";
dataStructure -format "raw" -asString "name=keyValueStructure:string=value";
// Result: idStructure //
// Apply structures to plane
addMetadata -structure "idStructure" -streamName "idStream" -channelType "vertex";
addMetadata -structure "keyValueStructure" -streamName "keyValueStream" -channelType "key" -indexType "string";
// Get the metadata values from three of the components by selection
select -r smcPlaneShape.vtx[8:10];
getMetadata -streamName "idStream" -memberName "ID" -value 7;
// Result: 1 //
// Retrieve the three newly set metadata values
select -r smcPlaneShape;
getMetadata -streamName "idStream" -memberName "ID" -channelType "vertex" -index "8" -index "9" -index "10";
// Result: 7 7 7 //
// Get metadata from a larger group of indices all at once.
// Note that unassigned metadata values assume the default (0 for numbers).
select -r smcPlaneShape.vtx[7:11];
getMetadata -streamName "idStream" -memberName "ID";
// Result: 0 7 7 7 0 //
// Set metadata values using the complex index type "string"
editMetadata -streamName "keyValueStream" -memberName "value" -stringValue "Starry Night" -metadataIndex "Title";
editMetadata -streamName "keyValueStream" -memberName "value" -stringValue "Vincent Van Gogh" -metadataIndex "Artist";
// Retrieve the complex index data
getMetadata -streamName "keyValueStream" -memberName "value" -channelType "key" -index "Title" -index "Artist" -indexType "string";
// Result: "Starry Night" "Vincent Van Gogh" //