kfbxnurbssurface.h

Go to the documentation of this file.

#ifndef _FBXSDK_NURBS_SURFACE_H_
#define _FBXSDK_NURBS_SURFACE_H_

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

 Copyright © 2001 - 2007 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 KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#include <kaydara.h>

#include <kfbxplugins/kfbxnode.h>
#include <kfbxplugins/kfbxgeometry.h>

#include <fbxfilesdk_nsbegin.h>

class KFbxPatch;
class KFbxSdkManager;
class KFbxNurbsSurface_internal;

class KFBX_DLL KFbxNurbsSurface : public KFbxGeometry 
{
    KFBXOBJECT_DECLARE(KFbxNurbsSurface);
public:
    virtual EAttributeType GetAttributeType() const { return KFbxNodeAttribute::eNURBS_SURFACE; }

    void Reset();


    void SetSurfaceMode(KFbxGeometry::ESurfaceMode pMode);

    inline ESurfaceMode GetSurfaceMode() const {return mSurfaceMode;}

    typedef enum 
    {
        ePERIODIC, 
        eCLOSED, 
        eOPEN 
    } ENurbType;

    void InitControlPoints(int pUCount, ENurbType pUType, int pVCount, ENurbType pVType);

    inline int GetUCount() const {return mUCount;}
    
    inline int GetVCount() const {return mVCount;}
    
    inline ENurbType GetNurbUType() const {return mUType;}
    
    inline ENurbType GetNurbVType() const {return mVType;}

    int GetUKnotCount() const;

    double* GetUKnotVector() const;
    
    int GetVKnotCount() const;

    double* GetVKnotVector() const;
    
    //int* GetUMultiplicityVector();
    
    //int* GetVMultiplicityVector();

    void SetOrder(kUInt pUOrder, kUInt pVOrder);

    inline int GetUOrder() const {return mUOrder;}
    
    inline int GetVOrder() const {return mVOrder;}

    void SetStep(int pUStep, int pVStep);

    inline int GetUStep() const {return mUStep;}
    
    inline int GetVStep() const {return mVStep;}

    /* Calculates the number of spans in the surface in the U direction.
     * See KFbxNurbsCurve::GetSpanCount() for more information.
     * \returns The number of spans in U if the surface has been initialized, -1 otherwise.
     */
    int GetUSpanCount() const;

    /* Calculates the number of spans in the surface in the V direction.
     * See KFbxNurbsCurve::GetSpanCount() for more information.
     * \returns The number of spans in V if the surface has been initialized, -1 otherwise.
     */
    int GetVSpanCount() const; 



    void SetApplyFlipUV(bool pFlag);

    bool GetApplyFlipUV() const;

    void SetApplyFlipLinks(bool pFlag);

    bool GetApplyFlipLinks() const;

    bool GetApplyFlip() const { return GetApplyFlipUV() || GetApplyFlipLinks(); }

    void AddCurveOnSurface( KFbxNode* pCurve );
    
    /* Retrieves a curve on this surface
     * \param pIndex Index of the curve to retrieve. Valid range is 0 to GetCurveOnSurfaceCount() - 1
     * \return The curve at the specified index, or NULL if pIndex is out of range.
     */
    KFbxNode* GetCurveOnSurface( int pIndex );
    KFbxNode const* GetCurveOnSurface( int pIndex ) const;

    /* \return The number of curves on this surface
     */
    int GetCurveOnSurfaceCount() const;
    
    /* Removes a curve from this surface.
     * \param pCurve The curve to remove
     * \return True if the curve was removed, false otherwise.
     */
    bool RemoveCurveOnSurface( KFbxNode* pCurve );


    bool IsRational();


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


#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:

    void SetFlipNormals(bool pFlipNormals);

    bool GetFlipNormals() const;


    virtual KObject*  GetFbxObject_internal();
    virtual KObject const*  GetFbxObject_internal() const;

    // Clone
    virtual KFbxObject* Clone(KFbxObject::ECloneType pCloneType = eDEEP_CLONE) const;

protected:

    static char const* GetNamePrefix() { return 0; }

    KFbxNurbsSurface(KFbxSdkManager& pManager, char const* pName);
    virtual ~KFbxNurbsSurface();

    virtual void Destruct(bool pRecursive, bool pDependents);

    KFbxNurbsSurface& operator=(KFbxNurbsSurface const& pNurb);

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

    kUInt mUOrder, mVOrder;
    int mUCount, mVCount;
    int mUStep, mVStep;
    ENurbType mUType, mVType;
    
    double* mUKnotVector;
    double* mVKnotVector;
    
    //int* mUMultiplicityVector;
    //int* mVMultiplicityVector;

    ESurfaceMode mSurfaceMode;

    // Export flags.
    bool mApplyFlipUV;
    bool mApplyFlipLinks;

    bool mFlipNormals;

    // Error identifiers, these are only used internally.
    typedef enum 
    {
        eNurbTypeUnknown,
        eWrongNumberOfControlPoint,
        eWeightTooSmall,
        //eUMultiplicityVectorError,
        //eVMultiplicityVectorError,
        eUKnotVectorError,
        eVKnotVectorError,
        eErrorCount
    } EError;

    // Internal Property Handler
    KFbxNurbsSurface_internal* mPH;
    
    friend class KFbxReaderFbx;
    friend class KFbxReaderFbx6;
    friend class KFbxWriterFbx;
    friend class KFbxWriterFbx6;
    friend class KFbxGeometryConverter;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

typedef KFbxNurbsSurface* HKFbxNurbsSurface;

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_NURBS_SURFACE_H_