モジュール説明

このセクションでは、最小値および最大値、モードタイプ、現在のモード、名称など、キャラクタのプロパティに関する情報を取得する関数について説明します。

これらの関数は、通常、キャラクタのプロパティを制御するグラフィカルユーザインタフェースの構築に使用します。

プロパティのモード、モードタイプ、および値の詳細については、キャラクタプロパティを参照してください。

列挙
enum	HIKPropertyModeType { HIKPropertyNoMode = 0, HIKPropertyOffOn, HIKPropertyOffAutoUser, HIKPropertyAutoUser }
	キャラクタのプロパティに可能なモードタイプを一覧表示します。HIKGetPropertyInfoModeType() を参照してください。表示...

enum	HIKPropertyUnit { HIKPropertyNoUnit = 0, HIKPropertyPercent, HIKPropertySecond, HIKPropertyCentimeter, HIKPropertyDegree, HIKPropertyEnum, HIKPropertyReal }
	キャラクタのプロパティに可能なユニットのタイプを一覧表示します。HIKGetPropertyInfoUnit() を参照してください。表示...

enum	HIKPropertyValueType { HIKPropertyScalar = 0 }
	キャラクタのプロパティに可能な値のタイプを一覧表示します。HIKGetPropertyInfoValueType() を参照してください。表示...

関数
const char *	HIKGetPropertyEnumName (int pPropertyId, int pValue)
	列挙値 `pValue` をプロパティ `pPropertyId` について識別する、人間が解読可能な英語の文字列を取得します。表示...

int	HIKGetPropertyId (const char *pName)
	説明的な名前から、プロパティ `pName` の固有の ID を取得します。表示...

float	HIKGetPropertyInfoDefaultMax (int pPropertyId)
	プロパティ `pPropertyId` に許容される最大値を取得します。表示...

float	HIKGetPropertyInfoDefaultMin (int pPropertyId)
	プロパティ `pPropertyId` に許容される最小値を取得します。表示...

int	HIKGetPropertyInfoDefaultMode (int pPropertyId)
	プロパティ `pPropertyId` のデフォルトのモードを取得します。表示...

float	HIKGetPropertyInfoDefaultValue (int pPropertyId)
	プロパティ `pPropertyId` のデフォルト値を取得します。表示...

eHIKPropertyModeType	HIKGetPropertyInfoModeType (int pPropertyId)
	プロパティ `pPropertyId` のモードタイプを取得します。表示...

eHIKPropertyUnit	HIKGetPropertyInfoUnit (int pPropertyId)
	プロパティ `pPropertyId` のユニットのタイプを取得します。表示...

eHIKPropertyValueType	HIKGetPropertyInfoValueType (int pPropertyId)
	プロパティ `pPropertyId` の値のタイプを取得します。表示...

const char *	HIKGetPropertyModeName (int pPropertyId, int pMode)
	モード `pMode` をプロパティ `pPropertyId` について識別する、人間が解読可能な英語の文字列を取得します。表示...

const char *	HIKGetPropertyName (int pPropertyId)
	プロパティ `pPropertyId` を識別する、人間が解読可能な英語の文字列を取得します。表示...

int	HIKIsPropertyDescription (int pPropertyId)
	プロパティが説明であるかどうかを示します。表示...

列挙型のドキュメント

enum HIKPropertyModeType

キャラクタのプロパティに可能なモードタイプを一覧表示します。HIKGetPropertyInfoModeType() を参照してください。

可能なモードは次のとおりです。

Off: プロパティはオフです。
On: プロパティはオンです。
Auto: プロパティの値は HumanIK によって制御されています。
User: プロパティの値はユーザによって制御されています。

備考:: "Off (0), On (1)" のように列挙の説明の各モードに一覧表示される値は、モードが設定されるときに pMode パラメータ(HIKSetPropertyMode() 関数)に渡される値である必要があります。HIKSetPropertyMode() および HIKGetPropertyMode() を参照してください。

Enumerator
HIKPropertyNoMode	このモードタイプのプロパティは、常に On で、現在の値は常に HumanIK ソルバによって考慮されます。
HIKPropertyOffOn	このモードタイプのプロパティは、Off (0)または On (1)モードに設定できます。
HIKPropertyOffAutoUser	このモードタイプのプロパティは、Off (0)、Auto (1)、または User (2)モードのいずれかに設定できます。
HIKPropertyAutoUser	このモードタイプのプロパティは、Auto (0)または User (1)モードに設定できますが、無効にすることはできません。

enum HIKPropertyUnit

キャラクタのプロパティに可能なユニットのタイプを一覧表示します。HIKGetPropertyInfoUnit() を参照してください。

