HIK2014/humanik/hikproperty.h File Reference

hikproperty.h File Reference
#include "humanik.h"

Typedefs

typedef enum HIKPropertyModeType eHIKPropertyModeType
 see enum HIKPropertyModeType More...
 
typedef enum HIKPropertyValueType eHIKPropertyValueType
 see enum HIKPropertyValueType More...
 
typedef enum HIKPropertyUnit eHIKPropertyUnit
 see enum HIKPropertyUnit More...
 

Enumerations

enum  HIKProperty {
  HIKForceActorSpaceId, HIKScaleCompensationId, HIKMassCenterCompensationId, HIKAnkleHeightCompensationId,
  HIKAnkleProximityCompensationId, HIKHipsHeightCompensationId, HIKReachActorLeftAnkleId, HIKReachActorRightAnkleId,
  HIKReachActorChestId, HIKReachActorLeftWristId, HIKReachActorRightWristId, HIKReachActorLeftKneeId,
  HIKReachActorRightKneeId, HIKReachActorHeadId, HIKReachActorLeftElbowId, HIKReachActorRightElbowId,
  HIKReachActorLeftAnkleRotationId, HIKReachActorRightAnkleRotationId, HIKReachActorHeadRotationId, HIKReachActorLeftWristRotationId,
  HIKReachActorRightWristRotationId, HIKReachActorLeftFingerBaseId, HIKReachActorRightFingerBaseId, HIKReachActorLeftToesBaseId,
  HIKReachActorRightToesBaseId, HIKReachActorLeftFingerBaseRotationId, HIKReachActorRightFingerBaseRotationId, HIKReachActorLeftToesBaseRotationId,
  HIKReachActorRightToesBaseRotationId, HIKReachActorChestRotationId, HIKReachActorLowerChestRotationId, HIKReachActorLeftHandThumbId,
  HIKReachActorLeftHandIndexId, HIKReachActorLeftHandMiddleId, HIKReachActorLeftHandRingId, HIKReachActorLeftHandPinkyId,
  HIKReachActorLeftHandExtraFingerId, HIKReachActorRightHandThumbId, HIKReachActorRightHandIndexId, HIKReachActorRightHandMiddleId,
  HIKReachActorRightHandRingId, HIKReachActorRightHandPinkyId, HIKReachActorRightHandExtraFingerId, HIKReachActorLeftFootThumbId,
  HIKReachActorLeftFootIndexId, HIKReachActorLeftFootMiddleId, HIKReachActorLeftFootRingId, HIKReachActorLeftFootPinkyId,
  HIKReachActorLeftFootExtraFingerId, HIKReachActorRightFootThumbId, HIKReachActorRightFootIndexId, HIKReachActorRightFootMiddleId,
  HIKReachActorRightFootRingId, HIKReachActorRightFootPinkyId, HIKReachActorRightFootExtraFingerId, HIKFootFloorContactId,
  HIKFootBottomToAnkleId, HIKFootBackToAnkleId, HIKFootMiddleToAnkleId, HIKFootFrontToMiddleId,
  HIKFootInToAnkleId, HIKFootOutToAnkleId, HIKHandFloorContactId, HIKHandBottomToWristId,
  HIKHandBackToWristId, HIKHandMiddleToWristId, HIKHandFrontToMiddleId, HIKHandInToWristId,
  HIKHandOutToWristId, HIKHandContactTypeId, HIKHandFingerContactId, HIKHandFingerContactModeId,
  HIKFootContactTypeId, HIKFootFingerContactId, HIKFootFingerContactModeId, HIKLeftUpLegRollId,
  HIKLeftLegRollId, HIKRightUpLegRollId, HIKRightLegRollId, HIKLeftArmRollId,
  HIKLeftForeArmRollId, HIKRightArmRollId, HIKRightForeArmRollId, HIKMirrorId,
  HIKLeftKneeKillPitchId, HIKRightKneeKillPitchId, HIKLeftElbowKillPitchId, HIKRightElbowKillPitchId,
  HIKCtrlPullLeftFootId, HIKCtrlPullRightFootId, HIKCtrlPullLeftHandId, HIKCtrlPullRightHandId,
  HIKCtrlPullHeadId, HIKCtrlPullLeftToeBaseId, HIKCtrlPullLeftKneeId, HIKCtrlPullRightToeBaseId,
  HIKCtrlPullRightKneeId, HIKCtrlPullLeftFingerBaseId, HIKCtrlPullLeftElbowId, HIKCtrlPullRightFingerBaseId,
  HIKCtrlPullRightElbowId, HIKCtrlChestPullLeftHandId, HIKCtrlChestPullRightHandId, HIKCtrlResistHipsPositionId,
  HIKCtrlEnforceGravityId, HIKCtrlResistHipsOrientationId, HIKCtrlResistChestPositionId, HIKCtrlResistChestOrientationId,
  HIKCtrlResistLeftCollarId, HIKCtrlResistRightCollarId, HIKCtrlResistLeftKneeId, HIKCtrlResistRightKneeId,
  HIKCtrlResistLeftElbowId, HIKCtrlResistRightElbowId, HIKCtrlSpineStiffnessId, HIKHipsTOffsetXId,
  HIKHipsTOffsetYId, HIKHipsTOffsetZId, HIKChestTOffsetXId, HIKChestTOffsetYId,
  HIKChestTOffsetZId, HIKFootAutomaticToesId, HIKFootFloorPivotId, HIKPostureId,
  HIKHandAutomaticFingersId, HIKHandFloorPivotId, HIKCtrlNeckStiffnessId, HIKHipsTranslationModeId,
  HIKFingerSolvingId, HIKFootContactStiffnessId, HIKCtrlResistMaximumExtensionLeftKnee, HIKCtrlResistMaximumExtensionRightKnee,
  HIKCtrlResistMaximumExtensionLeftElbow, HIKCtrlResistMaximumExtensionRightElbow, HIKCtrlResistCompressionFactorLeftKnee, HIKCtrlResistCompressionFactorRightKnee,
  HIKCtrlResistCompressionFactorLeftElbow, HIKCtrlResistCompressionFactorRightElbow, HIKHandFingerContactRollStiffness, HIKFootFingerContactRollStiffness,
  HIKHandContactStiffness, HIKRollExtractionMode, HIKPullIterationCount, HIKLeftHandThumbTip,
  HIKLeftHandIndexTip, HIKLeftHandMiddleTip, HIKLeftHandRingTip, HIKLeftHandPinkyTip,
  HIKLeftHandExtraFingerTip, HIKRightHandThumbTip, HIKRightHandIndexTip, HIKRightHandMiddleTip,
  HIKRightHandRingTip, HIKRightHandPinkyTip, HIKRightHandExtraFingerTip, HIKLeftFootThumbTip,
  HIKLeftFootIndexTip, HIKLeftFootMiddleTip, HIKLeftFootRingTip, HIKLeftFootPinkyTip,
  HIKLeftFootExtraFingerTip, HIKRightFootThumbTip, HIKRightFootIndexTip, HIKRightFootMiddleTip,
  HIKRightFootRingTip, HIKRightFootPinkyTip, HIKRightFootExtraFingerTip, HIKRealisticShoulder,
  HIKLeftLegMaxExtensionAngle, HIKRightLegMaxExtensionAngle, HIKLeftArmMaxExtensionAngle, HIKRightArmMaxExtensionAngle,
  HIKExtraCollarRatioId, HIKCollarStiffnessX, HIKCollarStiffnessY, HIKCollarStiffnessZ,
  HIKReachActorLeftShoulderId, HIKReachActorRightShoulderId, HIKFingerPropagationId, HIKRealisticLeftKneeSolvingId,
  HIKRealisticRightKneeSolvingId, HIKStretchStartArmsAndLegs, HIKStretchStopArmsAndLegs, HIKSnSScaleArmsAndLegs,
  HIKSnSReachLeftWrist, HIKSnSReachRightWrist, HIKSnSReachLeftAnkle, HIKSnSReachRightAnkle,
  HIKSnSScaleSpine, HIKSnSScaleSpineChildren, HIKSnSReachChestEnd, HIKSnSScaleNeck,
  HIKSnSReachHead, HIKLeftUpLegRollExId, HIKLeftLegRollExId, HIKRightUpLegRollExId,
  HIKRightLegRollExId, HIKLeftArmRollExId, HIKLeftForeArmRollExId, HIKRightArmRollExId,
  HIKRightForeArmRollExId, HIKTopSpineCorrectionId, HIKLowerSpineCorrectionId, HIKSnSSmoothReach,
  HIKLockXId, HIKLockYId, HIKLockZId, HIKRealisticArmSolvingId,
  HIKLastPropertyId, HIKForceActorSpaceId, HIKScaleCompensationId, HIKMassCenterCompensationId,
  HIKAnkleHeightCompensationId, HIKAnkleProximityCompensationId, HIKHipsHeightCompensationId, HIKReachActorLeftAnkleId,
  HIKReachActorRightAnkleId, HIKReachActorChestId, HIKReachActorLeftWristId, HIKReachActorRightWristId,
  HIKReachActorLeftKneeId, HIKReachActorRightKneeId, HIKReachActorHeadId, HIKReachActorLeftElbowId,
  HIKReachActorRightElbowId, HIKReachActorLeftAnkleRotationId, HIKReachActorRightAnkleRotationId, HIKReachActorHeadRotationId,
  HIKReachActorLeftWristRotationId, HIKReachActorRightWristRotationId, HIKReachActorLeftFingerBaseId, HIKReachActorRightFingerBaseId,
  HIKReachActorLeftToesBaseId, HIKReachActorRightToesBaseId, HIKReachActorLeftFingerBaseRotationId, HIKReachActorRightFingerBaseRotationId,
  HIKReachActorLeftToesBaseRotationId, HIKReachActorRightToesBaseRotationId, HIKReachActorChestRotationId, HIKReachActorLowerChestRotationId,
  HIKReachActorLeftHandThumbId, HIKReachActorLeftHandIndexId, HIKReachActorLeftHandMiddleId, HIKReachActorLeftHandRingId,
  HIKReachActorLeftHandPinkyId, HIKReachActorLeftHandExtraFingerId, HIKReachActorRightHandThumbId, HIKReachActorRightHandIndexId,
  HIKReachActorRightHandMiddleId, HIKReachActorRightHandRingId, HIKReachActorRightHandPinkyId, HIKReachActorRightHandExtraFingerId,
  HIKReachActorLeftFootThumbId, HIKReachActorLeftFootIndexId, HIKReachActorLeftFootMiddleId, HIKReachActorLeftFootRingId,
  HIKReachActorLeftFootPinkyId, HIKReachActorLeftFootExtraFingerId, HIKReachActorRightFootThumbId, HIKReachActorRightFootIndexId,
  HIKReachActorRightFootMiddleId, HIKReachActorRightFootRingId, HIKReachActorRightFootPinkyId, HIKReachActorRightFootExtraFingerId,
  HIKFootFloorContactId, HIKFootBottomToAnkleId, HIKFootBackToAnkleId, HIKFootMiddleToAnkleId,
  HIKFootFrontToMiddleId, HIKFootInToAnkleId, HIKFootOutToAnkleId, HIKHandFloorContactId,
  HIKHandBottomToWristId, HIKHandBackToWristId, HIKHandMiddleToWristId, HIKHandFrontToMiddleId,
  HIKHandInToWristId, HIKHandOutToWristId, HIKHandContactTypeId, HIKHandFingerContactId,
  HIKHandFingerContactModeId, HIKFootContactTypeId, HIKFootFingerContactId, HIKFootFingerContactModeId,
  HIKLeftUpLegRollId, HIKLeftLegRollId, HIKRightUpLegRollId, HIKRightLegRollId,
  HIKLeftArmRollId, HIKLeftForeArmRollId, HIKRightArmRollId, HIKRightForeArmRollId,
  HIKMirrorId, HIKLeftKneeKillPitchId, HIKRightKneeKillPitchId, HIKLeftElbowKillPitchId,
  HIKRightElbowKillPitchId, HIKCtrlPullLeftFootId, HIKCtrlPullRightFootId, HIKCtrlPullLeftHandId,
  HIKCtrlPullRightHandId, HIKCtrlPullHeadId, HIKCtrlPullLeftToeBaseId, HIKCtrlPullLeftKneeId,
  HIKCtrlPullRightToeBaseId, HIKCtrlPullRightKneeId, HIKCtrlPullLeftFingerBaseId, HIKCtrlPullLeftElbowId,
  HIKCtrlPullRightFingerBaseId, HIKCtrlPullRightElbowId, HIKCtrlChestPullLeftHandId, HIKCtrlChestPullRightHandId,
  HIKCtrlResistHipsPositionId, HIKCtrlEnforceGravityId, HIKCtrlResistHipsOrientationId, HIKCtrlResistChestPositionId,
  HIKCtrlResistChestOrientationId, HIKCtrlResistLeftCollarId, HIKCtrlResistRightCollarId, HIKCtrlResistLeftKneeId,
  HIKCtrlResistRightKneeId, HIKCtrlResistLeftElbowId, HIKCtrlResistRightElbowId, HIKCtrlSpineStiffnessId,
  HIKHipsTOffsetXId, HIKHipsTOffsetYId, HIKHipsTOffsetZId, HIKChestTOffsetXId,
  HIKChestTOffsetYId, HIKChestTOffsetZId, HIKFootAutomaticToesId, HIKFootFloorPivotId,
  HIKPostureId, HIKHandAutomaticFingersId, HIKHandFloorPivotId, HIKCtrlNeckStiffnessId,
  HIKHipsTranslationModeId, HIKFingerSolvingId, HIKFootContactStiffnessId, HIKCtrlResistMaximumExtensionLeftKnee,
  HIKCtrlResistMaximumExtensionRightKnee, HIKCtrlResistMaximumExtensionLeftElbow, HIKCtrlResistMaximumExtensionRightElbow, HIKCtrlResistCompressionFactorLeftKnee,
  HIKCtrlResistCompressionFactorRightKnee, HIKCtrlResistCompressionFactorLeftElbow, HIKCtrlResistCompressionFactorRightElbow, HIKHandFingerContactRollStiffness,
  HIKFootFingerContactRollStiffness, HIKHandContactStiffness, HIKRollExtractionMode, HIKPullIterationCount,
  HIKLeftHandThumbTip, HIKLeftHandIndexTip, HIKLeftHandMiddleTip, HIKLeftHandRingTip,
  HIKLeftHandPinkyTip, HIKLeftHandExtraFingerTip, HIKRightHandThumbTip, HIKRightHandIndexTip,
  HIKRightHandMiddleTip, HIKRightHandRingTip, HIKRightHandPinkyTip, HIKRightHandExtraFingerTip,
  HIKLeftFootThumbTip, HIKLeftFootIndexTip, HIKLeftFootMiddleTip, HIKLeftFootRingTip,
  HIKLeftFootPinkyTip, HIKLeftFootExtraFingerTip, HIKRightFootThumbTip, HIKRightFootIndexTip,
  HIKRightFootMiddleTip, HIKRightFootRingTip, HIKRightFootPinkyTip, HIKRightFootExtraFingerTip,
  HIKRealisticShoulder, HIKLeftLegMaxExtensionAngle, HIKRightLegMaxExtensionAngle, HIKLeftArmMaxExtensionAngle,
  HIKRightArmMaxExtensionAngle, HIKExtraCollarRatioId, HIKCollarStiffnessX, HIKCollarStiffnessY,
  HIKCollarStiffnessZ, HIKReachActorLeftShoulderId, HIKReachActorRightShoulderId, HIKFingerPropagationId,
  HIKRealisticLeftKneeSolvingId, HIKRealisticRightKneeSolvingId, HIKStretchStartArmsAndLegs, HIKStretchStopArmsAndLegs,
  HIKSnSScaleArmsAndLegs, HIKSnSReachLeftWrist, HIKSnSReachRightWrist, HIKSnSReachLeftAnkle,
  HIKSnSReachRightAnkle, HIKSnSScaleSpine, HIKSnSScaleSpineChildren, HIKSnSReachChestEnd,
  HIKSnSScaleNeck, HIKSnSReachHead, HIKLeftUpLegRollExId, HIKLeftLegRollExId,
  HIKRightUpLegRollExId, HIKRightLegRollExId, HIKLeftArmRollExId, HIKLeftForeArmRollExId,
  HIKRightArmRollExId, HIKRightForeArmRollExId, HIKTopSpineCorrectionId, HIKLowerSpineCorrectionId,
  HIKSnSSmoothReach, HIKLockXId, HIKLockYId, HIKLockZId,
  HIKRealisticArmSolvingId, HIKLeafLeftUpLegRoll1Id, HIKLeafLeftLegRoll1Id, HIKLeafRightUpLegRoll1Id,
  HIKLeafRightLegRoll1Id, HIKLeafLeftArmRoll1Id, HIKLeafLeftForeArmRoll1Id, HIKLeafRightArmRoll1Id,
  HIKLeafRightForeArmRoll1Id, HIKLeafLeftUpLegRoll2Id, HIKLeafLeftLegRoll2Id, HIKLeafRightUpLegRoll2Id,
  HIKLeafRightLegRoll2Id, HIKLeafLeftArmRoll2Id, HIKLeafLeftForeArmRoll2Id, HIKLeafRightArmRoll2Id,
  HIKLeafRightForeArmRoll2Id, HIKLeafLeftUpLegRoll3Id, HIKLeafLeftLegRoll3Id, HIKLeafRightUpLegRoll3Id,
  HIKLeafRightLegRoll3Id, HIKLeafLeftArmRoll3Id, HIKLeafLeftForeArmRoll3Id, HIKLeafRightArmRoll3Id,
  HIKLeafRightForeArmRoll3Id, HIKLeafLeftUpLegRoll4Id, HIKLeafLeftLegRoll4Id, HIKLeafRightUpLegRoll4Id,
  HIKLeafRightLegRoll4Id, HIKLeafLeftArmRoll4Id, HIKLeafLeftForeArmRoll4Id, HIKLeafRightArmRoll4Id,
  HIKLeafRightForeArmRoll4Id, HIKLeafLeftUpLegRoll5Id, HIKLeafLeftLegRoll5Id, HIKLeafRightUpLegRoll5Id,
  HIKLeafRightLegRoll5Id, HIKLeafLeftArmRoll5Id, HIKLeafLeftForeArmRoll5Id, HIKLeafRightArmRoll5Id,
  HIKLeafRightForeArmRoll5Id, HIKLeftLegFullRollExtractionId, HIKRightLegFullRollExtractionId, HIKLeftArmFullRollExtractionId,
  HIKRightArmFullRollExtractionId, HIKLastPropertyId
}
 Lists all character properties contained in the HIKPropertySetState. More...
 
