FbxBlendShapeChannel Class Reference

Search for all occurrences

---

Detailed Description

Class for blend shape channels.

A blend shape channel is a sub-deformer to help blend shape deformer to organize the target shapes. One blend shape deformer can have multiple blend shape channels in parallel, and each of them can control one or multiple target shapes. If there are multiple target shapes connected to one channel, each target shape could have its own full deformation percentage. For example, given a channel that has 3 target shapes, whose full deform percentage are 30, to 80 to 100 separately, then when the percent changes from 0 to 100, the base geometry will deform from the first target shape to the last one. This is called in-between blend shapes or progressive morph. The property DeformPercent of blend shape channel will control the deform level of each target shape or in-between blend shape on it.

Definition at line 37 of file fbxblendshapechannel.h.

#include <fbxblendshapechannel.h>

Inheritance diagram for FbxBlendShapeChannel:

List of all members.

Public Member Functions
bool	SetBlendShapeDeformer (FbxBlendShape *pBlendShape)
	Set the blend shape deformer that contains this blend shape channel.
FbxBlendShape *	GetBlendShapeDeformer ()
	Get the blend shape deformer that contains this blend shape channel.
bool	AddTargetShape (FbxShape *pShape, double pFullDeformPercent=100)
	Add a target shape.
FbxShape *	RemoveTargetShape (FbxShape *pShape)
	Remove the given target shape.
int	GetTargetShapeCount () const
	Get the number of target shapes.
FbxShape *	GetTargetShape (int pIndex)
	Get the target shape at given index.
FbxShape const *	GetTargetShape (int pIndex) const
	Get the target shape at given index.
int	GetTargetShapeIndex (FbxShape *pShape)
	Get the index of the given target shape.
double *	GetTargetShapeFullWeights ()
	Get the full weight values of target shape.
void	SetFullWeightsCount (int pCount)
	Set the array size for the fully deform weights.
Public Attributes
FbxPropertyT< FbxDouble >	DeformPercent
	This property stores deform percent of this channel.
General Functions
FbxArray< double >	mShapeFullWeightArray
EType	GetSubDeformerType () const
	Get the type of the sub deformer.
void	Reset ()
	Restore the blend shape channel to the initial state.
virtual FbxObject &	Copy (const FbxObject &pObject)
	Copy an object content into this object.
virtual void	Construct (const FbxBlendShapeChannel *pFrom)
virtual void	ConstructProperties (bool pForceSet)
	Optional property constructor override, automatically called by default constructor.
virtual FbxStringList	GetTypeFlags () const

---

Member Function Documentation

bool SetBlendShapeDeformer

(

FbxBlendShape *

pBlendShape

)

Search for all occurrences

Set the blend shape deformer that contains this blend shape channel.

Parameters:

pBlendShape

Pointer to the blend shape deformer to set.

Returns:

true on success, false otherwise.

FbxBlendShape* GetBlendShapeDeformer

(

)

Search for all occurrences

Get the blend shape deformer that contains this blend shape channel.

Returns:

A pointer to the blend shape deformer if set or NULL.

bool AddTargetShape	(	FbxShape *	pShape,
		double	pFullDeformPercent = 100
	)

Search for all occurrences

Add a target shape.

Parameters:

pShape	Pointer to the target shape to add.
pFullDeformPercent	The full deform percentage for the target shape.

Returns:

true on success, false otherwise.

FbxShape* RemoveTargetShape

(

FbxShape *

pShape

)

Search for all occurrences

Remove the given target shape.

Parameters:

pShape

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

Returns:

Pointer to the target shape or NULL if pShape is not owned by this blend shape channel.

int GetTargetShapeCount

(

)

const

Search for all occurrences

Get the number of target shapes.

Returns:

Number of target shapes that have been added to this blend shape channel.

FbxShape* GetTargetShape

(

int

pIndex

)

Search for all occurrences

Get the target shape at given index.

Parameters:

pIndex

Index of the target shape.

Returns:

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

FbxShape const* GetTargetShape

(

int

pIndex

)

const

Search for all occurrences

Get the target shape at given index.

Parameters:

pIndex

Index of the target shape.

Returns:

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

int GetTargetShapeIndex

(

FbxShape *

pShape

)

Search for all occurrences

Get the index of the given target shape.

Parameters:

pShape

The given target shape to find index.

Returns:

The index of the target shape.

double* GetTargetShapeFullWeights

(

)

Search for all occurrences

Get the full weight values of target shape.

To access each value iterate in the array up to GetTargetShapeCount().

Returns:

The array of full weight values of target shape.

void SetFullWeightsCount

(

int

pCount

)

Search for all occurrences

Set the array size for the fully deform weights.

This functions pre-allocate the array to pCount size.

Parameters:

pCount

The new array size to set.

EType GetSubDeformerType

(

)

const [inline, virtual]

Search for all occurrences

Get the type of the sub deformer.

Returns:

The sub deformer type identifier of blend shape channel.

Reimplemented from FbxSubDeformer.

Definition at line 117 of file fbxblendshapechannel.h.

{return eBlendShapeChannel; };

void Reset

(

)

Search for all occurrences

Restore the blend shape channel to the initial state.

Calling this function will do the following:

• Set the DeformPercent to 0.
• Remove all target shapes.
• Clear the array for fully deform weights of in-between target shapes.

virtual FbxObject& Copy

(

const FbxObject &

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 FbxObject.

virtual void Construct

(

const FbxBlendShapeChannel *

pFrom

)

[protected, virtual]

Search for all occurrences

virtual void ConstructProperties

(

bool

pForceSet

)

[protected, virtual]

Search for all occurrences

Optional property constructor override, automatically called by default constructor.

Parameters:

pForceSet

If the property value must be set regardless of default value.

Remarks:

If your object have properties, they must be initialized in this function.

Reimplemented from FbxObject.

virtual FbxStringList GetTypeFlags

(

)

const [protected, virtual]

Search for all occurrences

Reimplemented from FbxSubDeformer.

---

Member Data Documentation

FbxPropertyT<FbxDouble> DeformPercent

Search for all occurrences

This property stores deform percent of this channel.

The default value of this property is 0.0.

Remarks:

Although not enforced, it is strongly suggested to limit the value of this property in the range from 0.0 to 100.0 because graphic applications may handle values outside of this interval differently, therefore producing unexpected results.

Definition at line 49 of file fbxblendshapechannel.h.

FbxArray<double> mShapeFullWeightArray [protected]

Search for all occurrences

Definition at line 141 of file fbxblendshapechannel.h.

---

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

• fbxsdk/scene/geometry/fbxblendshapechannel.h