kfbxskin.h

Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_SKIN_H_
00005 #define _FBXSDK_SKIN_H_
00006 
00007 /**************************************************************************************
00008 
00009  Copyright © 2001 - 2007 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/kfbxdeformer.h>
00050 #include <kfbxmath/kfbxmatrix.h>
00051 #include <kfbxplugins/kfbxgroupname.h>
00052 
00053 #include <klib/kerror.h>
00054 
00055 #include <kbaselib_forward.h>
00056 
00057 #include <fbxfilesdk_nsbegin.h>
00058 
00059 class KFbxSdkManager; 
00060 class KFbxGeometry;
00061 class KFbxCluster;
00062 class KFbxNode;
00063 
00064 class KFBX_DLL KFbxSkin : public KFbxDeformer
00065 {
00066     KFBXOBJECT_DECLARE(KFbxSkin);
00067 
00068 public:
00072     void SetDeformAccuracy(double pDeformAccuracy);
00073 
00077     double GetDeformAccuracy() const;
00078 
00083     bool SetNode(KFbxNode* pNode);
00084 
00088     KFbxNode* GetNode();
00089 
00094     bool SetGeometry(KFbxGeometry* pGeometry);
00095 
00099     KFbxGeometry* GetGeometry();
00100 
00105     bool AddCluster(KFbxCluster* pCluster);
00106 
00111     KFbxCluster* RemoveCluster(KFbxCluster* pCluster);
00112 
00116     int GetClusterCount() const;
00117 
00122     KFbxCluster* GetCluster(int pIndex);
00123 
00128     KFbxCluster const* GetCluster(int pIndex) const;
00129 
00133     EDeformerType GetDeformerType()  const {return eSKIN; };
00134 
00136 //
00137 //  WARNING!
00138 //
00139 //  Anything beyond these lines may not be documented accurately and is 
00140 //  subject to change without notice.
00141 //
00143 
00144 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00145 
00146     // Clone
00147     virtual KFbxObject* Clone(KFbxObject::ECloneType pCloneType) const;
00148 
00149 protected:
00150     static char const* GetNamePrefix() { return DEFORMER_PREFIX; }
00151 
00152     KFbxSkin(KFbxSdkManager& pManager, char const* pName);
00153     virtual ~KFbxSkin();
00154 
00155     virtual void Destruct(bool pRecursive, bool pDependents);
00156 
00158     KFbxSkin& operator = (KFbxSkin const& pSkin);
00159 
00160     virtual KString     GetTypeName() const;
00161     virtual KStringList GetTypeFlags() const;
00162 
00163     // Properties Handler
00164     virtual KObject* GetFbxObject_internal();
00165     virtual KObject const*  GetFbxObject_internal() const;
00166 
00167     // Skin deformer
00168     double mDeformAccuracy;
00169 
00170     friend class KFbxReaderFbx;
00171     friend class KFbxReaderFbx6;
00172     friend class KFbxWriterFbx;
00173     friend class KFbxWriterFbx6;
00174     friend class KFbxScene;
00175 
00176 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00177 };
00178 
00179 typedef KFbxSkin* HKFbxSkin;
00180 
00181 #include <fbxfilesdk_nsend.h>
00182 
00183 #endif // _FBXSDK_SKIN_H_
00184 
00185