enum  HIKPropertyModeType {
  HIKPropertyNoMode = 0, HIKPropertyOffOn, HIKPropertyOffAutoUser, HIKPropertyAutoUser,
  HIKPropertyNoMode = 0, HIKPropertyOffOn, HIKPropertyOffAutoUser, HIKPropertyAutoUser
}
 Lists the possible mode types for character properties. More...
 
enum  HIKPropertyValueType { HIKPropertyScalar = 0, HIKPropertyScalar = 0 }
 Lists the possible value types for character properties. More...
 
enum  HIKPropertyUnit {
  HIKPropertyNoUnit = 0, HIKPropertyPercent, HIKPropertySecond, HIKPropertyCentimeter,
  HIKPropertyDegree, HIKPropertyEnum, HIKPropertyReal, HIKPropertyNoUnit = 0,
  HIKPropertyPercent, HIKPropertySecond, HIKPropertyCentimeter, HIKPropertyDegree,
  HIKPropertyEnum, HIKPropertyReal
}
 Lists the possible unit types for character properties. More...
 

Functions

const char * HIKGetPropertyName (int pPropertyId)
 Retrieves a human-readable, English-language string that identifies property pPropertyId. More...
 
int HIKGetPropertyId (const char *pName)
 Retrieves the unique ID of property pName from its descriptive name. More...
 
