FBX SDK Reference Guide: kfbxvertexcachedeformer.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_VERTEX_CACHE_DEFORMER_H_ 
00005 #define _FBXSDK_VERTEX_CACHE_DEFORMER_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 <kaydaradef.h>
00043 #ifndef KFBX_DLL 
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <kaydara.h>
00048 #include <kfbxplugins/kfbxdeformer.h>
00049 #include <kfbxplugins/kfbxcache.h>
00050 
00051 #include <fbxfilesdk_nsbegin.h>
00052 
00057 class KFBX_DLL KFbxVertexCacheDeformer : public KFbxDeformer
00058 {
00059     KFBXOBJECT_DECLARE(KFbxVertexCacheDeformer,KFbxDeformer);
00060 
00061 public:
00062     
00066     void SetCache( KFbxCache* pCache );
00067 
00071     KFbxCache* GetCache() const;
00072 
00076     void SetCacheChannel( const char* pName );
00077 
00081     KString GetCacheChannel() const;
00082 
00086     void SetActive( bool pValue );
00087 
00091     bool IsActive() const;
00092 
00096     virtual EDeformerType GetDeformerType() const { return KFbxDeformer::eVERTEX_CACHE; }
00097 
00099     KFbxVertexCacheDeformer& operator = (KFbxVertexCacheDeformer const& pDeformer);
00100 
00101 protected:
00106         KFbxTypedProperty<fbxBool1>     Active;
00107         KFbxTypedProperty<fbxString>    Channel;
00109 
00110 
00112 //
00113 //  WARNING!
00114 //
00115 //  Anything beyond these lines may not be documented accurately and is 
00116 //  subject to change without notice.
00117 //
00119 
00120 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00121 
00122 public:
00123     static const char* ChannelPropertyName;
00124     static const char* ActivePropertyName;
00125 
00126 
00127     // Clone
00128     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00129 
00130 protected:
00131 
00132     KFbxVertexCacheDeformer(KFbxSdkManager& pManager, char const* pName);
00133     virtual ~KFbxVertexCacheDeformer();
00134 
00135     virtual bool ConstructProperties(bool pForceSet);
00136     virtual void Destruct(bool pRecursive, bool pDependents);
00137 
00138     virtual KString     GetTypeName() const;
00139     virtual KStringList GetTypeFlags() const;
00140 
00141     friend class KFbxReaderFbx;
00142     friend class KFbxReaderFbx6;
00143     friend class KFbxWriterFbx;
00144     friend class KFbxWriterFbx6;
00145 
00146 private:
00147     void ClearCacheConnections();
00148 
00149 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00150 
00151 };
00152 
00153 #include <fbxfilesdk_nsend.h>
00154 
00155 #endif // _FBXSDK_VERTEX_CACHE_DEFORMER_H_