FBX SDK Reference Guide: kfbxnurb.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXNURB_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXNURB_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 <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
00043 #include <fbxfilesdk/components/kbaselib/kaydara.h>
00044 
00045 #include <fbxfilesdk/kfbxplugins/kfbxgeometry.h>
00046 
00047 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00048 
00049 class KFbxPatch;
00050 class KFbxSdkManager;
00051 
00052 
00062 class KFBX_DLL KFbxNurb : public KFbxGeometry
00063 {
00064     KFBXOBJECT_DECLARE(KFbxNurb,KFbxGeometry);
00065 public:
00067     virtual EAttributeType GetAttributeType() const;
00068 
00070     void Reset();
00071 
00076 
00080     void SetSurfaceMode(KFbxGeometry::ESurfaceMode pMode);
00081 
00085     inline ESurfaceMode GetSurfaceMode() const {return mSurfaceMode;}
00086 
00092     typedef enum
00093     {
00094         ePERIODIC,
00095         eCLOSED,
00096         eOPEN
00097     } ENurbType;
00098 
00107     void InitControlPoints(int pUCount, ENurbType pUType, int pVCount, ENurbType pVType);
00108 
00112     inline int GetUCount() const {return mUCount;}
00113 
00117     inline int GetVCount() const {return mVCount;}
00118 
00122     inline ENurbType GetNurbUType() const {return mUType;}
00123 
00127     inline ENurbType GetNurbVType() const {return mVType;}
00128 
00132     int GetUKnotCount() const;
00133 
00137     double* GetUKnotVector() const;
00138 
00142     int GetVKnotCount() const;
00143 
00147     double* GetVKnotVector() const;
00148 
00154     int* GetUMultiplicityVector() const;
00155 
00161     int* GetVMultiplicityVector() const;
00162 
00167     void SetOrder(kUInt pUOrder, kUInt pVOrder);
00168 
00172     inline int GetUOrder() const {return mUOrder;}
00173 
00177     inline int GetVOrder() const {return mVOrder;}
00178 
00184     void SetStep(int pUStep, int pVStep);
00185 
00189     inline int GetUStep() const {return mUStep;}
00190 
00194     inline int GetVStep() const {return mVStep;}
00195 
00200     int GetUSpanCount() const;
00201 
00206     int GetVSpanCount() const;
00207 
00209 
00214 
00218     void SetApplyFlipUV(bool pFlag);
00219 
00223     bool GetApplyFlipUV() const;
00224 
00228     void SetApplyFlipLinks(bool pFlag);
00229 
00233     bool GetApplyFlipLinks() const;
00234 
00238     bool GetApplyFlip() const { return GetApplyFlipUV() || GetApplyFlipLinks(); }
00239 
00241 
00243 //
00244 //  WARNING!
00245 //
00246 //  Anything beyond these lines may not be documented accurately and is
00247 //  subject to change without notice.
00248 //
00250 
00251 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00252 
00253 public:
00254 
00255     // Clone
00256     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType = eDEEP_CLONE) const;
00257 
00258 protected:
00259 
00260     KFbxNurb(KFbxSdkManager& pManager, char const* pName);
00261     virtual ~KFbxNurb();
00262 
00263     virtual void Destruct(bool pRecursive, bool pDependents);
00264 
00266     KFbxNurb& operator=(KFbxNurb const& pNurb);
00267 
00268     virtual KString     GetTypeName() const;
00269     virtual KStringList GetTypeFlags() const;
00270 
00271     kUInt mUOrder, mVOrder;
00272     int mUCount, mVCount;
00273     int mUStep, mVStep;
00274     ENurbType mUType, mVType;
00275 
00276     double* mUKnotVector;
00277     double* mVKnotVector;
00278 
00279     int* mUMultiplicityVector;
00280     int* mVMultiplicityVector;
00281 
00282     ESurfaceMode mSurfaceMode;
00283 
00284     // Export flags.
00285     bool mApplyFlipUV;
00286     bool mApplyFlipLinks;
00287 
00288 public:
00289     // Error identifiers, these are only used internally.
00290     typedef enum
00291     {
00292         eNurbTypeUnknown,
00293         eWrongNumberOfControlPoint,
00294         eWeightTooSmall,
00295         eUMultiplicityVectorError,
00296         eVMultiplicityVectorError,
00297         eUKnotVectorError,
00298         eVKnotVectorError,
00299         eErrorCount
00300     } EError;
00301 
00302 protected:
00303     friend class KFbxGeometryConverter;
00304 
00305 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00306 
00307 };
00308 
00309 typedef KFbxNurb* HKFbxNurb;
00310 
00311 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00312 
00313 #endif // FBXFILESDK_KFBXPLUGINS_KFBXNURB_H
00314