eHIKPropertyModeType HIKGetPropertyInfoModeType (int pPropertyId)
 Retrieves the mode type for property pPropertyId. More...
 
eHIKPropertyValueType HIKGetPropertyInfoValueType (int pPropertyId)
 Retrieves the value type for property pPropertyId. More...
 
eHIKPropertyUnit HIKGetPropertyInfoUnit (int pPropertyId)
 Retrieves the unit type for property pPropertyId. More...
 
int HIKGetPropertyInfoDefaultMode (int pPropertyId)
 Retrieves the default mode for property pPropertyId. More...
 
float HIKGetPropertyInfoDefaultValue (int pPropertyId)
 Retrieves the default value for property pPropertyId. More...
 
float HIKGetPropertyInfoDefaultMin (int pPropertyId)
 Retrieves the minimum accepted value for property pPropertyId. More...
 
float HIKGetPropertyInfoDefaultMax (int pPropertyId)
 Retrieves the maximum accepted value for property pPropertyId. More...
 
const char * HIKGetPropertyModeName (int pPropertyId, int pMode)
 Retrieves a human-readable, English-language string that identifies mode pMode for property pPropertyId. More...
 
const char * HIKGetPropertyEnumName (int pPropertyId, int pValue)
 Retrieves a human-readable, English-language string that identifies the enumeration value pValue for property pPropertyId. More...
 
