カスタムフィルタとは

Softimage ではフィルタを使用して、特定タイプのオブジェクトに焦点を絞り込むことができます。たとえば、Softimage に付属している Polygon Mesh フィルタでは、ポリゴンメッシュのみが抽出され、それ以外のものはすべて除去(除外)されます。 3D ビューでは、フィルタを使って選択ツールの動作を変更し、目的のオブジェクトのみ(たとえば、ヌル、コントロールオブジェクト、およびサーフェイスメッシュを除く、ポリゴンメッシュのみ)を容易に選択できます。 Explorer では、フィルタを使って、エレメントツリーから不要ノードを除去できます。

カスタムフィルタは、Match コールバックを実行する自己インストールするプラグインです。 Match コールバックのジョブは、オブジェクトを除外すべきかどうかを決定することです。たとえば、3D オブジェクトフィルタの実装例は、次のとおりです。

// [JScript]
//------------------------------------------------------------------
// Install callback for the plug-in
//------------------------------------------------------------------
function XSILoadPlugin( oPluginRegistrar )
{
	// Give the plug-in a name
	oPluginRegistrar.Name = "MyFilters";

	// Register a filter named "MyFilter" for 3D objects
	oPluginRegistrar.RegisterFilter( "MyFilter", siFilter3DObject );

}

//------------------------------------------------------------------
// Match callback for the filter registered under the name "MyFilter"
//------------------------------------------------------------------
function MyFilter_Match( oContext )
{
	// Get the object from the Input attribute of the Context object
	var o3DObject = oContext.GetAttribute( "Input" );

	// Check if the object matches the filter conditions
	var bMatch = isa_match( o3DObject );

	// Return true to keep the object, false to filter the object out
	return ( bMatch );
}

[選択]パネル

Softimage のカスタムフィルタは、メインコマンドエリアの[Select]パネルにある選択フィルタのリストに表示されます。ユーザがカスタムフィルタをアクティブ化し終えると、3D ビュー(またはオブジェクトビューやスケマティックビュー)内でユーザが選択しようとしたどのオブジェクトに対しても、Match コールバックが呼び出されます。 Match が true を返した場合は、そのオブジェクトが選択されます。

Explorer(XSI ExplorerやSDK Explorer)などのビューでは、カスタムフィルタが表示される検索ボックスに、[フィルタ]ドロップダウンリストがあります。ユーザがフィルタを選択すると、Explorer 内のノードごとに Match が呼び出され、フィルタ条件に適合しないノードが除去されます。また、カスタムフィルタは Subset をコールバックしてオブジェクトをまとめて処理することができるため、Softimage ではコールバックを 1 つ起動するだけでフィルタを適用できます。

カスタムフィルタをコマンドおよびオブジェクトモデルと併用できます。たとえば、次のように SIFilter コマンドを使ったカスタムフィルタで、選択されたオブジェクトをフィルタリングすることができます。

var cloFilteredList = SIFilter( Application.Selection, "MyFilter" );

Softimage オブジェクトモデルでは、カスタムフィルタが Filters コレクションに取り込まれます。

var oFilter = Application.Filters.Item("MyFilter");

for ( var enumerator = new Enumerator( Application.Selection ) ; !enumerator.atEnd(); enumerator.moveNext() )
{
	var o3DObject = enumerator.item();
	if ( oFilter.Match( o3DObject ) )
	{
		doSomething( o3DObject );
	}
}

上の例で注意すべき点は、3D オブジェクト(たとえば、X3DObject)が Context オブジェクトではなく Match メソッドに渡されることです。 3D オブジェクトを Context オブジェクトにマーシャリングする処理は、Match コールバックが要求し、Softimage で代行されます。

また、Softimage SDK のインストールフォルダにある examples フォルダのライトフィルタおよびシンプルなフィルタのサンプルを参照することもできます。

カスタム フィルタとは

カスタムフィルタとは