hikproperty.h

Go to the documentation of this file.

/**************************************************************************************

Copyright (C) 2009 Autodesk, Inc.
All Rights Reserved.

The coded instructions, statements, computer programs, and/or related material (collectively "Data")
in these files contain unpublished information proprietary to Autodesk, Inc., ("Autodesk") which is
protected by Canada and United States of America federal copyright law and by international treaties.

The Data may not be disclosed or distributed to third parties, in whole or in part, without the prior
written consent of Autodesk.

THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY. ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED.
AUTODESK MAKES NO WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING BY CUSTOM
OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR
FITNESS FOR A PARTICULAR PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT
THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE.

IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS OR SUPPLIERS ("AUTODESK GROUP")
BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR
MULTIPLE DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS
OF THE THEORY OF LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO,
NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

**************************************************************************************/

#ifndef HIKPROPERTY_H
#define HIKPROPERTY_H

#include "humanik.h"

#ifdef __cplusplus
extern "C" {
#endif

// ***********************************************
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,

    
    //  Each floor contact position setting defines a different aspect of the floor contact area.
    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,            // bob: This is Hips Pull
    HIKCtrlEnforceGravityId,                // bob: Hips Pull sub-param


    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,                    //< See HIKFootContactStiffnessId
        
    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   
};

enum HIKPropertyModeType
{
    HIKPropertyNoMode = 0,      
    HIKPropertyOffOn,           
    HIKPropertyOffAutoUser,     
    HIKPropertyAutoUser         
};

enum HIKPropertyValueType
{ 
    HIKPropertyScalar = 0                      
};

enum HIKPropertyUnit
{ 
    HIKPropertyNoUnit = 0,                      
    HIKPropertyPercent,                         
    HIKPropertySecond,                          
    HIKPropertyCentimeter,                      
    HIKPropertyDegree,                          
    HIKPropertyEnum,                            
    HIKPropertyReal                             
};

typedef enum HIKPropertyModeType    eHIKPropertyModeType;
typedef enum HIKPropertyValueType   eHIKPropertyValueType;
typedef enum HIKPropertyUnit        eHIKPropertyUnit;

// ***********************************************
HIK_EXPORT const char*            HIK_API HIKGetPropertyName(int pPropertyId);

HIK_EXPORT int                    HIK_API HIKGetPropertyId(const char* pName);

HIK_EXPORT eHIKPropertyModeType   HIK_API HIKGetPropertyInfoModeType(int pPropertyId);

HIK_EXPORT eHIKPropertyValueType  HIK_API HIKGetPropertyInfoValueType(int pPropertyId);

HIK_EXPORT eHIKPropertyUnit       HIK_API HIKGetPropertyInfoUnit(int pPropertyId);

HIK_EXPORT int                   HIK_API HIKGetPropertyInfoDefaultMode(int pPropertyId);

HIK_EXPORT float                HIK_API HIKGetPropertyInfoDefaultValue(int pPropertyId);

HIK_EXPORT float                HIK_API HIKGetPropertyInfoDefaultMin(int pPropertyId);

HIK_EXPORT float                HIK_API HIKGetPropertyInfoDefaultMax(int pPropertyId);

HIK_EXPORT const  char*         HIK_API HIKGetPropertyModeName(int pPropertyId, int pMode);

HIK_EXPORT const char*          HIK_API HIKGetPropertyEnumName(int pPropertyId, int pValue);

HIK_EXPORT int                   HIK_API HIKIsPropertyDescription(int pPropertyId);




//

HIK_EXPORT HIKPropertySetState * HIK_API HIKPropertySetStateCreate(HIKMalloc pMalloc);

HIK_EXPORT HIKPropertySetState * HIK_API HIKPropertySetStateCreateInPlace(void* pBuffer);

HIK_EXPORT void                 HIK_API HIKPropertySetStateDestroy(HIKPropertySetState *pPropertySetState, HIKFree pFree);

HIK_EXPORT size_t               HIK_API HIKPropertySetStateSize();



// ***********************************************
HIK_EXPORT int                   HIK_API HIKGetPropertyMode (HIKPropertySetState *pState, int pPropertyId);

HIK_EXPORT float                 HIK_API HIKGetPropertyValue(HIKPropertySetState *pState, int pPropertyId);

HIK_EXPORT void                  HIK_API HIKSetPropertyMode (HIKPropertySetState *pState, int pPropertyId, int pMode);

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

HIK_EXPORT void                  HIK_API HIKPropertySetStateCopy(HIKPropertySetState *pStateOut,HIKPropertySetState *pStateIn);

HIK_EXPORT int                  HIK_API HIKIsPropertyActive(HIKPropertySetState *pState, int pPropertyId);

HIK_EXPORT int                   HIK_API HIKIsPropertyAuto(HIKPropertySetState *pState, int pPropertyId);



#ifdef __cplusplus
}
#endif

#endif