kfbxvertexcachedeformer.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXVERTEXCACHEDEFORMER_H 
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXVERTEXCACHEDEFORMER_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/kfbxplugins/kfbxcache.h>
00045 
00046 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00047 
00052 class KFBX_DLL KFbxVertexCacheDeformer : public KFbxDeformer
00053 {
00054     KFBXOBJECT_DECLARE(KFbxVertexCacheDeformer,KFbxDeformer);
00055 
00056 public:
00057     
00061     void SetCache( KFbxCache* pCache );
00062 
00066     KFbxCache* GetCache() const;
00067 
00071     void SetCacheChannel( const char* pName );
00072 
00076     KString GetCacheChannel() const;
00077 
00081     void SetActive( bool pValue );
00082 
00086     bool IsActive() const;
00087 
00091     virtual EDeformerType GetDeformerType() const { return KFbxDeformer::eVERTEX_CACHE; }
00092 
00093 protected:
00098         KFbxTypedProperty<fbxBool1>     Active;
00099         KFbxTypedProperty<fbxString>    Channel;
00101 
00102 
00104 //
00105 //  WARNING!
00106 //
00107 //  Anything beyond these lines may not be documented accurately and is 
00108 //  subject to change without notice.
00109 //
00111 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00112 public:
00113     virtual KFbxObject& Copy(const KFbxObject& pObject);
00114     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00115 
00116     static const char* ChannelPropertyName;
00117     static const char* ActivePropertyName;
00118 
00119 protected:
00120     KFbxVertexCacheDeformer(KFbxSdkManager& pManager, char const* pName);
00121 
00122     virtual bool ConstructProperties(bool pForceSet);
00123 
00124     virtual KString     GetTypeName() const;
00125     virtual KStringList GetTypeFlags() const;
00126 
00127 private:
00128     void ClearCacheConnections();
00129 
00130 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00131 
00132 };
00133 
00134 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00135 
00136 #endif // FBXFILESDK_KFBXPLUGINS_KFBXVERTEXCACHEDEFORMER_H
00137