キャラクタ プロパティ

モジュール説明

このセクションでは、HIKPropertySetState 内のキャラクタ プロパティのモードと値の設定および取得用に提供されている関数について説明します。

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

モジュール
	Property Descriptions
	このセクションでは、各 HIKPropertySetState 内に含まれるすべてのキャラクタ プロパティについて簡単に説明します。
	Retrieving Property Information
	このセクションでは、最小値および最大値、モード タイプ、現在のモード、名称など、キャラクタのプロパティに関する情報を取得する関数について説明します。

関数
int	HIKGetPropertyMode (HIKPropertySetState *pState, int pPropertyId)
	プロパティ pPropertyId に HIKPropertySetState pState で設定された現在のモードを取得します。表示...
float	HIKGetPropertyValue (HIKPropertySetState *pState, int pPropertyId)
	プロパティ pPropertyId に HIKPropertySetState pState で設定された現在の値を取得します。表示...
int	HIKIsPropertyActive (HIKPropertySetState *pState, int pPropertyId)
	プロパティ pPropertyId が HIKPropertySetState pState でアクティブかどうか、つまり値が現在 HumanIK ソルバで考慮されているかどうかを示します。表示...
int	HIKIsPropertyAuto (HIKPropertySetState *pState, int pPropertyId)
	プロパティ pPropertyId の HIKPropertySetState pState での現在のモードが "auto" かどうかを示します。表示...
void	HIKPropertySetStateCopy (HIKPropertySetState *pStateOut, HIKPropertySetState *pStateIn)
	すべての値とモード設定を HIKPropertySetState pStateIn から HIKPropertySetState pStateOut にコピーします。表示...
void	HIKSetPropertyMode (HIKPropertySetState *pState, int pPropertyId, int pMode)
	プロパティ pPropertyId の HIKPropertySetState pState での現在のモードを設定します。表示...
void	HIKSetPropertyValue (HIKPropertySetState *pState, int pPropertyId, float pValue)
	プロパティ pPropertyId の HIKPropertySetState pState での現在の値を設定します。表示...

関数のドキュメント

int HIKGetPropertyMode	(	HIKPropertySetState *	pState,
		int	pPropertyId
	)

プロパティ pPropertyId に HIKPropertySetState pState で設定された現在のモードを取得します。

各プロパティが返すことのできる列挙値の解釈の詳細については、各プロパティの説明を参照してください。

パラメータ:

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

戻り値:

プロパティの現在のモードを示す整数。この整数の解釈はプロパティのモード タイプによって異なります。HIKPropertyModeType 列挙を参照してください。

float HIKGetPropertyValue	(	HIKPropertySetState *	pState,
		int	pPropertyId
	)

プロパティ pPropertyId に HIKPropertySetState pState で設定された現在の値を取得します。

パラメータ:

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

戻り値:

プロパティの現在の値。

int HIKIsPropertyActive	(	HIKPropertySetState *	pState,
		int	pPropertyId
	)

プロパティ pPropertyId が HIKPropertySetState pState でアクティブかどうか、つまり値が現在 HumanIK ソルバで考慮されているかどうかを示します。

パラメータ:

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

戻り値:

プロパティが active の場合は true、それ以外の場合は false

int HIKIsPropertyAuto	(	HIKPropertySetState *	pState,
		int	pPropertyId
	)

プロパティ pPropertyId の HIKPropertySetState pState での現在のモードが "auto" かどうかを示します。

パラメータ:

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

戻り値:

プロパティが auto　の場合は true、それ以外の場合は false

void HIKPropertySetStateCopy	(	HIKPropertySetState *	pStateOut,
		HIKPropertySetState *	pStateIn
	)

すべての値とモード設定を HIKPropertySetState pStateIn から HIKPropertySetState pStateOut にコピーします。

パラメータ:

pStateIn	入力 HIKPropertySetState
pStateOut	出力 HIKPropertySetState

void HIKSetPropertyMode	(	HIKPropertySetState *	pState,
		int	pPropertyId,
		int	pMode
	)

プロパティ pPropertyId の HIKPropertySetState pState での現在のモードを設定します。

プロパティに設定できる列挙値の詳細については、各プロパティの説明を参照してください。

パラメータ:

pState	HIKPropertySetState: プロパティを含みます。
pPropertyId	プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。
pMode	プロパティに設定されたモードを示す整数。この整数の解釈はプロパティのモード タイプによって異なります。HIKPropertyModeType 列挙を参照してください。

void HIKSetPropertyValue	(	HIKPropertySetState *	pState,
		int	pPropertyId,
		float	pValue
	)

プロパティ pPropertyId の HIKPropertySetState pState での現在の値を設定します。

パラメータ:

pState	HIKPropertySetState: プロパティを含みます。
pPropertyId	プロパティの固有の ID。可能な値については、HIKProperty 列挙を参照してください。
pValue	プロパティの現在の値。