KFbxBlendShape Class Reference

This reference page is linked to from the following overview topics: FBX SDK 2012.

---

Search for all occurrences

---

Detailed Description

FBX SDK blend shape deformer class.

Examples:

ExportScene02/main.cxx, ExportScene03/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayShape.cxx, and ViewScene/DrawScene.cxx.

Definition at line 60 of file kfbxblendshape.h.

#include <kfbxblendshape.h>

Inheritance diagram for KFbxBlendShape:

List of all members.

Public Member Functions
bool	SetGeometry (KFbxGeometry *pGeometry)
	Set the geometry affected by this blend shape deformer.
KFbxGeometry *	GetGeometry ()
	Get the geometry affected by this blend shape deformer.
bool	AddBlendShapeChannel (KFbxBlendShapeChannel *pBlendShapeChannel)
	Add a blend shape channel.
KFbxBlendShapeChannel *	RemoveBlendShapeChannel (KFbxBlendShapeChannel *pBlendShapeChannel)
	Remove the given blend shape.
int	GetBlendShapeChannelCount () const
	Get the number of blend shape channels.
KFbxBlendShapeChannel *	GetBlendShapeChannel (int pIndex)
	Get blend shape channel at given index.
KFbxBlendShapeChannel const *	GetBlendShapeChannel (int pIndex) const
	Get the blend shape channel at given index.
EDeformerType	GetDeformerType () const
	Get the type of the deformer.
void	Reset ()
	Restore the blend shape deformer to its initial state.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
Protected Member Functions
	KFbxBlendShape (KFbxSdkManager &pManager, char const *pName)
virtual KStringList	GetTypeFlags () const
Friends
class	KFbxScene

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

bool SetGeometry

(

KFbxGeometry *

pGeometry

)

Search for all occurrences

Set the geometry affected by this blend shape deformer.

Parameters:

pGeometry

Pointer to the geometry object to set.

Returns:

true on success, false otherwise.

Remarks:

One blend shape deformer can only be used on one base geometry. So when SetGeometry is called, pGeometry will replace the last one.

KFbxGeometry* GetGeometry

(

)

Search for all occurrences

Get the geometry affected by this blend shape deformer.

Returns:

a pointer to the geometry if set or NULL.

bool AddBlendShapeChannel

(

KFbxBlendShapeChannel *

pBlendShapeChannel

)

Search for all occurrences

Add a blend shape channel.

Parameters:

pBlendShapeChannel

Pointer to the blend shape channel object to add.

Returns:

true on success, false otherwise.

Examples:

ExportScene02/main.cxx, and ExportScene03/main.cxx.

KFbxBlendShapeChannel* RemoveBlendShapeChannel

(

KFbxBlendShapeChannel *

pBlendShapeChannel

)

Search for all occurrences

Remove the given blend shape.

Parameters:

pBlendShapeChannel

Pointer to the blend shape channel to remove from this blend shape deformer.

Returns:

Pointer to the blend shape channel or NULL if pBlendShapeChannel is not owned by this blend shape deformer.

int GetBlendShapeChannelCount

(

)

const

Search for all occurrences

Get the number of blend shape channels.

Returns:

Number of blend shape channels that have been added to this object.

Examples:

ImportScene/DisplayAnimation.cxx, ImportScene/DisplayShape.cxx, and ViewScene/DrawScene.cxx.

KFbxBlendShapeChannel* GetBlendShapeChannel

(

int

pIndex

)

Search for all occurrences

Get blend shape channel at given index.

Parameters:

pIndex

Index of the blend shape channel.

Returns:

Pointer to the blend shape channel or NULL if index is out of range.

Examples:

ImportScene/DisplayAnimation.cxx, ImportScene/DisplayShape.cxx, and ViewScene/DrawScene.cxx.

KFbxBlendShapeChannel const* GetBlendShapeChannel

(

int

pIndex

)

const

Search for all occurrences

Get the blend shape channel at given index.

Parameters:

pIndex

Index of the blend shape channel.

Returns:

Pointer to the blend shape channel or NULL if index is out of range.

EDeformerType GetDeformerType

(

)

const [inline, virtual]

Search for all occurrences

Get the type of the deformer.

Returns:

Deformer type identifier.

Reimplemented from KFbxDeformer.

Definition at line 111 of file kfbxblendshape.h.

{return eBLENDSHAPE; };

void Reset

(

)

Search for all occurrences

Restore the blend shape deformer to its initial state.

Calling this function will do the following:

• Clear the pointer to base geometry.
• Remove all the blend shape channels.

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 KStringList GetTypeFlags

(

)

const [protected, virtual]

Search for all occurrences

Reimplemented from KFbxDeformer.

---

Friends And Related Function Documentation

friend class KFbxScene [friend]

Search for all occurrences

Reimplemented from KFbxDeformer.

Definition at line 137 of file kfbxblendshape.h.

---

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

• fbxfilesdk/kfbxplugins/kfbxblendshape.h