kfbxpatch.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXPATCH_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXPATCH_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright (C) 2001 - 2010 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 #include <fbxfilesdk/fbxfilesdk_def.h>
00042 
00043 #include <fbxfilesdk/kfbxplugins/kfbxgeometry.h>
00044 
00045 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00046 
00047 class KFbxSdkManager;
00048 
00053 class KFBX_DLL KFbxPatch : public KFbxGeometry
00054 {
00055     KFBXOBJECT_DECLARE(KFbxPatch,KFbxGeometry);
00056 
00057 public:
00059     virtual EAttributeType GetAttributeType() const;
00060 
00062     void Reset();
00063 
00068 
00072         void SetSurfaceMode(KFbxGeometry::ESurfaceMode pMode);
00073 
00077         inline KFbxGeometry::ESurfaceMode GetSurfaceMode() const {return mSurfaceMode;}
00078 
00086         typedef enum
00087         {
00088             eBEZIER         = 0,
00089             eBEZIER_QUADRIC = 1,
00090             eCARDINAL       = 2,
00091             eBSPLINE        = 3,
00092             eLINEAR         = 4
00093         } EPatchType;
00094 
00101         void InitControlPoints(int pUCount, EPatchType pUType, int pVCount, EPatchType pVType);
00102 
00106         inline int GetUCount() const {return mUCount;}
00107 
00111         inline int GetVCount() const {return mVCount;}
00112 
00116         inline EPatchType GetPatchUType() const {return mUType;}
00117 
00121         inline EPatchType GetPatchVType () const {return mVType;}
00122 
00128         void SetStep(int pUStep, int pVStep);
00129 
00133         inline int GetUStep() const {return mUStep;}
00134 
00138         inline int GetVStep() const {return mVStep;}
00139 
00144         void SetClosed(bool pU, bool pV);
00145 
00149         inline bool GetUClosed() const {return mUClosed;}
00150 
00154         inline bool GetVClosed() const {return mVClosed;}
00155 
00162         void SetUCapped(bool pUBottom, bool pUTop);
00163 
00167         inline bool GetUCappedBottom() const {return mUCappedBottom;}
00168 
00172         inline bool GetUCappedTop() const {return mUCappedTop;}
00173 
00180         void SetVCapped(bool pVBottom, bool pVTop);
00181 
00185         inline bool GetVCappedBottom() const {return mVCappedBottom;}
00186 
00190         inline bool GetVCappedTop() const {return mVCappedTop;}
00191 
00193 
00203         virtual bool ContentWriteTo(KFbxStream& pStream) const;
00204 
00210         virtual bool ContentReadFrom(const KFbxStream& pStream);
00212 
00214 //
00215 //  WARNING!
00216 //
00217 //  Anything beyond these lines may not be documented accurately and is
00218 //  subject to change without notice.
00219 //
00221 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00222 
00223 #ifdef _DEBUG
00224     virtual int MemoryUsage() const;
00225 #endif
00226 
00227     virtual KFbxObject& Copy(const KFbxObject& pObject);
00228     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00229 
00230 protected:
00231     KFbxPatch(KFbxSdkManager& pManager, char const* pName);
00232 
00233     virtual void Destruct(bool pRecursive, bool pDependents);
00234 
00235     virtual KString     GetTypeName() const;
00236 
00237     EPatchType mUType, mVType;
00238     int mUCount, mVCount;
00239     int mUStep, mVStep;
00240     bool mUClosed, mVClosed;
00241     bool mUCappedBottom, mUCappedTop;
00242     bool mVCappedBottom, mVCappedTop;
00243 
00244     KFbxGeometry::ESurfaceMode mSurfaceMode;
00245 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00246 
00247 };
00248 
00249 typedef KFbxPatch* HKFbxPatch;
00250 
00251 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00252 
00253 #endif // FBXFILESDK_KFBXPLUGINS_KFBXPATCH_H
00254