Enumerator
HIKPropertyNoUnit	このプロパティの値は使用できないことを示します。通常、モードタイプが HIKPropertyOffOn であるプロパティのみに使用し、プロパティが単純なオンとオフの切り替えであることを示します。
HIKPropertyPercent	このプロパティの値は、0.0～1.0 の範囲で表されます。
HIKPropertySecond	プロパティの値は、秒単位で保存されます。
HIKPropertyCentimeter	プロパティの値は、スカラー距離です。測定ユニットは、HIKCharacter のジオメトリのキャラクタライズに使用するユニットと同じである必要があります。このユニットは、この値タイプを持つすべてのプロパティのデフォルト値が、約 180 ユニットの高さのキャラクタのサイズに設定されているため、"センチメートル" とされています。
HIKPropertyDegree	プロパティの値は、度単位で保存されます。
HIKPropertyEnum	プロパティの値は整数で、その解釈はそのプロパティに固有の列挙で定義されます。詳細については、各プロパティの説明を参照してください。これらのプロパティの列挙値の設定および取得には、HIKSetPropertyMode() および HIKGetPropertyMode() 関数を使用します。
HIKPropertyReal	プロパティの値は任意の浮動小数値です。

enum HIKPropertyValueType

キャラクタのプロパティに可能な値のタイプを一覧表示します。HIKGetPropertyInfoValueType() を参照してください。

Enumerator
HIKPropertyScalar	プロパティはスカラーです。

関数のドキュメント

const char* HIKGetPropertyEnumName	(	int	pPropertyId,
		int	pValue
	)

列挙値 pValue をプロパティ pPropertyId について識別する、人間が解読可能な英語の文字列を取得します。

パラメータ:

pPropertyId	プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。このプロパティには、ユニットのタイプ HIKPropertyEnum が必要です。
pValue	名前を取得する列挙値を示す整数

戻り値:: 列挙値を識別する文字列

int HIKGetPropertyId ( const char * pName )

説明的な名前から、プロパティ pName の固有の ID を取得します。

パラメータ:

pName プロパティの固有の名前。HIKGetPropertyName() からそのプロパティについて返される文字列と一致している必要があります。

戻り値:: プロパティ ID。可能な値については、HIKProperty 列挙を参照してください。-1 は一致するプロパティが見つからなかったことを示します。

float HIKGetPropertyInfoDefaultMax ( int pPropertyId )

プロパティ pPropertyId に許容される最大値を取得します。

パラメータ:

pPropertyId プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。

戻り値:: プロパティの最大値

float HIKGetPropertyInfoDefaultMin ( int pPropertyId )

プロパティ pPropertyId に許容される最小値を取得します。

パラメータ:

pPropertyId プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。

戻り値:: プロパティの最小値

int HIKGetPropertyInfoDefaultMode ( int pPropertyId )

プロパティ pPropertyId のデフォルトのモードを取得します。

パラメータ:

pPropertyId プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。

戻り値:: プロパティのデフォルトのモードを示す整数。この整数の解釈はプロパティのモードタイプによって異なります。HIKPropertyModeType 列挙を参照してください。

float HIKGetPropertyInfoDefaultValue ( int pPropertyId )

プロパティ pPropertyId のデフォルト値を取得します。

パラメータ:

pPropertyId プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。

戻り値:: プロパティのデフォルト値

eHIKPropertyModeType HIKGetPropertyInfoModeType ( int pPropertyId )

プロパティ pPropertyId のモードタイプを取得します。

パラメータ:

pPropertyId プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。

戻り値:: プロパティに可能なモードタイプを示す列挙値。HIKPropertyModeType 列挙を可能な値については参照してください。

eHIKPropertyUnit HIKGetPropertyInfoUnit ( int pPropertyId )

プロパティ pPropertyId のユニットのタイプを取得します。

パラメータ:

pPropertyId プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。

戻り値:: プロパティのユニットのタイプを示す列挙値。可能な値については、HIKPropertyUnit 列挙を参照してください。

eHIKPropertyValueType HIKGetPropertyInfoValueType ( int pPropertyId )

プロパティ pPropertyId の値のタイプを取得します。

パラメータ:

pPropertyId プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。

戻り値:: プロパティの値のタイプを示す列挙値。可能な値については、HIKPropertyValueType 列挙を参照してください。

const char* HIKGetPropertyModeName	(	int	pPropertyId,
		int	pMode
	)

モード pMode をプロパティ pPropertyId について識別する、人間が解読可能な英語の文字列を取得します。

パラメータ:

pPropertyId	プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。
pMode	名前を取得するモードを示す整数。この整数の解釈はプロパティのモードタイプによって異なります。HIKPropertyModeType 列挙を参照してください。

戻り値:: プロパティの現在のモードを識別する文字列

const char* HIKGetPropertyName ( int pPropertyId )

プロパティ pPropertyId を識別する、人間が解読可能な英語の文字列を取得します。

パラメータ:

pPropertyId プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。

戻り値:: プロパティ名

int HIKIsPropertyDescription ( int pPropertyId )

プロパティが説明であるかどうかを示します。

キャラクタのスタンスまたは寸法を定義する場合に、通常、プロパティは、"説明" であると見なされます(フロアコンタクトエンジンに関するキャラクタの足および手のアウトラインの定義に使用するプロパティなど)。一方、説明以外のプロパティは、他のほとんどのプロパティの場合のように、通常、HumanIK ソルバを特定の方法で制御またはコンストレインします。

パラメータ:

pPropertyId プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。

戻り値:: プロパティが説明である場合は 1、それ以外の場合は 0

プロパティ情報の取得

モジュール説明

列挙

関数

列挙型のドキュメント

関数のドキュメント