fbconstraint.h

Go to the documentation of this file.

#ifndef __FBCONSTRAINT_H__
#define __FBCONSTRAINT_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>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

FB_DEFINE_COMPONENT( FBSDK_DLL, Constraint );

#define FBRegisterConstraint( UniqueNameStr, ClassName, Label, Description, IconFilename ) \
    HIObject RegisterConstraint##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,"Constraints",Label,Description,RegisterConstraint##ClassName##Create,true, IconFilename ); \
        FBRegisterObject( ClassName##R2,"FbxStorable/Constraint",UniqueNameStr,Description,RegisterConstraint##ClassName##Create,true, IconFilename ); \
    }

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

#define FBConstraintImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

// FBConstraintInfo
FB_FORWARD( FBConstraintInfo );

class FBSDK_DLL FBConstraintInfo 
{
public:
    bool GetSnapRequested();

    bool GetZeroRequested();
};

// FBConstraint
__FB_FORWARD( FBConstraint);

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

    IObject_Declare(K_IMPLEMENTATION);          // Interface to IObject

    virtual void ActiveChanged();               

    virtual void RemoveAllAnimationNodes();     
    virtual void SetupAllAnimationNodes();      

    virtual void SnapSuggested();               
    virtual void FreezeSuggested();             

    virtual bool Disable( FBModel* pModel );    

    virtual bool Enable( FBModel* pModel ); 

    virtual bool AnimationNodeNotify( FBAnimationNode* pAnimationNode, FBEvaluateInfo* pEvaluateInfo, FBConstraintInfo* pConstraintInfo );


    FBAnimationNode* AnimationNodeOutCreate ( kReference pUserId, FBModel* pModel, const char* pAttribute );
    FBAnimationNode* AnimationNodeInCreate  ( kReference pUserId, FBModel* pModel, const char* pAttribute );
    FBAnimationNode* AnimationNodeInCreate  ( kReference pUserId, FBProperty* pProperty );

    virtual void SaveModelState( FBModel* pModel, bool pS, bool pR, bool pT );

    virtual void RestoreModelState( FBModel* pModel );

    virtual void FreezeSRT( FBModel* pModel, bool pS, bool pR, bool pT );

    virtual FBConstraint* Clone();

    int ReferenceGroupGetCount();

    int ReferenceGroupAdd( const char* pGroupName, int pMaxItemCount );

    const char* ReferenceGroupGetName( int pGroupIndex );

    int ReferenceGroupGetMaxCount( int pGroupIndex );

    FBModel* ReferenceGet( int pGroupIndex, int pItemIndex=0 );

    int ReferenceGetCount( int pGroupIndex );

    bool ReferenceAdd( int pGroupIndex, FBModel* pModel );

    bool ReferenceRemove( int pGroupIndex, FBModel* pModel );

    void ReferenceRemoveAll();


    virtual bool ReferenceAddNotify     ( int pGroupIndex, FBModel* pModel );
    virtual bool ReferenceRemoveNotify  ( int pGroupIndex, FBModel* pModel );

    virtual bool DeformerPreNotify( FBModel* pModel, FBEvaluateInfo* pEvaluateInfo, FBVertex*  pBBoxMin,FBVertex*  pBBoxMax);

    virtual bool DeformerNotify(    FBModel* pModel, const FBVertex*  pSrcVertex, const FBVertex* pSrcNormal,
                                    int pCount, 
                                    FBVertex*  pDstVertex,FBVertex*  pDstNormal);


    virtual bool DeformerBind   ( FBModel* pModel );
    virtual bool DeformerUnBind ( FBModel* pModel );


    virtual bool FbxStore   ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );
    virtual bool FbxRetrieve( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );

    FBPropertyBool              Deformer;           
    FBPropertyBool              HasLayout;          
    FBPropertyString            Description;        

    FBPropertyBool              Active;             
    FBPropertyBool              Lock;               
    FBPropertyAction            Snap;               
    FBPropertyAnimatableDouble  Weight;             
};

// FBPropertyListConstraint
class FBSDK_DLL FBPropertyListConstraint : public FBPropertyListComponent
{
public:
    FBPropertyListConstraint();
    FBConstraint* operator[](int pIndex);
};

// FBPropertyListBox
__FB_FORWARD( FBBox ); 
__FB_FORWARD( FBPropertyListBox );
FB_DEFINE_LIST( FBSDK_DLL, Box );

class FBSDK_DLL FBPropertyListBox : public FBPropertyListComponentBase
{
public:
    int  Add( FBBox* pItem );
    virtual void RemoveAt( int pIndex );
    virtual FBBox* operator[](int pIndex);
    virtual int  GetCount();

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    inline virtual FBComponent* GetAt(int pIndex) { return (FBComponent*)operator[](pIndex); }
private:
    inline virtual int Add  ( FBComponent* pItem ) { return Add((FBBox*)pItem); }
#endif
};

// FBBoxPlaceHolder
FB_DEFINE_COMPONENT( FBSDK_DLL, Box );
__FB_FORWARD( FBBoxPlaceHolder );

