kfbxnurbscurve.h

Go to the documentation of this file.

#ifndef _FBXSDK_NURBS_CURVE_H_
#define _FBXSDK_NURBS_CURVE_H_
/**************************************************************************************

 Copyright © 2002 - 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/kfbxgeometry.h>

#include <fbxfilesdk_nsbegin.h>

class KFbxNurbsCurve_internal;

class KFBX_DLL KFbxNurbsCurve : public KFbxGeometry 
{
    KFBXOBJECT_DECLARE(KFbxNurbsCurve);
public:
    // inhierited from KFbxNodeAttribute
    virtual KFbxNodeAttribute::EAttributeType GetAttributeType() const;

    enum EDimension
    {
        e2D = 2,
        e3D,
        eDIMENSIONS_COUNT = 2
    };

    enum EType
    {
        eOPEN,
        eCLOSED,
        ePERIODIC,
        eTYPE_COUNT
    }; 

    void InitControlPoints( int pCount, EType pVType );

    inline double* GetKnotVector() const { return mKnotVector; }

    int GetKnotCount() const;

    // Sets the order of the curve
    // Must be set before InitControlPoints() is called. 
    inline void SetOrder( int pOrder ) { mOrder = pOrder; }

    inline int GetOrder() const { return mOrder; }

    inline void SetDimension( EDimension dim ) { mDimension = dim; }

    inline EDimension GetDimension() const { return mDimension; }

    inline K_DEPRECATED void SetRational( bool pRational ) { mIsRational = pRational; }

    bool IsRational(); 

    int GetSpanCount();

    inline EType GetType() const { return mNurbType; }

    inline bool IsPolyline() const { return ( GetOrder() == 2 ); }

    bool IsBezier();

    // step? 
    // Need to know multiplicity?

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

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

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

    bool FullMultiplicity();

protected:

    // Error identifiers, these are only used internally.
    typedef enum 
    {
        eNurbCurveTypeUnknown,
        eWeightTooSmall,
        eKnotVectorError,
        eWrongNumberOfControlPoint,

        /*
        
        eUMultiplicityVectorError,
        eVMultiplicityVectorError,
        ,
        eVKnotVectorError, */
        eErrorCount
    } EError;

    static char const* GetNamePrefix() { return 0; }
    
    KFbxNurbsCurve(KFbxSdkManager& pManager, char const* pName);
    virtual ~KFbxNurbsCurve();
    
    KFbxNurbsCurve& operator=(KFbxNurbsCurve const& pNurb);

    void Reset();

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

    virtual void Destruct(bool pRecursive, bool pDependents);

private:
    bool mIsRational;
    double* mKnotVector;
    EType mNurbType;
    int mOrder;
    EDimension mDimension; 

    // Internal Property Handler
    KFbxNurbsCurve_internal* mPH;


public:
    friend class KFbxReaderFbx;
    friend class KFbxReaderFbx6;
    friend class KFbxWriterFbx;
    friend class KFbxWriterFbx6;
};

typedef KFbxNurbsCurve* HKFbxNurbsCurve;
typedef class KFBX_DLL KArrayTemplate< KFbxNurbsCurve* > KArrayKFbxNurbsCurve;


#include <fbxfilesdk_nsend.h>

#endif //_FBXSDK_NURBS_CURVE_H_