FBX SDK Reference Guide: kfbxnurb.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_NURB_H_
00005 #define _FBXSDK_NURB_H_
00006 
00007 /**************************************************************************************
00008 
00009  Copyright  2001 - 2008 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 
00042 #include <kaydaradef.h>
00043 #ifndef KFBX_DLL
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <kaydara.h>
00048 
00049 #include <kfbxplugins/kfbxgeometry.h>
00050 
00051 #include <fbxfilesdk_nsbegin.h>
00052 
00053 class KFbxPatch;
00054 class KFbxSdkManager;
00055 
00056 
00066 class KFBX_DLL KFbxNurb : public KFbxGeometry
00067 {
00068     KFBXOBJECT_DECLARE(KFbxNurb,KFbxGeometry);
00069 public:
00071     virtual EAttributeType GetAttributeType() const;
00072 
00074     void Reset();
00075 
00080 
00084     void SetSurfaceMode(KFbxGeometry::ESurfaceMode pMode);
00085 
00089     inline ESurfaceMode GetSurfaceMode() const {return mSurfaceMode;}
00090 
00096     typedef enum
00097     {
00098         ePERIODIC,
00099         eCLOSED,
00100         eOPEN
00101     } ENurbType;
00102 
00111     void InitControlPoints(int pUCount, ENurbType pUType, int pVCount, ENurbType pVType);
00112 
00116     inline int GetUCount() const {return mUCount;}
00117 
00121     inline int GetVCount() const {return mVCount;}
00122 
00126     inline ENurbType GetNurbUType() const {return mUType;}
00127 
00131     inline ENurbType GetNurbVType() const {return mVType;}
00132 
00136     int GetUKnotCount() const;
00137 
00141     double* GetUKnotVector() const;
00142 
00146     int GetVKnotCount() const;
00147 
00151     double* GetVKnotVector() const;
00152 
00158     int* GetUMultiplicityVector() const;
00159 
00165     int* GetVMultiplicityVector() const;
00166 
00171     void SetOrder(kUInt pUOrder, kUInt pVOrder);
00172 
00176     inline int GetUOrder() const {return mUOrder;}
00177 
00181     inline int GetVOrder() const {return mVOrder;}
00182 
00188     void SetStep(int pUStep, int pVStep);
00189 
00193     inline int GetUStep() const {return mUStep;}
00194 
00198     inline int GetVStep() const {return mVStep;}
00199 
00204     int GetUSpanCount() const;
00205 
00210     int GetVSpanCount() const;
00211 
00213 
00218 
00222     void SetApplyFlipUV(bool pFlag);
00223 
00227     bool GetApplyFlipUV() const;
00228 
00232     void SetApplyFlipLinks(bool pFlag);
00233 
00237     bool GetApplyFlipLinks() const;
00238 
00242     bool GetApplyFlip() const { return GetApplyFlipUV() || GetApplyFlipLinks(); }
00243 
00245 
00247 //
00248 //  WARNING!
00249 //
00250 //  Anything beyond these lines may not be documented accurately and is
00251 //  subject to change without notice.
00252 //
00254 
00255 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00256 
00257 public:
00258 
00259     // Clone
00260     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType = eDEEP_CLONE) const;
00261 
00262 protected:
00263 
00264     KFbxNurb(KFbxSdkManager& pManager, char const* pName);
00265     virtual ~KFbxNurb();
00266 
00267     virtual void Destruct(bool pRecursive, bool pDependents);
00268 
00270     KFbxNurb& operator=(KFbxNurb const& pNurb);
00271 
00272     virtual KString     GetTypeName() const;
00273     virtual KStringList GetTypeFlags() const;
00274 
00275     kUInt mUOrder, mVOrder;
00276     int mUCount, mVCount;
00277     int mUStep, mVStep;
00278     ENurbType mUType, mVType;
00279 
00280     double* mUKnotVector;
00281     double* mVKnotVector;
00282 
00283     int* mUMultiplicityVector;
00284     int* mVMultiplicityVector;
00285 
00286     ESurfaceMode mSurfaceMode;
00287 
00288     // Export flags.
00289     bool mApplyFlipUV;
00290     bool mApplyFlipLinks;
00291 
00292     // Error identifiers, these are only used internally.
00293     typedef enum
00294     {
00295         eNurbTypeUnknown,
00296         eWrongNumberOfControlPoint,
00297         eWeightTooSmall,
00298         eUMultiplicityVectorError,
00299         eVMultiplicityVectorError,
00300         eUKnotVectorError,
00301         eVKnotVectorError,
00302         eErrorCount
00303     } EError;
00304 
00305     friend class KFbxReaderFbx;
00306     friend class KFbxReaderFbx6;
00307     friend struct KFbxReaderFbx7Impl;
00308     friend class KFbxWriterFbx;
00309     friend class KFbxWriterFbx6;
00310     friend struct KFbxWriterFbx7Impl;
00311     friend class KFbxGeometryConverter;
00312 
00313 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00314 
00315 };
00316 
00317 typedef KFbxNurb* HKFbxNurb;
00318 
00319 #include <fbxfilesdk_nsend.h>
00320 
00321 #endif // #ifndef _FBXSDK_NURB_H_
00322 
00323