class FBSDK_DLL FBBoxPlaceHolder : public FBBox {
    __FBClassDeclare( FBBoxPlaceHolder, FBBox );
public:
    FBBoxPlaceHolder(HIObject pObject);

    FBPropertyBox Box;      
};

// FBModelPlaceHolder
FB_FORWARD( FBModel );
__FB_FORWARD( FBModelPlaceHolder );

class FBSDK_DLL FBModelPlaceHolder : public FBBoxPlaceHolder {
    __FBClassDeclare( FBModelPlaceHolder, FBBoxPlaceHolder );
public:
    FBModelPlaceHolder(HIObject pObject);

    FBPropertyModel Model;                  
    FBPropertyBool  UseGlobalTransforms;    
};

// FBConstraintRelation
__FB_FORWARD( FBConstraintRelation);

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

    IObject_Declare(K_IMPLEMENTATION);          // Interface to IObject

    FBBox* SetAsSource    ( FBBox* pSource );

    FBBox* ConstrainObject( FBBox* pConstrainedObject ); // Receiver

    FBBox* CreateFunctionBox( const char* pGroup, const char* pName );

    bool GetBoxPosition( FBBox* pBox, int& pX, int& pY );

    bool SetBoxPosition( FBBox* pBox, int pX, int pY );

    FBPropertyListBox   Boxes;      
};

// FBConstraintSolver
FB_DEFINE_COMPONENT( FBSDK_DLL, ConstraintSolver );

#define FBRegisterConstraintSolver( UniqueNameStr, ClassName, Label, Description, IconFilename ) \
    HIObject RegisterConstraintSolver##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,"Browsing/Templates/Solvers",Label,Description,RegisterConstraintSolver##ClassName##Create,true, IconFilename ); \
        FBRegisterObject( ClassName##R2,"FbxStorable/Constraint",UniqueNameStr,Description,RegisterConstraintSolver##ClassName##Create,true, IconFilename ); \
    }

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

#define FBConstraintSolverImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

__FB_FORWARD( FBConstraintSolver );

class FBSDK_DLL FBConstraintSolver : public FBConstraint {
    __FBClassDeclare( FBConstraintSolver,FBConstraint );
public:

    FBConstraintSolver(const char* pName, HIObject pObject=NULL);

    static bool BackgroundEvaluate( FBModel* pModel, FBComponent* pTrackOrTake, FBTime pTime, FBVector3d& pT, FBVector3d& pR, FBVector3d& pS, FBEvaluateInfo* pEvaluateInfo = NULL, bool pGlobal = true );
    
    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 MultiThreaded( bool pActive );
    bool IsMultiThreaded();

    FBPropertyInt   SampleRecordingPrecision;           
    FBPropertyBool  SyncAnimationPlay;                  

    virtual void LiveChanged();
};

// FBPropertyListConstraintSolver
FB_FORWARD( FBPropertyListConstraintSolver );

class FBSDK_DLL FBPropertyListConstraintSolver : public FBPropertyListComponent
{
public:
    FBPropertyListConstraintSolver();
    FBConstraint* operator[](int pIndex);
};

// FBPhysicalProperties
FB_DEFINE_COMPONENT( FBSDK_DLL, PhysicalProperties );

#define FBRegisterPhysicalProperties( UniqueNameStr, ClassName, Label, Description, IconFilename ) \
    HIObject RegisterPhysicalProperties##ClassName##Create( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName(pName); \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
\
    FBLibraryModule( ClassName ) \
    {   \
        FBRegisterObject( ClassName##R1,"Browsing/Templates/Physical Properties",Label,Description,RegisterPhysicalProperties##ClassName##Create,true, IconFilename ); \
        FBRegisterObject( ClassName##R2,"FbxStorable/Physical Properties",UniqueNameStr,Description,RegisterPhysicalProperties##ClassName##Create,true, IconFilename ); \
    }

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

#define FBPhysicalPropertiesImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

__FB_FORWARD( FBPhysicalProperties );

class FBSDK_DLL FBPhysicalProperties : public FBBox {
    __FBClassDeclare( FBPhysicalProperties,FBBox );
public:

    FBPhysicalProperties(const char* pName, HIObject pObject=NULL);

};

// FBPropertyListPhysicalProperties
FB_DEFINE_LIST( FBSDK_DLL, PhysicalProperties );
FB_FORWARD( FBPropertyListPhysicalProperties );

class FBSDK_DLL FBPropertyListPhysicalProperties : public FBPropertyListComponent
{
public:
    FBPropertyListPhysicalProperties();
    FBPhysicalProperties* operator[](int pIndex);
};

// FBConstraintManager
__FB_FORWARD( FBConstraintManager );

class FBSDK_DLL FBConstraintManager : public FBComponent
{
    __FBClassDeclare( FBConstraintManager, FBComponent );
public:
    K_DEPRECATED_2014 FBConstraintManager();

    static FBConstraintManager& TheOne();

    const char*     TypeGetName             ( int pTypeIndex ) const;

    int             TypeGetCount            () const;

    FBConstraint* TypeCreateConstraint( int pTypeIndex );

    FBConstraint* TypeCreateConstraint( const char* pName );
};


#ifdef FBSDKUseNamespace
    }
#endif
#endif