int HIKIsPropertyDescription (int pPropertyId)
 Indicates whether or not the property is a description. More...
 
HIKPropertySetStateHIKPropertySetStateCreate (HIKMalloc pMalloc)
 Create a new HIKPropertySetState. More...
 
HIKPropertySetStateHIKPropertySetStateCreateInPlace (void *pBuffer)
 Create a new HIKPropertySetState in the buffer pBuffer. More...
 
void HIKPropertySetStateDestroy (HIKPropertySetState *pPropertySetState, HIKFree pFree)
 Destroy HIKPropertySetState pPropertySetState. More...
 
size_t HIKPropertySetStateSize ()
 Retrieves the size of an HIKPropertySetState object in bytes. More...
 
int HIKGetPropertyMode (HIKPropertySetState *pState, int pPropertyId)
 Retrieves the current mode set for property pPropertyId in HIKPropertySetState pState. More...
 
float HIKGetPropertyValue (HIKPropertySetState *pState, int pPropertyId)
 Retrieves the current value set for property pPropertyId in HIKPropertySetState pState. More...
 
void HIKSetPropertyMode (HIKPropertySetState *pState, int pPropertyId, int pMode)
 Sets the current mode for property pPropertyId in HIKPropertySetState pState. More...
 
void HIKSetPropertyValue (HIKPropertySetState *pState, int pPropertyId, float pValue)
 Sets the current value for property pPropertyId in HIKPropertySetState pState. More...
 
void HIKPropertySetStateCopy (HIKPropertySetState *pStateOut, HIKPropertySetState *pStateIn)
 Copies all values and mode settings from HIKPropertySetState pStateIn to HIKPropertySetState pStateOut. More...
 
int HIKIsPropertyActive (HIKPropertySetState *pState, int pPropertyId)
 Indicates whether or not property pPropertyId in HIKPropertySetState pState is active–i.e. More...
 
int HIKIsPropertyAuto (HIKPropertySetState *pState, int pPropertyId)
 Indicates whether or not the current mode of property pPropertyId in HIKPropertySetState pState is "auto". More...
 

Typedef Documentation

see enum HIKPropertyModeType

Definition at line 561 of file hikproperty.h.

see enum HIKPropertyUnit

Definition at line 565 of file hikproperty.h.

see enum HIKPropertyValueType

Definition at line 563 of file hikproperty.h.

Go to the source code of this file.