ProjectItem.TaggedParameters

導入

v4.0

詳細

指定されたタグでタグ付けされたすべてのパラメータを含むParameterオブジェクトのコレクションを戻します。この関数は、ローカルパラメータを戻すこともネストされたパラメータを戻すこともできます。

タグ付けは、パラメータのコレクションを設定する上で役立ちます。タグは不変ですので、分からなくなることはありません。このメソッドを使用すると、パラメータのセットを取得してコマンドに渡すことができます。

注:このメソッドは、オブジェクトおよびその子オブジェクトのタグを付けたパラメータをすべて戻すため、シーンルートなどのモデルでは注意深く使用してください。

C#構文

ParameterCollection ProjectItem.TaggedParameters( siTags, Boolean );

スクリプト構文

oReturn = ProjectItem.TaggedParameters( [Tag], [Local] );

戻り値

ParameterCollection

パラメータ

パラメータ タイプ 説明
Tag siTags 検索するタグ。複数のタグを組み合わせることも可能です。パラメータが引数で指定されているタグのうちのいずれか1 つでもサポートしていれば、戻されるリストに追加されます。

デフォルト値: siTagAll

Local Boolean 確認するタグが、オブジェクトに対してローカルかどうかを指定します。True の場合、継承プロパティや中間ノードから取得されるタグを付けたパラメータは無視されます(参照されるパラメータ)。中間ノードはオブジェクトの下にネストされていますが、オブジェクト自体に所有されているとは限りません。 たとえば、Texture_Projection_Def プロパティの下にネストされているカメラ オブジェクトは、ターゲット オブジェクトがプロジェクション プロパティ自体でない限り、考慮されません。 引数が false(デフォルト)に設定されている場合は、すべてのパラメータが考慮されます。

デフォルト値: False

JScript の例

CreatePrim( "Cone", "MeshSurface" );

var oGeom = GetValue( "Cone.polymsh.geom" );

var oParam1 = oGeom.Parameters("subdivu");

var oParam2 = oGeom.Parameters("subdivv");

var oObj = GetValue( "Cone" );

// Set the Tags

oParam1.Tags = siTag2 + siTag6;

oParam2.Tags = siTag6;

// Get the parameters with siTag2 (subdivu)

Application.LogMessage( "tag2 parameters with local flag on:" )

var oList = oObj.TaggedParameters( siTag2, true );

// Nothing will be displayed because we checked only the cone object

for ( i=0; i<oList.Count; i++ )

{

	Application.LogMessage( oList.Item(i) );

}

// Get the parameters with siTag2 (subdivu)

Application.LogMessage( "tag2 parameters with local flag off:" )

var oList = oObj.TaggedParameters( siTag2, false );

for ( i=0; i<oList.Count; i++ )

{

	Application.LogMessage( oList.Item(i) );

}

// Now get the parameters with siTag6 (subdivu and subdivv)

Application.LogMessage( "tag6 parameters with local flag off:" )

var oList = oGeom.TaggedParameters( siTag6, false );

for ( i=0; i<oList.Count; i++ )

{

	Application.LogMessage( oList.Item(i) );

}

// Remove all tags

oParam1.Tags = siTagNone

oParam2.Tags = siTagNone

関連項目

Parameter.Tags Tag Untag