プラグイン関数

 プラグイン(DLL)側で提供する必要がある関数です。関数内でプラグイン固有の機能を記述します。

○:必須 △:任意 ×:不要


void MQGetPlugInID(DWORD *Product, DWORD *ID);

Product
プロダクト名(制作者名)をセットすべきポインタ
ID
プロダクトIDをセットすべきポインタ

プロダクト名(制作者名)とIDを、全部で64bitの値として返します。

ProductおよびIDの値は他と重複しないような適当にランダムなもので構いません。

この関数は起動時に呼び出されます。

Create Export Import Object Select Station Command

const char *MQGetPlugInName(void);

戻り値
プラグイン名

[プラグインについて]ダイアログ上で表示するプラグイン名を返します。

この関数はダイアログ表示時に呼び出されます。

Create Export Import Object Select Station Command

int MQGetPlugInType(void);

戻り値
プラグインタイプ
[MQPLUGIN_TYPE_IMPORT] ファイル入力用
[MQPLUGIN_TYPE_EXPORT] ファイル出力用
[MQPLUGIN_TYPE_CREATE] オブジェクト作成用
[MQPLUGIN_TYPE_OBJECT] オブジェクト変形用
[MQPLUGIN_TYPE_SELECT] 選択部変形用
[MQPLUGIN_TYPE_STATION] 常駐型 (new in Rev2.40)
[MQPLUGIN_TYPE_COMMAND] コマンド (new in Rev2.41)

プラグインのタイプを返します。

この関数は起動時に呼び出されます。

Create Export Import Object Select Station Command

const char *MQEnumFileType(int index);

index
ファイルの種類のインデックス
戻り値
ファイルの形式名

ファイルの形式名を返します。返した形式名はファイルダイアログ上のコンボボックスに表示されます。

この関数は起動時に呼び出されます。indexは0から順に呼び出されるごとに増えていき、戻り値としてNULLを返したときに呼び出しが終了します。

Create Export Import Object Select Station Command
× × × × ×

const char *MQEnumFileExt(int index);

index
ファイルの種類のインデックス
戻り値
拡張子

ファイルの拡張子を返します。返した拡張子はファイルダイアログ上で扱われます。

この関数は起動時に呼び出されます。indexは0から順に呼び出されるごとに増えていき、戻り値としてNULLを返したときに呼び出しが終了します。

Create Export Import Object Select Station Command
× × × × ×

BOOL MQImportFile(int index, const char *filename, MQDocument doc);

BOOL MQImportFileW(int index, const wchar_t *filename, MQDocument doc);

index
ファイルの種類のインデックス
filename
ファイル名(フルパス)
doc
ドキュメントクラス
戻り値
ファイル入力の成功の可否
[TRUE] 入力に成功
[FALSE] 入力に失敗

ファイルからデータを読み込んでドキュメントにオブジェクトを追加します。

ファイルが正常に読み込めない、不明なフォーマット、有効なオブジェクトが存在しない、などの場合はFALSEを返すようにしてください。

char型のfilenameのエンコードはWindowsではANSI、Macではutf-8となります。

(in Rev4.70)

wchar_t型を扱うMQImportFileW()が追加されました。MQImportFileW()の利用が推奨されますが、MQImportFile()も互換性のために維持されます。

Create Export Import Object Select Station Command
× × × × × ×

BOOL MQExportFile(int index, const char *filename, MQDocument doc);

BOOL MQExportFileW(int index, const wchar_t *filename, MQDocument doc);

index
ファイルの種類のインデックス
filename
ファイル名(フルパス)
doc
ドキュメントクラス
戻り値
ファイル出力の成功の可否
[TRUE] 出力に成功
[FALSE] 出力に失敗

ドキュメントに登録されているオブジェクトをファイルへ書き込みます。

何らかの理由で書き込みに失敗した場合はFALSEを返すようにしてください。

char型のfilenameのエンコードはWindowsではANSI、Macではutf-8となります。

(in Rev4.70)

wchar_t型を扱うMQExportFileW()が追加されました。MQExportFileW()の利用が推奨されますが、MQExportFile()も互換性のために維持されます。

Create Export Import Object Select Station Command
× × × × × ×

const char *MQEnumString(int index);

const wchar_t *MQEnumStringW(int index);

index
種類のインデックス
戻り値
文字列

プラグインに応じた特定の目的の文字列を返します。

Create/Object/Select/Stationプラグインの場合は、メニュー上に表示される文字列となります。Commandプラグインの場合はボタンに表記される文字列となります。

(in Rev4.70)

wchar_t型を扱うMQEnumStringW()が追加されました。MQEnumStringW()の利用が推奨されますが、MQEnumString()も互換性のために維持されます。

Create Export Import Object Select Station Command
× ×

BOOL MQCreate(int index, MQDocument doc);

index
種類のインデックス
doc
ドキュメントクラス
戻り値
オブジェクト作成の成功の可否
[TRUE] 作成に成功
[FALSE] 作成に失敗

オブジェクトを作成してドキュメントに登録します。

Create Export Import Object Select Station Command
× × × × × ×

BOOL MQModifyObject(int index, MQDocument doc);

index
種類のインデックス
doc
ドキュメントクラス
戻り値
オブジェクト変形の成功の可否
[TRUE] 成功
[FALSE] 失敗

カレントオブジェクトに変形操作を行います。

Create Export Import Object Select Station Command
× × × × × ×

BOOL MQModifySelect(int index, MQDocument doc);

index
種類のインデックス
doc
ドキュメントクラス
戻り値
選択部変形の成功の可否
[TRUE] 成功
[FALSE] 失敗

選択された頂点・辺・面に変形操作を行います。

Create Export Import Object Select Station Command
× × × × × ×

BOOL MQOnEvent(MQDocument doc, int event_type, void *option);

doc
ドキュメントクラス
event_type
イベントの種類
[MQEVENT_INITIALIZE] プラグインの初期化
[MQEVENT_EXIT] プラグインの終了
[MQEVENT_ACTIVATE] 表示・非表示切り替え要求
[MQEVENT_IS_ACTIVATED] 表示・非表示状態の返答
[MQEVENT_MINIMIZE] メインウインドウの最小化への応答
[MQEVENT_DRAW] 描画時の処理
[MQEVENT_NEW_DOCUMENT] ドキュメントの初期化時
[MQEVENT_END_DOCUMENT] ドキュメントの終了時
[MQEVENT_SAVE_DOCUMENT] ドキュメントの保存時
[MQEVENT_UNDO] アンドゥ実行時
[MQEVENT_REDO] リドゥ実行時
[MQEVENT_UNDO_UPDATED] アンドゥ状態更新時
[MQEVENT_OBJECT_MODIFIED] オブジェクトの編集時
[MQEVENT_OBJECT_SELECTED] オブジェクトの選択状態の変更時
[MQEVENT_OBJECT_LIST] カレントオブジェクトの変更時
[MQEVENT_MATERIAL_MODIFIED] マテリアルのパラメータ変更時
[MQEVENT_MATERIAL_LIST] カレントマテリアルの変更時
[MQEVENT_SCENE] シーン情報の変更時
option
オプション情報
戻り値
イベントの処理を適切に行ったかどうか

(new in Rev2.40)

本体側で何らかの処理が行われたときに呼び出されます。常駐型・コマンドプラグインはイベントを適切に処理する必要があります。

Create Export Import Object Select Station Command
× × × × ×