KFbxDeformer Class Reference

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

---

Search for all occurrences

---

Detailed Description

Base class for skin deformer (KFbxSkin) and vertex cache deformer (KFbxVertexCacheDeformer).

The corresponding deformer types are KFbxDeformer::eSKIN and KFbxDeformer::eVERTEX_CACHE. A deformer can be binded to a geometry (KFbxGeometry) to act on its shape. Typically, some objects under the deformer are animated, and via the deformer, the geometry is animated too.

A skin deformer contains clusters (KFbxCluster). Each cluster acts on a subset of the geometry's control points, with different weights. For example, a mesh of humanoid shape can have a skin attached, that describes the way the humanoid mesh is deformed by bones. When the bones are animated, the clusters act on the geometry to animate it too.

A vertex cache deformer contains a cache (KFbxCache). The cache contains animation information for every control point of the geometry.

Definition at line 71 of file kfbxdeformer.h.

#include <kfbxdeformer.h>

Inheritance diagram for KFbxDeformer:

List of all members.

Protected Member Functions
	KFbxDeformer (KFbxSdkManager &pManager, char const *pName)
virtual KStringList	GetTypeFlags () const
Protected Attributes
KError	mError
bool	mMultiLayer
Friends
class	KFbxGeometry
class	KFbxScene
Multi-Layer Flag
This flag is available for backward compatibility with older version of FBX files and should not be used anymore.All the animation layering system has been moved to the KFbxAnimLayer and KFbxAnimStack classes.
void	SetMultiLayer (bool pMultiLayer)
	Set multi-layer state flag.
bool	GetMultiLayer () const
	Get multi-layer state.
Deformer types
enum	EDeformerType {   eUNIDENTIFIED, eSKIN, eBLENDSHAPE, eVERTEX_CACHE,   eDEFORMER_COUNT }
	Deformer types. More...
virtual EDeformerType	GetDeformerType () const
	Get the deformer type.
Error Management
enum	EError { eERROR, eERROR_COUNT }
	Error identifiers. More...
KError &	GetError ()
	Retrieve error object.
EError	GetLastErrorID () const
	Get last error code.
const char *	GetLastErrorString () const
	Get last error string.

---

Member Enumeration Documentation

enum EDeformerType

Search for all occurrences

Deformer types.

Enumerator:

eUNIDENTIFIED	Untyped deformer. Search for all occurrences
eSKIN	Type KFbxSkin. Search for all occurrences
eBLENDSHAPE	Type KFbxBlendShape. Search for all occurrences
eVERTEX_CACHE	Type KFbxVertexCacheDeformer. Search for all occurrences
eDEFORMER_COUNT	Number of deformer types. Search for all occurrences

Definition at line 100 of file kfbxdeformer.h.

        {
            eUNIDENTIFIED,
            eSKIN,
            eBLENDSHAPE,
            eVERTEX_CACHE,
            eDEFORMER_COUNT
        } EDeformerType;

enum EError

Search for all occurrences

Error identifiers.

Enumerator:

eERROR	An error occurred. Search for all occurrences
eERROR_COUNT	Number of error identifiers. Search for all occurrences

Definition at line 132 of file kfbxdeformer.h.

        {
            eERROR,
            eERROR_COUNT
        } EError;

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

void SetMultiLayer

(

bool

pMultiLayer

)

Search for all occurrences

Set multi-layer state flag.

Parameters:

pMultiLayer

Set to true to enable multi-layering.

bool GetMultiLayer

(

)

const

Search for all occurrences

Get multi-layer state.

Returns:

The current state of the multi-layer flag.

virtual EDeformerType GetDeformerType

(

)

const [inline, virtual]

Search for all occurrences

Get the deformer type.

Returns:

Deformer type identifier. Default value is eUNIDENTIFIED.

Reimplemented in KFbxBlendShape, KFbxSkin, and KFbxVertexCacheDeformer.

Definition at line 117 of file kfbxdeformer.h.

{ return eUNIDENTIFIED; }

KError& GetError

(

)

Search for all occurrences

Retrieve error object.

Returns:

Reference to error object.

EError GetLastErrorID

(

)

const

Search for all occurrences

Get last error code.

Returns:

Last error code.

const char* GetLastErrorString

(

)

const

Search for all occurrences

Get last error string.

Returns:

Textual description of the last error.

virtual KStringList GetTypeFlags

(

)

const [inline, protected, virtual]

Search for all occurrences

Reimplemented from KFbxObject.

Reimplemented in KFbxBlendShape, KFbxSkin, and KFbxVertexCacheDeformer.

Definition at line 165 of file kfbxdeformer.h.

{ return KStringList(); }

---

Friends And Related Function Documentation

friend class KFbxGeometry [friend]

Search for all occurrences

Definition at line 171 of file kfbxdeformer.h.

friend class KFbxScene [friend]

Search for all occurrences

Reimplemented from KFbxObject.

Reimplemented in KFbxBlendShape, and KFbxSkin.

Definition at line 172 of file kfbxdeformer.h.

---

Member Data Documentation

KError mError [protected]

Search for all occurrences

Definition at line 168 of file kfbxdeformer.h.

bool mMultiLayer [protected]

Search for all occurrences

Definition at line 169 of file kfbxdeformer.h.

---

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

• fbxfilesdk/kfbxplugins/kfbxdeformer.h