constraints/CharacterSolver/HIK2014Solver/hikhostmb.h

constraints/CharacterSolver/HIK2014Solver/hikhostmb.h
/***************************************************************************************
Autodesk(R) Open Reality(R) Samples
(C) 2012 Autodesk, Inc. and/or its licensors
All rights reserved.
AUTODESK SOFTWARE LICENSE AGREEMENT
Autodesk, Inc. licenses this Software to you only upon the condition that
you accept all of the terms contained in the Software License Agreement ("Agreement")
that is embedded in or that is delivered with this Software. By selecting
the "I ACCEPT" button at the end of the Agreement or by copying, installing,
uploading, accessing or using all or any portion of the Software you agree
to enter into the Agreement. A contract is then formed between Autodesk and
either you personally, if you acquire the Software for yourself, or the company
or other legal entity for which you are acquiring the software.
AUTODESK, INC., MAKES NO WARRANTY, EITHER EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE REGARDING THESE MATERIALS, AND MAKES SUCH MATERIALS AVAILABLE SOLELY ON AN
"AS-IS" BASIS.
IN NO EVENT SHALL AUTODESK, INC., BE LIABLE TO ANYONE FOR SPECIAL, COLLATERAL,
INCIDENTAL, OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH OR ARISING OUT OF PURCHASE
OR USE OF THESE MATERIALS. THE SOLE AND EXCLUSIVE LIABILITY TO AUTODESK, INC.,
REGARDLESS OF THE FORM OF ACTION, SHALL NOT EXCEED THE PURCHASE PRICE OF THE
MATERIALS DESCRIBED HEREIN.
Autodesk, Inc., reserves the right to revise and improve its products as it sees fit.
Autodesk and Open Reality are registered trademarks or trademarks of Autodesk, Inc.,
in the U.S.A. and/or other countries. All other brand names, product names, or
trademarks belong to their respective holders.
GOVERNMENT USE
Use, duplication, or disclosure by the U.S. Government is subject to restrictions as
set forth in FAR 12.212 (Commercial Computer Software-Restricted Rights) and
DFAR 227.7202 (Rights in Technical Data and Computer Software), as applicable.
Manufacturer is Autodesk, Inc., 10 Duke Street, Montreal, Quebec, Canada, H3C 2L7.
***************************************************************************************/
#ifndef __HIKHOSTMB__H_
#define __HIKHOSTMB__H_
#include <fbsdk/fbsdk.h>
#include "hikhost.h"
#define LEFT_EXTRA_COLLAR 0
#define RIGHT_EXTRA_COLLAR 1
K_STATIC_ASSERT( LastEffectorId + 1 < ( 1 << 10 ) );
K_STATIC_ASSERT( LastNodeId + 1 < ( 1 << 10 ) );
class AnimationNode_Id
{
int mId;
public:
AnimationNode_Id();
AnimationNode_Id(const AnimationNode_Id &pSource);
AnimationNode_Id(const int pSource);
AnimationNode_Id(HIKEffectorId pId);
AnimationNode_Id(HIKNodeId pId);
AnimationNode_Id GetIdWithType(FBModelTransformationType pConnectorType) const;
bool IsValid() const;
bool IsValidEffectorId() const;
bool IsValidNodeId() const;
bool IsValidType() const;
HIKEffectorId GetEffectorId() const;
HIKNodeId GetNodeId() const;
int GetType() const;
operator int() const;
private:
//designed only for double solve purpose
static HIKEffectorId HIKNodeIdToHIKEffectorId_LastInChain(HIKNodeId pNodeId);
};
inline AnimationNode_Id::operator int() const
{
return mId;
}
inline AnimationNode_Id AnimationNode_Id::GetIdWithType(FBModelTransformationType pConnectorType) const
{
if(IsValid())
{
return AnimationNode_Id((pConnectorType << 21) | mId);
}
else
{
return AnimationNode_Id();
}
}
inline bool AnimationNode_Id::IsValid() const
{
return ((mId & 0x1) != 0);
}
inline bool AnimationNode_Id::IsValidEffectorId() const
{
const int lId = GetEffectorId();
return ( lId >= 0 && lId < LastEffectorId);
}
inline bool AnimationNode_Id::IsValidNodeId() const
{
const int lId = GetNodeId();
return ( lId >= 0 && lId < LastNodeId);
}
inline bool AnimationNode_Id::IsValidType() const
{
const int lType = GetType();
return (lType == kModelTranslation || lType == kModelRotation || lType == kModelScaling);
}
inline HIKEffectorId AnimationNode_Id::GetEffectorId() const
{
if(IsValid())
{
return (HIKEffectorId)(((mId >> 11) & 0x3FF) /*(10 bits)*/ - 1);
}
}
inline HIKNodeId AnimationNode_Id::GetNodeId() const
{
if(IsValid())
{
return (HIKNodeId)(((mId >> 1) & 0x3FF) /*(10 bits)*/ - 1);
}
return LastNodeId;
}
inline int AnimationNode_Id::GetType() const
{
if(IsValid())
{
return (mId >> 21) & 0xF /*(4 bits)*/;
}
return -1;
}
//designed only for double solve purpose
inline HIKEffectorId AnimationNode_Id::HIKNodeIdToHIKEffectorId_LastInChain(HIKNodeId pNodeId)
{
HIKEffectorId lChildEffector;
switch (pNodeId)
{
case HipsNodeId: { lChildEffector = HipsEffectorId; } break;
{
lChildEffector = LeftAnkleEffectorId;
} break;
{
lChildEffector = RightAnkleEffectorId;
} break;
{
lChildEffector = LeftWristEffectorId;
} break;
{
lChildEffector = RightWristEffectorId;
} break;
{
lChildEffector = LeftKneeEffectorId;
} break;
{
lChildEffector = RightKneeEffectorId;
} break;
{
lChildEffector = LeftElbowEffectorId;
} break;
{
lChildEffector = RightElbowEffectorId;
} break;
case WaistNodeId: { lChildEffector = ChestOriginEffectorId; } break;
case Spine1NodeId:
case Spine9NodeId:
{
lChildEffector = ChestEndEffectorId;
} break;
case LeftFootNodeId: { lChildEffector = LeftFootEffectorId; } break;
case RightFootNodeId: { lChildEffector = RightFootEffectorId; } break;
{
lChildEffector = LeftShoulderEffectorId;
} break;
{
lChildEffector = RightShoulderEffectorId;
} break;
case NeckNodeId:
case HeadNodeId: { lChildEffector = HeadEffectorId; } break;
case LeftHipNodeId: { lChildEffector = LeftHipEffectorId; } break;
case RightHipNodeId: { lChildEffector = RightHipEffectorId; } break;
case LeftHandNodeId: { lChildEffector = LeftHandEffectorId; } break;
case RightHandNodeId: { lChildEffector = RightHandEffectorId; } break;
{
lChildEffector = LeftHandThumbEffectorId;
} break;
{
lChildEffector = LeftHandIndexEffectorId;
} break;
{
lChildEffector = LeftHandMiddleEffectorId;
} break;
{
lChildEffector = LeftHandRingEffectorId;
} break;
{
lChildEffector = LeftHandPinkyEffectorId;
} break;
{
lChildEffector = LeftHandExtraFingerEffectorId;
} break;
{
lChildEffector = RightHandThumbEffectorId;
} break;
{
lChildEffector = RightHandIndexEffectorId;
} break;
{
lChildEffector = RightHandMiddleEffectorId;
} break;
{
lChildEffector = RightHandRingEffectorId;
} break;
{
lChildEffector = RightHandPinkyEffectorId;
} break;
{
lChildEffector = RightHandExtraFingerEffectorId;
} break;
{
lChildEffector = LeftFootThumbEffectorId;
} break;
{
lChildEffector = LeftFootIndexEffectorId;
} break;
{
lChildEffector = LeftFootMiddleEffectorId;
} break;
{
lChildEffector = LeftFootRingEffectorId;
} break;
{
lChildEffector = LeftFootPinkyEffectorId;
} break;
{
lChildEffector = LeftFootExtraFingerEffectorId;
} break;
{
lChildEffector = RightFootThumbEffectorId;
} break;
{
lChildEffector = RightFootIndexEffectorId;
} break;
{
lChildEffector = RightFootMiddleEffectorId;
} break;
{
lChildEffector = RightFootRingEffectorId;
} break;
{
lChildEffector = RightFootPinkyEffectorId;
} break;
{
lChildEffector = RightFootExtraFingerEffectorId;
} break;
default:
{
lChildEffector = LastEffectorId;
} break;
}
return lChildEffector;
}
class HIKHostNodeMB
{
public:
// Members
FBModel *mNode;
FBAnimationNode* mDestTConn;
FBAnimationNode* mDestRConn;
FBAnimationNode* mDestSConn;
FBProperty* mReachT;
FBProperty* mReachR;
// functions
HIKHostNodeMB();
virtual void SetNode(FBModel *pNode, FBConstraint *pConstraint, AnimationNode_Id pConnectorId=0);
virtual void Clear();
virtual bool IsDestinationConn(FBAnimationNode* pConnector);
};
class HIKHostPropertyMB
{
public:
int mDefaultMode;
double mDefaultValue;
FBProperty* mModeP;
FBProperty* mValueP;
int mValueIndex;
double mValueScale;
bool mIsEnum;
HIKHostPropertyMB();
void Init(FBProperty *pModeP, FBProperty *pValueP,int pValueIndex,double pValueScale,bool pIsEnum);
};
template <> bool HIKHostNode<HIKHostNodeMB>::Valid();
template <> void HIKHostNode<HIKHostNodeMB>::ReadXForm(double *pXForm, FBEvaluateInfo* pEvalInfo);
template <> void HIKHostNode<HIKHostNodeMB>::WriteXForm(double *pXForm, FBEvaluateInfo* pEvalInfo);
template <> void HIKHostNode<HIKHostNodeMB>::WriteXFormCandidate(double *pXForm, FBEvaluateInfo* pEvalInfo);
template <> void HIKHostNode<HIKHostNodeMB>::ReadTQS(FBTVector &pT, FBQuaternion &pQ, FBVector4d &pS, FBEvaluateInfo* pEvalInfo);
template <> void HIKHostNode<HIKHostNodeMB>::WriteTQS(FBTVector &pT, FBQuaternion &pQ, FBVector4d &pS, FBEvaluateInfo* pEvalInfo);
template <> void HIKHostNode<HIKHostNodeMB>::WriteTQSIfNotRecursive(FBTVector &pT, FBQuaternion &pQ, FBVector4d &pS, FBEvaluateInfo* pEvalInfo, int &pRecursivityInfo);
template <> void HIKHostNode<HIKHostNodeMB>::WriteCandidateTQS(const FBTVector &pT, const FBQuaternion &pQ, const FBVector4d &pS, FBEvaluateInfo* pEvalInfo);
template <> void HIKHostNode<HIKHostNodeMB>::SetCandidateTQS(FBTVector &pT, FBQuaternion &pQ, FBVector4d &pS, FBEvaluateInfo* pEvalInfo);
template <> int HIKHostNode<HIKHostNodeMB>::IsEvaluationRecursiveTQS(FBEvaluateInfo* pEvalInfo);
template <> double HIKHostNode<HIKHostNodeMB>::ReadReachT( FBEvaluateInfo* pEvalInfo );
template <> double HIKHostNode<HIKHostNodeMB>::ReadReachR( FBEvaluateInfo* pEvalInfo );
template <> void HIKHostNode<HIKHostNodeMB>::ReadIKPivot(double *pIKPivot, FBEvaluateInfo* pEvalInfo);
template <> bool HIKHostNode<HIKHostNodeMB>::GetIKSync();
template <> void HIKHostNode<HIKHostNodeMB>::GetVector(FBVector3d &retVector, FBModelTransformationType pWhat,bool pGlobalInfo, FBEvaluateInfo* pEvalInfo);
template <> bool HIKHostNode<HIKHostNodeMB>::GetUseRotationLimits();
template <> bool HIKHostNode<HIKHostNodeMB>::GetUseTranslationLimits();
template <> int HIKHostNode<HIKHostNodeMB>::GetRotationOrder();
template <> void HIKHostNode<HIKHostNodeMB>::GetPreQ(double *pPreQ);
template <> void HIKHostNode<HIKHostNodeMB>::GetPostQ(double *pPostQ);
template <> int HIKHostNode<HIKHostNodeMB>::GetRotationMinXYZ(double *pXYZ);
template <> int HIKHostNode<HIKHostNodeMB>::GetRotationMaxXYZ(double *pXYZ);
template <> int HIKHostProperty<HIKHostPropertyMB>::ReadMode( FBEvaluateInfo* pEvalInfo );
template <> double HIKHostProperty<HIKHostPropertyMB>::ReadValue( FBEvaluateInfo* pEvalInfo );
// helpers
HIKNodeId FBBodyNodeIdToHIKNodeId(FBBodyNodeId pBodyNode);
HIKNodeId ExtraIndexToHIKNodeId(int pExtraIndex);
int HIKNodeIdToExtraIndex(HIKNodeId pNodeId);
int FBEffectorIdToHIKId(FBEffectorId pEffector);
HIKFloorContact FBFloorContactIDToHIKLeftHandFloor(FBFloorContactID pFloorContact);
bool GetNodeIdOrEffectIdFromModel( FBCharacterSolver* pSolver, FBModel* pModel, int& pHIKNodeId, int& pHIKEffectorId, FBEffectorId& pEffectorId, FBEffectorSetID& pPivotIndex );
int GetSolvingStepBasedOnActivePart(int pIndex);
// host properties
void HIKHostPropertiesInit(HIKCharacterHost<HIKHostNodeMB,HIKHostPropertyMB> &pHIKCharacterHost);
void HIKHostPropertiesFromCharacter(HIKCharacterHost<HIKHostNodeMB,HIKHostPropertyMB> &pHIKCharacterHost, FBCharacter* pCharacter);
// host mapping and hierarchy
void HIKCharacterHostFromFBCharacter(HIKCharacterHost<HIKHostNodeMB,HIKHostPropertyMB> &pHIKCharacterHost, FBCharacter* pCharacter, bool pFloorContacts=false);
void HIKCharacterHostFromFBCharacterSolver(HIKCharacterHost<HIKHostNodeMB,HIKHostPropertyMB> &pHIKCharacterHost, FBCharacterSolver* pCharacterSolver, FBConstraint* pConstraint, bool pFloorContacts=false);
void HIKControlRigHostFromFBCharacterSolver(HIKControlRigHost<HIKHostNodeMB> &pHIKControlRigHost, FBCharacterSolver* pCharacterSolver, FBControlSet* pControlSet, FBConstraint* pConstraint);
void HIKCharacterHostFromFBCharacterPose(HIKCharacterHost<HIKHostNodeMB,HIKHostPropertyMB> &pHIKCharacterHost, FBCharacter* pPoseCharacter, FBCharacterPose* pPose);
// characterization - return valid HIK character
void HIKCharacterFromFBCharacter(HIKCharacterHost<HIKHostNodeMB,HIKHostPropertyMB> &pHIKCharacterHost,HIKCharacter*& pHIKCharacter,FBCharacter* pCharacter);
void HIKCharacterFromFBCharacterSolver(HIKCharacterHost<HIKHostNodeMB,HIKHostPropertyMB> &pHIKCharacterHost,HIKCharacter*& pHIKCharacter, FBCharacterSolver* pCharacterSolver);
void HIKCharacterFromFBActor(HIKCharacter*& pHIKActorCharacter, FBActor* pActor);
void HIKCharacterFromFBCharacterPose(HIKCharacterHost<HIKHostNodeMB,HIKHostPropertyMB> &pHIKCharacterHost,HIKCharacter*& pHIKCharacter,FBCharacter* pPoseCharacter, FBCharacterPose* pPose);
void UndoSetup(FBCharacter* pCharacter);
void ResetControRigModelTransformation( HIKCharacter *pHIKCharacter, HIKEvaluationState* pStanceState, HIKNodeId pNodeId, FBModel* pModel );
void SetNormalizedNodeStateForHierarchy( HIKCharacter *pHIKCharacter, HIKCharacterState *pState, KHIKNodeState pDataSet[LastNodeId], HIKNodeId pNodeId,
FBTVector *pT, FBQuaternion *pQ, FBVector4d *pS, bool pGlobal );
inline void CopyNormalizedState(KHIKNodeState pDstDataSet[LastNodeId], KHIKNodeState pSrcDataSet[LastNodeId], HIKNodeId pNodeId)
{
//kxl: optimize this, we can simply memcpy
pDstDataSet[pNodeId].mTfv[0] = pSrcDataSet[pNodeId].mTfv[0];
pDstDataSet[pNodeId].mTfv[1] = pSrcDataSet[pNodeId].mTfv[1];
pDstDataSet[pNodeId].mTfv[2] = pSrcDataSet[pNodeId].mTfv[2];
pDstDataSet[pNodeId].mTfv[3] = pSrcDataSet[pNodeId].mTfv[3];
pDstDataSet[pNodeId].mQfv[0] = pSrcDataSet[pNodeId].mQfv[0];
pDstDataSet[pNodeId].mQfv[1] = pSrcDataSet[pNodeId].mQfv[1];
pDstDataSet[pNodeId].mQfv[2] = pSrcDataSet[pNodeId].mQfv[2];
pDstDataSet[pNodeId].mQfv[3] = pSrcDataSet[pNodeId].mQfv[3];
pDstDataSet[pNodeId].mSfv[0] = pSrcDataSet[pNodeId].mSfv[0];
pDstDataSet[pNodeId].mSfv[1] = pSrcDataSet[pNodeId].mSfv[1];
pDstDataSet[pNodeId].mSfv[2] = pSrcDataSet[pNodeId].mSfv[2];
pDstDataSet[pNodeId].mSfv[3] = pSrcDataSet[pNodeId].mSfv[3];
}
inline void HIKFillCharacterDescription(HIKCharacter* pHIKCharacter, int* pNodeIdDesc)
{
for(int lNodeCounter = 0 ; lNodeCounter < LastNodeId ; lNodeCounter++)
{
if( HIKGetNodeUse(pHIKCharacter, lNodeCounter) )
{
pNodeIdDesc[lNodeCounter] = lNodeCounter;
}
else
{
pNodeIdDesc[lNodeCounter] = HIKNotUsed;
}
}
pNodeIdDesc[LastNodeId] = HIKLastNode;
}
inline void HIKEffectorStateCopy(HIKEffectorSetState* pDst, const HIKEffectorSetState* pSrc)
{
double lT[4];
double lQ[4];
double lS[4];
for(int lIter = HipsEffectorId; lIter < LastEffectorId; lIter++)
{
HIKGetEffectorStateTQSdv(pSrc, lIter, lT, lQ, lS );
HIKSetEffectorStateTQSdv(pDst, lIter, lT, lQ, lS );
}
}
inline void HIKEffectorStateWithOptionsCopy(HIKEffectorSetState* pDst, const HIKEffectorSetState* pSrc)
{
double lT[4];
double lQ[4];
double lS[4];
for(int lIter = HipsEffectorId; lIter < LastEffectorId; lIter++)
{
HIKSetRotationActive(pDst, lIter, HIKGetRotationActive(pSrc, lIter));
HIKSetPull(pDst, lIter, HIKGetPull(pSrc, lIter));
HIKSetResist(pDst, lIter, HIKGetResist(pSrc, lIter));
HIKGetEffectorStateTQSdv(pSrc, lIter, lT, lQ, lS );
HIKSetEffectorStateTQSdv(pDst, lIter, lT, lQ, lS );
}
for(int lFloorIter = 0; lFloorIter < HIKLastFloorId; lFloorIter++)
{
HIKGetEffectorFloorStateTQdv(pSrc,lFloorIter,lT, lQ);
HIKSetEffectorFloorStateTQdv(pDst,lFloorIter,lT, lQ);
}
HIKSetHandPullHips(pDst, true, HIKGetHandPullHips(pSrc, true));
HIKSetHandPullHips(pDst, false, HIKGetHandPullHips(pSrc, false));
}
#endif // __HIKHOSTMB__H_