mqsdx 310.0.1 MQPluginSDK Extention Library / mqsdkをC++またはCLI(.Net)拡張するサポートライブラリ

- メインページ
- 関連ページ
- モジュール
- クラス
- ファイル

全て クラス 関数 変数 型定義 プロパティ グループ ページ
モジュール | 構成
MQ0xの一覧

## モジュール
| MQ0x-Math名前空間
| MQ0x-Polygon名前空間

## 構成
struct | MQ0x::CollectionHashCode< T_OUT, default_seed >
| 組込型配列からハッシュコードを生成するクラス [詳細]
struct | MQ0x::HSV< T >
| HSV色構造体 [詳細]
class | MQ0x::PluginBase< T_MQPLUGIN >
| MQBasePluginを継承したクラスに、基本的な拡張を行うテンプレートラッパークラス [詳細]
struct | MQ0x::SettingProxy
| MQSetting代行クラス [詳細]

## グローバル
static const std::vector< char > ::size_type | MQ0x::GetNameInitialBufferSize = 32
| 各種の名前取得関数において、可変長バッファサイズの最低初期値のデフォルトを定義。
bool | MQ0x::DeleteMaterial (const MQDocument doc, const MQMaterial mat)
| ドキュメントからマテリアルを削除。 [詳細]
bool | MQ0x::DeleteObject (const MQDocument doc, const MQObject obj)
| ドキュメントからオブジェクトを削除。 [詳細]
std::string | MQ0x::GetCountUpCloneableUniqueName (const MQDocument doc, const MQMaterial src, std::vector< char > *const buf=NULL)
| マテリアルクローンのための、カウントアップされた重複しない別名候補を取得 [詳細]
std::string | MQ0x::GetCountUpCloneableUniqueName (const MQDocument doc, const MQObject src, std::vector< char > *const buf=NULL)
| オブジェクトクローンのための、カウントアップされた重複しない別名候補を取得 [詳細]
MQMaterial | MQ0x::GetMaterial (const MQDocument doc, const char *name)
| ドキュメントに登録されているマテリアルを名前で検索する [詳細]
MQMaterial | MQ0x::GetMaterial (const MQDocument doc, const UINT id)
| ドキュメントに登録されているマテリアルをユニークIDで検索する [詳細]
std::string | MQ0x::GetMaterialAlphaName (const MQMaterial mat)
| 透明テクスチャのファイルパスを取得する。 GetMaterialTextureName() の map_type に MQMAPPING_ALPHA を指定するのと同じです。
std::string | MQ0x::GetMaterialBumpName (const MQMaterial mat)
| 凸凹テクスチャのファイルパスを取得する。 GetMaterialTextureName() の map_type に MQMAPPING_BUMP を指定するのと同じです。
int | MQ0x::GetMaterialIndex (const MQDocument doc, const char *name)
| ドキュメントに登録されているマテリアルを名前で検索する。 [詳細]
int | MQ0x::GetMaterialIndex (const MQDocument doc, const UINT id)
| ドキュメントに登録されているマテリアルをユニークIDで検索する。 [詳細]
std::string | MQ0x::GetMaterialTextureName (const MQMaterial mat, const DWORD map_type=MQMAPPING_TEXTURE)
| テクスチャのファイルパスを取得する。 [詳細]
std::string | MQ0x::GetName (const MQMaterial mat)
| マテリアルの名前を取得する。 [詳細]
std::string | MQ0x::GetName (const MQObject obj)
| オブジェクトの名前を取得する [詳細]
MQObject | MQ0x::GetObject (const MQDocument doc, const char *name)
| ドキュメントに登録されているオブジェクトを名前で検索する [詳細]
MQObject | MQ0x::GetObject (const MQDocument doc, const UINT id)
| ドキュメントに登録されているオブジェクトをユニークIDで検索する [詳細]
int | MQ0x::GetObjectIndex (const MQDocument doc, const char *name)
| ドキュメントに登録されているオブジェクトを名前で検索する [詳細]
int | MQ0x::GetObjectIndex (const MQDocument doc, const UINT id)
| ドキュメントに登録されているオブジェクトをユニークIDで検索する。 [詳細]
std::string | MQ0x::GetUnusedMaterialName (const MQDocument doc, const char *base_name=NULL)
| ドキュメントに登録されていないマテリアル名を取得する（MQDocument::GetUnusedMaterialNameのラッパー関数）。 [詳細]
std::string | MQ0x::GetUnusedMaterialName (const MQDocument doc, const MQMaterial base_name_material)
| ドキュメントに登録されていないマテリアル名を取得する（MQDocument::GetUnusedMaterialNameのラッパー関数）。 [詳細]
std::string | MQ0x::GetUnusedObjectName (const MQDocument doc, const char *base_name=NULL)
| ドキュメントに登録されていないオブジェクト名を取得する（MQDocument::GetUnusedObjectNameのラッパー関数）。 [詳細]
std::string | MQ0x::GetUnusedObjectName (const MQDocument doc, const MQObject base_name_object)
| ドキュメントに登録されていないオブジェクト名を取得する（MQDocument::GetUnusedObjectNameのラッパー関数）。 [詳細]

