kfbxcluster.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXCLUSTER_H
#define FBXFILESDK_KFBXPLUGINS_KFBXCLUSTER_H

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

 Copyright (C) 2001 - 2010 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 <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/kfbxplugins/kfbxsubdeformer.h>
#include <fbxfilesdk/kfbxplugins/kfbxgroupname.h>
#include <fbxfilesdk/kfbxmath/kfbxmatrix.h>

#include <fbxfilesdk/components/kbaselib/klib/kerror.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxSdkManager;
class KFbxNode;
class KFbxCluster_internal;

class KFBX_DLL KFbxCluster : public KFbxSubDeformer
{
    KFBXOBJECT_DECLARE(KFbxCluster,KFbxSubDeformer);

public:
    ESubDeformerType GetSubDeformerType() const {return eCLUSTER; };

    void Reset();

    typedef enum
    {
        eNORMALIZE,
        eADDITIVE,
        eTOTAL1
    } ELinkMode;

    void SetLinkMode(ELinkMode pMode);

    ELinkMode GetLinkMode() const;

    void SetLink(KFbxNode const* pNode);

    KFbxNode* GetLink();

    KFbxNode const* GetLink() const;

    void SetAssociateModel(KFbxNode *pNode);

    KFbxNode* GetAssociateModel() const;


    void AddControlPointIndex(int pIndex, double pWeight);

    int GetControlPointIndicesCount() const;

    int* GetControlPointIndices() const;

    double* GetControlPointWeights() const;


    void SetControlPointIWCount(int pCount);


    void SetTransformMatrix(const KFbxXMatrix& pMatrix);

    KFbxXMatrix& GetTransformMatrix(KFbxXMatrix& pMatrix) const;

    void SetTransformLinkMatrix(const KFbxXMatrix& pMatrix);

    KFbxXMatrix& GetTransformLinkMatrix(KFbxXMatrix& pMatrix) const;

    void SetTransformAssociateModelMatrix(const KFbxXMatrix& pMatrix);

    KFbxXMatrix& GetTransformAssociateModelMatrix(KFbxXMatrix& pMatrix) const;

    void SetTransformParentMatrix(const KFbxXMatrix& pMatrix);

    KFbxXMatrix& GetTransformParentMatrix(KFbxXMatrix& pMatrix) const;

    bool IsTransformParentSet() const { return mIsTransformParentSet; }


//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS

    virtual KFbxObject& Copy(const KFbxObject& pObject);
    virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;

protected:
    KFbxCluster(KFbxSdkManager& pManager, char const* pName);

    virtual void Construct(const KFbxCluster* pFrom);
    virtual bool ConstructProperties( bool pForceSet );

    virtual KString     GetTypeName() const;
    virtual KStringList GetTypeFlags() const;


  public:
    void SetUserData(KString pUserDataID, KString pUserData);

    KString GetUserDataID () const;

    KString GetUserData () const;

    KString GetUserData (KString pUserDataID) const;


protected:

    //  Cluster deformer
    ELinkMode               mLinkMode;
    KString                 mUserDataID;
    KString                 mUserData;
    KArrayTemplate<int>     mControlPointIndices;
    KArrayTemplate<double>  mControlPointWeights;
    KFbxMatrix              mTransform;
    KFbxMatrix              mTransformLink;
    KFbxMatrix              mTransformAssociate;
    KFbxMatrix              mTransformParent;
    bool                    mIsTransformParentSet;

public:
    // For pre version 6 support
    KString                 mBeforeVersion6LinkName;
    KString                 mBeforeVersion6AssociateModelName;

protected:
    // Properties
    KFbxTypedProperty<fbxReference> SrcModel;
    KFbxTypedProperty<fbxReference> SrcModelReference;

    friend class KFbxScene;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

typedef KFbxCluster* HKFbxCluster;

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXCLUSTER_H