PluginRegistrar.RegisterConverterEvent

コンバータイベントを登録します。イベントのコールバックは、カスタム定義のファイルタイプを使用したファイルが読み込みまたは書き出しされる必要があるときに起動します。

C#構文

PluginItem PluginRegistrar.RegisterConverterEvent( String in_eventName, siEventID in_eventID, String in_eventExtension );

スクリプト構文

oReturn = PluginRegistrar.RegisterConverterEvent( Name, Type, Extension );

戻り値

パラメータ

パラメータタイプ説明

Name String 登録するカスタムのコンバータイベントの名前。文字から開始し、英数字とアンダースコア(_)記号のみを使用する必要があります。

コンバータイベント名にスペースが含まれている場合（"My Converter"など）は、コールバック関数名ではスペースを削除する必要があります（"MyConverter_Init"など）。

Softimage では、登録イベントに関連付けるハンドラ関数を{event name}_OnEvent の書式で表します。

Type siEventID 登録するイベントのタイプ

注：siOnCustomFileImportおよび SiOnCustomFileExport の識別子がサポートされています。

Extension String コンバータイベントを登録するファイルの拡張子。拡張子には区切り文字を含むことはできません。また、大文字である必要があります。たとえば、"myfile.txt"というファイルの場合は"TXT"となります。

例

パラメータ	タイプ	説明
Name	String	登録するカスタムのコンバータイベントの名前。文字から開始し、英数字とアンダースコア(_)記号のみを使用する必要があります。コンバータイベント名にスペースが含まれている場合（"My Converter"など）は、コールバック関数名ではスペースを削除する必要があります（"MyConverter_Init"など）。 Softimage では、登録イベントに関連付けるハンドラ関数を{event name}_OnEvent の書式で表します。
Type	siEventID	登録するイベントのタイプ注：siOnCustomFileImportおよび SiOnCustomFileExport の識別子がサポートされています。
Extension	String	コンバータイベントを登録するファイルの拡張子。拡張子には区切り文字を含むことはできません。また、大文字である必要があります。たとえば、"myfile.txt"というファイルの場合は"TXT"となります。

JScript の例

function XSILoadPlugin( in_reg )

{

	in_reg.Author = "ABC" ;

	in_reg.Name = "ABC Text Converter plugin" ;

	in_reg.Major = 1;

	in_reg.Minor = 0;

	in_reg.URL = "www.abc.com"

	// Let Softimage know that this plugin implements a custom import and export event for txt files

	in_reg.RegisterConverterEvent("ABCTextImport",siOnCustomFileImport,"TXT");

	in_reg.RegisterConverterEvent("ABCTextExport",siOnCustomFileExport,"TXT");

	return true ;

}