## 説明

MQ0xの公開する機能の一覧です。

  - MQ0xの使い方

## 関数

bool MQ0x::DeleteMaterial | ( | const MQDocument | doc,
|  | const MQMaterial | mat
| ) |  |
| inline

ドキュメントからマテリアルを削除。

戻り値
  引数がNULLまたはユニークIDの一致するマテリアルが見つからない場合は削除を行わずfalseを返します。それ以外はtrue

bool MQ0x::DeleteObject | ( | const MQDocument | doc,
|  | const MQObject | obj
| ) |  |
| inline

ドキュメントからオブジェクトを削除。

戻り値
  引数がNULLまたはユニークIDの一致するオブジェクトが見つからない場合は削除を行わずfalseを返します。それ以外はtrue

std::string MQ0x::GetCountUpCloneableUniqueName | ( | const MQDocument | doc,
|  | const MQMaterial | src,
|  | std::vector< char > *const | buf = `NULL`
| ) |  |
| inline

マテリアルクローンのための、カウントアップされた重複しない別名候補を取得

戻り値
  少なくとも探査時点で重複しない別名候補文字列。引数にNULLが指定されるなどエラー時には空の文字列が返る。

別名候補の命名規則
  例）obj > obj1 | obj00 > obj01 | obj0.99 > obj0.100
  - 重複は回避される
  - 元の名前の末尾に数字が無い場合は'1'が付与される。
  - 元の名前の末尾に0-9の数字列がある場合は、+1される。ただし0-9以外、例えば小数点などは数値形式としては考慮されない。
  - クローン候補名の末尾数字の桁数は、元の名前の末尾の数字列と同じかそれよりも一桁増える。

注意
  MQSDK Rev3.10からMQDocument::GetUnusedMaterialName()が追加されました。この関数は下位互換、および今後のMQx独自仕様として残されます。

日付
  2013.02.04 MQSDK Rev3.10対応

参照元 MQ0x::GetCountUpCloneableUniqueName().

std::string MQ0x::GetCountUpCloneableUniqueName | ( | const MQDocument | doc,
|  | const MQObject | src,
|  | std::vector< char > *const | buf = `NULL`
| ) |  |
| inline

オブジェクトクローンのための、カウントアップされた重複しない別名候補を取得

戻り値
  少なくとも探査時点で重複しない別名候補文字列。引数にNULLが指定されるなどエラー時には空の文字列が返る。

別名候補の命名規則
  例）obj > obj1 | obj00 > obj01 | obj0.99 > obj0.100
  - 重複は回避される
  - 元の名前の末尾に数字が無い場合は'1'が付与される。
  - 元の名前の末尾に0-9の数字列がある場合は、+1される。ただし0-9以外、例えば小数点などは数値形式としては考慮されない。
  - クローン候補名の末尾数字の桁数は、元の名前の末尾の数字列と同じかそれよりも一桁増える。

注意
  MQSDK Rev3.10からMQDocument::GetUnuseObjectName()が追加されました。この関数は下位互換、および今後のMQx独自仕様として残されます。

日付
  2013.02.04 MQSDK Rev3.10対応

MQMaterial MQ0x::GetMaterial | ( | const MQDocument | doc,
|  | const char * | name
| ) |  |
| inline

ドキュメントに登録されているマテリアルを名前で検索する

戻り値
  見つかったマテリアル。見つからない場合はNULL。

MQMaterial MQ0x::GetMaterial | ( | const MQDocument | doc,
|  | const UINT | id
| ) |  |
| inline

ドキュメントに登録されているマテリアルをユニークIDで検索する

戻り値
  見つかったマテリアル。見つからない場合はNULL。

注意
  MQSDK Rev3.10からMQDocument::GetMaterialFromUniqueID()が追加されました。この関数は下位互換のために残されています。

日付
  2013.02.04 MQSDK Rev3.10対応

int MQ0x::GetMaterialIndex | ( | const MQDocument | doc,
|  | const char * | name
| ) |  |
| inline

ドキュメントに登録されているマテリアルを名前で検索する。

戻り値
  見つかったマテリアルのインデックス。見つからない場合は-1

int MQ0x::GetMaterialIndex | ( | const MQDocument | doc,
|  | const UINT | id
| ) |  |
| inline

ドキュメントに登録されているマテリアルをユニークIDで検索する。

戻り値
  見つかったマテリアルのインデックス。見つからない場合は-1

std::string MQ0x::GetMaterialTextureName | ( | const MQMaterial | mat,
|  | const DWORD | map_type = `MQMAPPING_TEXTURE`
| ) |  |
| inline

