KFbxVertexCacheDeformer Class Reference

#include <kfbxvertexcachedeformer.h>

Inheritance diagram for KFbxVertexCacheDeformer:

[legend]

List of all members.

---

Detailed Description

This class deforms control points of a geometry using control point positions stored in the associated cache object.

Definition at line 52 of file kfbxvertexcachedeformer.h.

Properties
KFbxTypedProperty< fbxBool1 >	Active
KFbxTypedProperty< fbxString >	Channel
Public Member Functions
void	SetCache (KFbxCache *pCache)
	Assign a cache object to be used by this deformer.
KFbxCache *	GetCache () const
	Get the cache object used by this deformer.
void	SetCacheChannel (const char *pName)
	Select the cache channel by name.
KString	GetCacheChannel () const
	Get the name of the selected channel.
void	SetActive (bool pValue)
	Activate the deformer.
bool	IsActive () const
	Indicate if the deformer is active or not.
virtual EDeformerType	GetDeformerType () const
	Get the deformer type.

---

Member Function Documentation

void SetCache

(

KFbxCache *

pCache

)

Assign a cache object to be used by this deformer.

Parameters:

pCache

The cache object.

KFbxCache* GetCache

(

)

const

Get the cache object used by this deformer.

Returns:

A pointer to the cache object used by this deformer, or NULL if no cache object is assigned.

void SetCacheChannel

(

const char *

pName

)

Select the cache channel by name.

Parameters:

pName

The name of channel to use within the cache object.

KString GetCacheChannel

(

)

const

Get the name of the selected channel.

Returns:

The name of the selected channel within the cache object.

void SetActive

(

bool

pValue

)

Activate the deformer.

Parameters:

pValue

Set to true to enable the deformer.

bool IsActive

(

)

const

Indicate if the deformer is active or not.

Returns:

The current state of the deformer.

virtual EDeformerType GetDeformerType

(

)

const [inline, virtual]

Get the deformer type.

Returns:

Deformer type identifier.

Reimplemented from KFbxDeformer.

Definition at line 91 of file kfbxvertexcachedeformer.h.

References KFbxDeformer::eVERTEX_CACHE.

---

Member Data Documentation

KFbxTypedProperty<fbxBool1> Active [protected]

Definition at line 98 of file kfbxvertexcachedeformer.h.

KFbxTypedProperty<fbxString> Channel [protected]

Definition at line 99 of file kfbxvertexcachedeformer.h.