fbxvertexcachedeformer.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2013 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_SCENE_GEOMETRY_VERTEX_CACHE_DEFORMER_H_
#define _FBXSDK_SCENE_GEOMETRY_VERTEX_CACHE_DEFORMER_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/scene/geometry/fbxdeformer.h>
#include <fbxsdk/scene/geometry/fbxcache.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FBXSDK_DLL FbxVertexCacheDeformer : public FbxDeformer
{
    FBXSDK_OBJECT_DECLARE(FbxVertexCacheDeformer, FbxDeformer);

public:
    
    void SetCache( FbxCache* pCache );

    FbxCache* GetCache() const;

    void SetCacheChannel( const char* pName );

    FbxString GetCacheChannel() const;

    void SetActive( bool pValue );

    bool IsActive() const;

    virtual EDeformerType GetDeformerType() const { return FbxDeformer::eVertexCache; }

protected:
        FbxPropertyT<FbxBool>       Active;
        FbxPropertyT<FbxString> Channel;
        FbxPropertyT<FbxString>    CacheSet;

/*****************************************************************************************************************************
** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
*****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
    void SetCacheSetName(const char*  pCacheSetName);
    FbxString GetCacheSetName() const;

    virtual FbxObject& Copy(const FbxObject& pObject);
    
    static const char* sChannelPropertyName;
    static const char* sActivePropertyName;
    static const char* sCacheSetPropertyName;
    
protected:
    virtual void ConstructProperties(bool pForceSet);

    virtual FbxStringList   GetTypeFlags() const;

private:
    void ClearCacheConnections();
#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_GEOMETRY_VERTEX_CACHE_DEFORMER_H_ */