kfbxgeometry.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXGEOMETRY_H
#define FBXFILESDK_KFBXPLUGINS_KFBXGEOMETRY_H

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

 Copyright (C) 2001 - 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 <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
#include <fbxfilesdk/components/kbaselib/kaydara.h>

#include <fbxfilesdk/kfbxplugins/kfbxgeometrybase.h>
#include <fbxfilesdk/kfbxplugins/kfbxdeformer.h>

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

#include <fbxfilesdk/components/kfcurve/kfcurve_forward.h>

#include <fbxfilesdk/kfbxmath/kfbxxmatrix.h>
#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxGeometryWeightedMap;
class KFbxNode;
class KFbxShape;
class KFbxTexture;
class KFbxSdkManager;
class KFbxVector4;
class KFbxTakeNode;
class KFbxScene;
class KFbxCluster;
typedef class KFbxCluster KFbxLink;

class KFBX_DLL KFbxGeometry : public KFbxGeometryBase
{
    KFBXOBJECT_DECLARE(KFbxGeometry,KFbxGeometryBase);

public:
    virtual EAttributeType GetAttributeType() const;


    int AddDeformer(KFbxDeformer* pDeformer);

    int GetDeformerCount() const;

    KFbxDeformer* GetDeformer(int pIndex) const;

    int GetDeformerCount(KFbxDeformer::EDeformerType pType) const;

    KFbxDeformer* GetDeformer(int pIndex, KFbxDeformer::EDeformerType pType) const;



    KFbxGeometryWeightedMap* GetSourceGeometryWeightedMap();

    int GetDestinationGeometryWeightedMapCount();

    KFbxGeometryWeightedMap* GetDestinationGeometryWeightedMap(int pIndex);



    virtual int AddShape(KFbxShape* pShape, char const* pShapeName);

    virtual void ClearShape();

    virtual int GetShapeCount() const;

    virtual KFbxShape* GetShape(int pIndex);

    virtual KFbxShape const* GetShape(int pIndex) const;

    virtual char const* GetShapeName(int pIndex) const;

    virtual KFCurve* GetShapeChannel(char const* pShapeName, bool pCreateAsNeeded = false, char const* pTakeName = NULL);

    virtual KFCurve* GetShapeChannel(int pIndex, bool pCreateAsNeeded = false, char const* pTakeName = NULL);


    typedef enum
    {
        eRAW,
        eLOW_NO_NORMALS,
        eLOW,
        eHIGH_NO_NORMALS,
        eHIGH
    } ESurfaceMode;


    KFbxXMatrix& GetPivot(KFbxXMatrix& pXMatrix) const;

    void SetPivot(KFbxXMatrix& pXMatrix);

    void ApplyPivot();



    void SetDefaultShape(int pIndex, double pPercent);
    void SetDefaultShape(char const* pShapeName, double pPercent);

    double GetDefaultShape(int pIndex);
    double GetDefaultShape(char const* pShapeName);



    KError& GetError ();

    typedef enum
    {
        eINDEX_OUT_OF_RANGE,
        eNULL_PARAMETER,
        eMATERIAL_NOT_FOUND,
        eMATERIAL_ALREADY_ADDED,
        eTEXTURE_NOT_FOUND,
        eTEXTURE_ALREADY_ADDED,
        eSHAPE_ALREADY_ADDED,
        eSHAPE_INVALID_NAME,
        eSHAPE_NAME_CLASH,
        eSHAPE_NO_CURVE_FOUND,
        eUNKNOWN_ERROR,
        eERROR_COUNT
    } EError;

    EError GetLastErrorID() const;

    const char* GetLastErrorString() const;


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

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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

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

    KFbxGeometry& operator=(KFbxGeometry const& pGeometry);

    virtual void Destruct(bool pRecursive, bool pDependents);

    virtual void SetDocument(KFbxDocument* pDocument);

    virtual void SetNode(KFbxNode& pNode);

    virtual void UnsetNode();

    bool AddShapeChannel(KString pTakeNodeName, int pShapeIndex);

    bool RemoveShapeChannel(KString pTakeNodeName, int pShapeIndex);

public:
    // MotionBuilder 4.01 and earlier versions saved nurb and patch shape channel names
    // following the template "Shape 0x (Shape)" where x is the index of the shape starting
    // at 1. Since then, Jori modified shape channels to turn them into animated properties.
    // As a result, nurb and patch shape channel names are now saved following the template
    // "<shape name> (Shape)". The FBX SDK keeps the old shape channel naming scheme but has
    // been modifed to handle the new one and convert shape channel names to the old shape
    // channel naming scheme.
    void CleanShapeChannels(KString pTakeNodeName);
    void CleanShapeChannel(KString pTakeNodeName, int pShapeIndex);

protected:
    // Shape channel name creation for nurb and patch.
    KString CreateShapeChannelName(int pShapeIndex);

    // Shape channel name creation for mesh.
    KString CreateShapeChannelName(KString pShapeName);

    void CreateShapeChannelProperties(KString& pShapeName);

public:
    void ConvertShapeNamesToV5Format(KString pTakeNodeName);
    void ConvertShapeNamesToV5Format(KString pTakeNodeName, int pShapeIndex);
    void RevertShapeNamesToV6Format(KString pTakeNodeName);
    void RevertShapeNamesToV6Format(KString pTakeNodeName, int pShapeIndex);
    void ClearTemporaryShapeNames();

protected:
    KFbxDeformer* RemoveDeformer(int pIndex);

    // This function implies renaming shape channels. The decision has been made to avoid changing
    // KFCurveNode interface to allow renaming.
    // KFbxShape* RemoveShape(int pIndex);

    void CopyDeformers(KFbxGeometry const* pGeometry);
    void CopyShapes(KFbxGeometry const* pGeometry);

    void CopyPivot(KFbxGeometry const* pSource);

    KArrayTemplate <KFbxShape*> mShapeArray;

    KArrayTemplate <KString*> mShapeNameArray;

    // Used during FBX v5 file store
    KArrayTemplate<KString*> mShapeNameArrayV6;
    KArrayTemplate<KString*> mShapeNameArrayV5;
    KArrayTemplate<KString*> mShapeChannelNameArrayV5;

    KFbxXMatrix* mPivot;


    mutable KError mError;

    friend class KFbxScene;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXGEOMETRY_H