fbcharactersolver.h

Go to the documentation of this file.

#ifndef __FBCHARACTERSOLVER_H__
#define __FBCHARACTERSOLVER_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.
 
 The coded instructions, statements, computer programs, and/or related 
 material (collectively the "Data") in these files contain unpublished 
 information proprietary to Autodesk, Inc. and/or its licensors, 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, Inc. 
 ("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.
 
**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

    #define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbcore.h>
#if !defined(K_NO_MANIPULATOR)
    #include <fbsdk/fbcharactermanipulator.h>
#endif
#include <fbsdk/fbcharacter.h>
#include <fbsdk/fbcharacterpose.h>
#include <fbsdk/fbobjectpose.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

FB_DEFINE_COMPONENT( FBSDK_DLL, CharacterSolver );

#define FBRegisterCharacterSolver( UniqueNameStr, ClassName, Label, Description, IconFilename ) \
    HIObject RegisterCharacterSolver##ClassName##Create( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName(pName); \
        Class->UniqueName = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
\
    FBLibraryModule( ClassName ) \
    {   \
        FBRegisterObject( ClassName##R1,"FbxStorable/CharacterSolver",UniqueNameStr,Description,RegisterCharacterSolver##ClassName##Create, true, IconFilename ); \
        FBRegisterObject( ClassName##R2,"Character/Solvers",UniqueNameStr,Description,RegisterCharacterSolver##ClassName##Create,true, IconFilename ); \
    }

#define FBCharacterSolverDeclare( ClassName, Parent ) \
    FBClassDeclare( ClassName, Parent ); \
  public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
  private:

#define FBCharacterSolverImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

// FBConstraint
__FB_FORWARD( FBCharacterSolver );
__FB_FORWARD( FBCharacterManipulatorCtrlSet );

class FBSDK_DLL FBCharacterSolver : public FBConstraint 
{
    __FBClassDeclare( FBCharacterSolver,FBConstraint );
public:
    FBCharacterSolver(const char* pName, HIObject pObject=NULL);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    IObject_Declare(K_IMPLEMENTATION);
#endif

    int mEvaluationId;                      
    FBPropertyCharacter TargetCharacter;    
    FBPropertyComponent Source;             

    FBEvaluateInfo* BackgroundEvaluateInfoBegin(FBEvaluateInfo* pSourceEvaluateInfo, bool pEvaluateCandidates=false);

    FBEvaluateInfo* BackgroundEvaluateInfoRecursiveBegin(FBEvaluateInfo* pSourceEvaluateInfo, bool pForceUpdateLocals=false);

    void            BackgroundEvaluateInfoEnd(FBEvaluateInfo* pBackgroundEvaluateInfo);

    bool            BackgroundEvaluateInfoNotify(FBEvaluateInfo* pBackgroundEvaluateInfo, kBackgroundEvaluationCallback pFunction, void* pCustomData=NULL);

    void            ResetConnectorSetup();
    
    virtual FBCharacterManipulatorCtrlSet* CreateCharacterManipulatorCtrlSet(const char* pName);

    virtual double  GetCharacterSolverVersion() { return 1.0; };
    
    virtual int         GetExtraFKCount() { return 0; }
    virtual const char* GetExtraFKNameAt(int pIndex) { return NULL; }
    virtual FBBodyPartId GetExtraFKBodyPartAt(int pIndex) { return kFBCtrlSetPartNone; }
    virtual int         GetExtraBoneCount() { return 0; }
    virtual const char* GetExtraBoneNameAt(int pIndex) { return NULL; }
    virtual FBBodyPartId GetExtraBoneBodyPartAt(int pIndex) { return kFBCtrlSetPartNone; }

    FBModel*    GetExtraBoneModelAt(int pIndex);
    FBModelMarker*    GetExtraFKModelAt(int pIndex);



    void    SetExtraBoneModelAt(FBModel* pModel, int pIndex);
    void    SetExtraFKModelAt(FBModelMarker* pModel, int pIndex);

    void ExtractOffsets();
    void GetTransformOffset( FBVector3d &pT, FBRVector &pR, FBSVector &pS, int pIndex );
    void SetTransformOffset( FBVector3d &pT, FBRVector &pR, FBSVector &pS, int pIndex );
    void GetParentRotationOffset( FBRVector &pR, int pIndex );
    void SetParentRotationOffset( FBRVector &pR, int pIndex );

    virtual void CharacterPasteState( FBCharacter* pFromCharacter, FBCharacterPose* pPose, FBCharacterPoseOptions& pCharacterPoseOptions) {}

    virtual void ResetExtraProperties() {};
    
    bool GetRigAlign();

    bool GetDoubleSolve();

    bool GetBlendAuxiliaryWithEffector();

    void SetBlendAuxiliaryWithEffector(bool pBlendAux);
};


// Registered Character Solver and Instanciation

FBSDK_DLL int FBGetCharacterExternalSolverCount();

FBSDK_DLL const char* FBGetCharacterExternalSolverName(int pIndex);

FBSDK_DLL int FBGetCharacterExternalSolverIndex(const char* pName);

FBSDK_DLL FBCharacterSolver* FBInstanciateCharacterExternalSolver(int pIndex, const char *pSolverName = NULL);



#ifdef FBSDKUseNamespace
    }
#endif
#endif