kfbxskin.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXSKIN_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXSKIN_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/kfbxdeformer.h>
00044 #include <fbxfilesdk/kfbxmath/kfbxmatrix.h>
00045 #include <fbxfilesdk/kfbxplugins/kfbxgroupname.h>
00046 
00047 #include <fbxfilesdk/components/kbaselib/klib/kerror.h>
00048 
00049 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00050 
00051 class KFbxSdkManager;
00052 class KFbxGeometry;
00053 class KFbxCluster;
00054 class KFbxNode;
00055 
00060 class KFBX_DLL KFbxSkin : public KFbxDeformer
00061 {
00062     KFBXOBJECT_DECLARE(KFbxSkin,KFbxDeformer);
00063 
00064 public:
00068     void SetDeformAccuracy(double pDeformAccuracy);
00069 
00073     double GetDeformAccuracy() const;
00074 
00079     bool SetGeometry(KFbxGeometry* pGeometry);
00080 
00084     KFbxGeometry* GetGeometry();
00085 
00090     bool AddCluster(KFbxCluster* pCluster);
00091 
00096     KFbxCluster* RemoveCluster(KFbxCluster* pCluster);
00097 
00101     int GetClusterCount() const;
00102 
00107     KFbxCluster* GetCluster(int pIndex);
00108 
00113     KFbxCluster const* GetCluster(int pIndex) const;
00114 
00118     EDeformerType GetDeformerType()  const {return eSKIN; };
00119 
00128     typedef enum
00129     {
00130         eRIGID,
00131         eLINEAR,
00132         eDUALQUATERNION,
00133         eBLEND,
00134         eSKINNINGTYPE_COUNT
00135     } ESkinningType;
00136 
00140     void SetSkinningType(ESkinningType pType);
00141 
00145     ESkinningType GetSkinningType() const;
00146 
00155 
00163     void AddControlPointIndex(int pIndex, double pBlendWeight = 0);
00164 
00169     int GetControlPointIndicesCount() const;
00170 
00175     int* GetControlPointIndices() const;
00176 
00181     double* GetControlPointBlendWeights() const;
00182 
00187     void SetControlPointIWCount(int pCount);
00188 
00190 
00192 //
00193 //  WARNING!
00194 //
00195 //  Anything beyond these lines may not be documented accurately and is
00196 //  subject to change without notice.
00197 //
00199 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00200 
00201     virtual KFbxObject& Copy(const KFbxObject& pObject);
00202 
00203 protected:
00204     KFbxSkin(KFbxSdkManager& pManager, char const* pName);
00205 
00206     virtual KStringList GetTypeFlags() const;
00207 
00208     // Skin deformer
00209     double mDeformAccuracy;
00210     ESkinningType mSkinningType;
00211 
00212     //Control points
00213     KArrayTemplate<int>     mControlPointIndices;
00214     KArrayTemplate<double>  mControlPointBlendWeights;
00215 
00216     friend class KFbxScene;
00217 
00218 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00219 };
00220 
00221 typedef KFbxSkin* HKFbxSkin;
00222 
00223 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00224 
00225 #endif // FBXFILESDK_KFBXPLUGINS_KFBXSKIN_H
00226