テクスチャのファイルパスを取得する。

引数

  map_type | 取得するテクスチャの種類を指定する MQMAPPING_TEXTURE / MQMaterial::GetTextureName()を呼び出して模様画像パスを取得する MQMAPPING_ALPHA / MQMaterial::GetAlphaName()を呼び出して透明画像パスを取得する MQMAPPING_BUMP / MQMaterial::GetBumpName()を呼び出して凸凹画像パスを取得する

戻り値
  マッピングのファイル名を相対パスで取得します（元々絶対パスで指定されている場合は絶対パスが返るそうです）。元々画像が設定されていない、あるいはmatにNULLを指定するなどなんらかの失敗時には、空の文字列が返ります。

得られたファイル名を絶対パスに変換するにはMQDocument::FindMappingFile()を使用します。

参照元 MQ0x::GetMaterialAlphaName(), と MQ0x::GetMaterialBumpName().

std::string MQ0x::GetName | ( | const MQMaterial | mat) |  |
| inline

マテリアルの名前を取得する。

戻り値
  マテリアルの名前。引数にNULLが指定されるなど、エラー時には空の文字列。

参照元 MQ0x::GetName(), MQ0x::GetUnusedMaterialName(), と MQ0x::GetUnusedObjectName().

std::string MQ0x::GetName | ( | const MQObject | obj) |  |
| inline

オブジェクトの名前を取得する

戻り値
  オブジェクトの名前。引数にNULLが指定されるなど、エラー時には空の文字列。

MQObject MQ0x::GetObject | ( | const MQDocument | doc,
|  | const char * | name
| ) |  |
| inline

ドキュメントに登録されているオブジェクトを名前で検索する

戻り値
  見つかったオブジェクト。見つからない場合はNULL。

MQObject MQ0x::GetObject | ( | const MQDocument | doc,
|  | const UINT | id
| ) |  |
| inline

ドキュメントに登録されているオブジェクトをユニークIDで検索する

戻り値
  見つかったオブジェクト。見つからない場合はNULL。

注意
  MQSDK Rev3.10からMQDocument::GetObjectFromUniqueID()が追加されました。この関数は下位互換のために残されています。

日付
  2013.02.04 MQSDK Rev3.10対応

int MQ0x::GetObjectIndex | ( | const MQDocument | doc,
|  | const char * | name
| ) |  |
| inline

ドキュメントに登録されているオブジェクトを名前で検索する

戻り値
  見つかったオブジェクトのインデックス。見つからない場合は-1

int MQ0x::GetObjectIndex | ( | const MQDocument | doc,
|  | const UINT | id
| ) |  |
| inline

ドキュメントに登録されているオブジェクトをユニークIDで検索する。

戻り値
  見つかったオブジェクトのインデックス。見つからない場合は-1

std::string MQ0x::GetUnusedMaterialName | ( | const MQDocument | doc,
|  | const char * | base_name = `NULL`
| ) |  |
| inline

ドキュメントに登録されていないマテリアル名を取得する（MQDocument::GetUnusedMaterialNameのラッパー関数）。

戻り値
  取得した文字列。docがNULLの時は空の文字列。

注意
  MQSDK Rev3.10 から利用可能

std::string MQ0x::GetUnusedMaterialName | ( | const MQDocument | doc,
|  | const MQMaterial | base_name_material
| ) |  |
| inline

ドキュメントに登録されていないマテリアル名を取得する（MQDocument::GetUnusedMaterialNameのラッパー関数）。

引数

  base_name_material | 元の名前を指定するマテリアル。NULLで省略するとbase_nameをNULLにしてMQDocument::GetUnusedMaterialNameを呼び出すのと同じ動作。

戻り値
  取得した文字列。docがNULLの時は空の文字列。

注意
  MQSDK Rev3.10 から利用可能

std::string MQ0x::GetUnusedObjectName | ( | const MQDocument | doc,
|  | const char * | base_name = `NULL`
| ) |  |
| inline

ドキュメントに登録されていないオブジェクト名を取得する（MQDocument::GetUnusedObjectNameのラッパー関数）。

戻り値
  取得した文字列。docがNULLの時は空の文字列。

注意
  MQSDK Rev3.10 から利用可能

std::string MQ0x::GetUnusedObjectName | ( | const MQDocument | doc,
|  | const MQObject | base_name_object
| ) |  |
| inline

ドキュメントに登録されていないオブジェクト名を取得する（MQDocument::GetUnusedObjectNameのラッパー関数）。

引数

  base_name_object | 元の名前を指定するマテリアル。NULLで省略するとbase_nameをNULLにしてMQDocument::GetUnusedObjectNameを呼び出すのと同じ動作。

戻り値
  取得した文字列。docがNULLの時は空の文字列。

注意
  MQSDK Rev3.10 から利用可能