Detailed Description

Definition at line 51 of file kfbxcachedeffect.h.

#include <kfbxcachedeffect.h>

Inheritance diagram for KFbxCachedEffect:

Public Types
enum	ECategory { ePARTICLES, eFLUIDS, eHAIR, eGENERIC }
	Effect attribute category. More...
Public Member Functions
virtual EAttributeType	GetAttributeType () const
	Returns the EAttributeType::eCACHED_EFFECT attribute type.
ECategory	GetCategory () const
	Return the specialization category of this effect attribute as stored in the . (eGENERIC).
void	SetCache (KFbxCache *pCache, ECategory pCategory=eGENERIC)
	Assign a cache object to be used by this attribute.
KFbxCache *	GetCache () const
	Get the cache object used by this deformer.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
virtual const char *	GetTypeName () const
virtual KStringList	GetTypeFlags () const
Protected Member Functions
	KFbxCachedEffect (KFbxSdkManager &pManager, char const *pName)
virtual void	Construct (const KFbxCachedEffect *pFrom)
virtual bool	ConstructProperties (bool pForceSet)

Member Enumeration Documentation

enum ECategory

Search for all occurrences

Effect attribute category.

This is for identification purpose and has no influence inside the FBX SDK. However, applications may use this to filter KFbxCachedEffect objects.

Remarks:: Vertex caches for deforming geometries are not handled by the KFbxCachedEffect object. These caches are connected with the KFbxVertexCacheDeformer object.; If an object of this class is used as the default NodeAttribute for a KFbxNode and the scene is saved to an FBX v6 and earlier versions, the CachedEffect attribute is not saved and the KFbxNode will be processed as a KFbxNull node with default values for the attribute.

Enumerator:

ePARTICLES	This effect handles a particle cache. Search for all occurrences
eFLUIDS	This effect handles a fluid cache. Search for all occurrences
eHAIR	This effect handles an hair cache. Search for all occurrences
eGENERIC	This effect handles a cache other than particles, fluids or hair. Search for all occurrences

Definition at line 68 of file kfbxcachedeffect.h.

                 {
        ePARTICLES,             
        eFLUIDS,                
        eHAIR,                  
        eGENERIC                
    } ECategory;

Constructor & Destructor Documentation

KFbxCachedEffect	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

Member Function Documentation

virtual EAttributeType GetAttributeType ( ) const [virtual]

Search for all occurrences

Returns the EAttributeType::eCACHED_EFFECT attribute type.

Reimplemented from KFbxNodeAttribute.

ECategory GetCategory ( ) const

Search for all occurrences

Return the specialization category of this effect attribute as stored in the . (eGENERIC).

void SetCache	(	KFbxCache *	pCache,
		ECategory	pCategory = `eGENERIC`
	)

Search for all occurrences

Assign a cache object to be used by this attribute.

Parameters:

pCache	The cache object.
pCategory	The "purpose" of this cached effect.

Remarks:: The cache referenced by the pCache pointer can freely be shared among multiple KFbxCachedEffects (and even the KFbxVertexCacheDeformer) therefore pCategory identifier should really only used has a hint of what tis KFbxCachedEffect represents but it should not be taken for granted that the content of the cache really matches the category. Applications should always check the cache files to ensure that they are manipulating the desired information.

KFbxCache* GetCache ( ) const

Search for all occurrences

Get the cache object used by this deformer.