KFbxVertexCacheDeformer Class Reference

This reference page is linked to from the following overview topics: List of Python FBX classes.

---

Search for all occurrences

---

Detailed Description

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

Examples:

ExportScene03/main.cxx, ViewScene/DrawScene.cxx, and ViewScene/InitScene.cxx.

Definition at line 52 of file kfbxvertexcachedeformer.h.

#include <kfbxvertexcachedeformer.h>

Inheritance diagram for KFbxVertexCacheDeformer:

List of all members.

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.
void	SetCacheSetName (const char *pCacheSetName)
	Set the cache set name.
KString	GetCacheSetName () const
	Get the name of point cache set.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
Static Public Attributes
static const char *	sChannelPropertyName
static const char *	sActivePropertyName
static const char *	sCacheSetPropertyName
Protected Member Functions
	KFbxVertexCacheDeformer (KFbxSdkManager &pManager, char const *pName)
virtual bool	ConstructProperties (bool pForceSet)
virtual KStringList	GetTypeFlags () const
Properties
KFbxTypedProperty< fbxBool1 >	Active
KFbxTypedProperty< fbxString >	Channel
KFbxTypedProperty< fbxString >	CacheSet

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

void SetCache

(

KFbxCache *

pCache

)

Search for all occurrences

Assign a cache object to be used by this deformer.

Parameters:

pCache

The cache object.

Examples:

ExportScene03/main.cxx.

KFbxCache* GetCache

(

)

const

Search for all occurrences

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.

Examples:

ExportScene03/main.cxx, ViewScene/DrawScene.cxx, and ViewScene/InitScene.cxx.

void SetCacheChannel

(

const char *

pName

)

Search for all occurrences

Select the cache channel by name.

Parameters:

pName

The name of channel to use within the cache object.

Examples:

ExportScene03/main.cxx.

KString GetCacheChannel

(

)

const

Search for all occurrences

Get the name of the selected channel.

Returns:

The name of the selected channel within the cache object.

Examples:

ViewScene/DrawScene.cxx.

void SetActive

(

bool

pValue

)

Search for all occurrences

Activate the deformer.

Parameters:

pValue

Set to true to enable the deformer.

Examples:

ExportScene03/main.cxx, and ViewScene/InitScene.cxx.

bool IsActive

(

)

const

Search for all occurrences

Indicate if the deformer is active or not.

Returns:

The current state of the deformer.

Examples:

ViewScene/InitScene.cxx.

virtual EDeformerType GetDeformerType

(

)

const [inline, virtual]

Search for all occurrences

Get the deformer type.

Returns:

Deformer type identifier.

Reimplemented from KFbxDeformer.

Definition at line 91 of file kfbxvertexcachedeformer.h.

{ return KFbxDeformer::eVERTEX_CACHE; }

void SetCacheSetName

(

const char *

pCacheSetName

)

Search for all occurrences

Set the cache set name.

Parameters:

pCacheSetName

The point cache set name.

Remarks:

It's only internally used by Maya/3ds Max plugin.

KString GetCacheSetName

(

)

const

Search for all occurrences

Get the name of point cache set.

Returns:

The name of point cache set.

Remarks:

It's only internally used by Maya/3ds Max plugin.

virtual KFbxObject& Copy

(

const KFbxObject &

pObject

)

[virtual]

Search for all occurrences

Copy an object content into this object.

Parameters:

pObject

The source object to copy data from.

Returns:

Returns the destination object being modified by the source.

Remarks:

This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

Reimplemented from KFbxObject.

virtual bool ConstructProperties

(

bool

pForceSet

)

[protected, virtual]

Search for all occurrences

Reimplemented from KFbxObject.

virtual KStringList GetTypeFlags

(

)

const [protected, virtual]

Search for all occurrences

Reimplemented from KFbxDeformer.

---

Member Data Documentation

KFbxTypedProperty<fbxBool1> Active [protected]

Search for all occurrences

Definition at line 98 of file kfbxvertexcachedeformer.h.

KFbxTypedProperty<fbxString> Channel [protected]

Search for all occurrences

Definition at line 99 of file kfbxvertexcachedeformer.h.

KFbxTypedProperty<fbxString> CacheSet [protected]

Search for all occurrences

Definition at line 100 of file kfbxvertexcachedeformer.h.

const char* sChannelPropertyName [static]

Search for all occurrences

Definition at line 128 of file kfbxvertexcachedeformer.h.

const char* sActivePropertyName [static]

Search for all occurrences

Definition at line 129 of file kfbxvertexcachedeformer.h.

const char* sCacheSetPropertyName [static]

Search for all occurrences

Definition at line 130 of file kfbxvertexcachedeformer.h.

---

The documentation for this class was generated from the following file:

• fbxfilesdk/kfbxplugins/kfbxvertexcachedeformer.h