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

Detailed Description

Class for clusters (links).

A cluster, or link, is an entity acting on a geometry (FbxGeometry). More precisely, the cluster acts on a subset of the geometry's control points. For each control point that the cluster acts on, the intensity of the cluster's action is modulated by a weight. The link mode (ELinkMode) specifies how the weights are taken into account.

The cluster's link node specifies the node (FbxNode) that influences the control points of the cluster. If the node is animated, the control points will move accordingly.

A cluster is usually part of a skin (

See also:: FbxDeformer, FbxSkin). For example, imagine a mesh representing a humanoid, and imagine a skeleton made of bones. Each bone is represented by a node in FBX. To bind the geometry to the nodes, we create a skin (FbxSkin). The skin has many clusters, each one corresponding to a bone. Each node influences some control points of the mesh. A node has a high influence on some of the points (high weight) and lower influence on some other points (low weight). Some points of the mesh are not affected at all by the bone, so they would not be part of the corresponding cluster.

Definition at line 47 of file fbxcluster.h.

#include <fbxcluster.h>

Inheritance diagram for FbxCluster:

[legend]

List of all members.

Public Member Functions
void	SetControlPointIWCount (int pCount)
	Set the array size for the three arrays: the array of control point indices, the array of weights and the array of blend weights.
virtual FbxObject &	Copy (const FbxObject &pObject)
	Copy an object content into this object.
void	SetUserData (const char pUserDataID, const char pUserData)
const char *	GetUserDataID () const
const char *	GetUserData () const
const char *	GetUserData (const char *pUserDataID) const
Public Attributes
FbxString	mBeforeVersion6LinkName
FbxString	mBeforeVersion6AssociateModelName
Protected Member Functions
virtual void	Construct (const FbxCluster *pFrom)
virtual void	ConstructProperties (bool pForceSet)
	Optional property constructor override, automatically called by default constructor.
virtual FbxStringList	GetTypeFlags () const
Protected Attributes
ELinkMode	mLinkMode
FbxString	mUserDataID
FbxString	mUserData
FbxArray< int >	mControlPointIndices
FbxArray< double >	mControlPointWeights
FbxMatrix	mTransform
FbxMatrix	mTransformLink
FbxMatrix	mTransformAssociate
FbxMatrix	mTransformParent
bool	mIsTransformParentSet
FbxPropertyT< FbxReference >	SrcModelReference
General Functions
EType	GetSubDeformerType () const
	Get the type of the sub deformer.
void	Reset ()
	Restore the cluster to its initial state.
Link Mode, Link Node, Associate Model
enum	ELinkMode { eNormalize, eAdditive, eTotalOne }
	Link modes. More...
void	SetLinkMode (ELinkMode pMode)
	Set the link mode.
ELinkMode	GetLinkMode () const
	Get the link mode.
void	SetLink (const FbxNode *pNode)
	Set the link node.
FbxNode *	GetLink ()
	Get the link node.
const FbxNode *	GetLink () const
	Get the link node (as const).
void	SetAssociateModel (FbxNode *pNode)
	Set the associate model.
FbxNode *	GetAssociateModel () const
	Get the associate model.
Control Points
A link has an array of indices to control points and associated weights.The indices refer to the control points in the instance of class FbxGeometry owning the link. The weights are the influence of the link node over the displacement of the indexed control points.
void	AddControlPointIndex (int pIndex, double pWeight)
	Add an element in both arrays of control point indices and weights.
int	GetControlPointIndicesCount () const
	Get the length of the arrays of control point indices and weights.
int *	GetControlPointIndices () const
	Get the array of control point indices.
double *	GetControlPointWeights () const
	Get the array of control point weights.
Transformation matrices
A link has three transformation matrices: Transform refers to the global initial transform of the geometry node that contains the link node. TransformLink refers to global initial transform of the link node. TransformAssociateModel refers to the global initial transform of the associate model. For example, given a mesh binding with several bones(links), Transform is the global transform of the mesh at the binding moment, TransformLink is the global transform of the bone(link) at the binding moment, TransformAssociateModel is the global transform of the associate model at the binding moment.
void	SetTransformMatrix (const FbxAMatrix &pMatrix)
	Set matrix associated with the node containing the link.
FbxAMatrix &	GetTransformMatrix (FbxAMatrix &pMatrix) const
	Get matrix associated with the node containing the link.
void	SetTransformLinkMatrix (const FbxAMatrix &pMatrix)
	Set matrix associated with the link node.
FbxAMatrix &	GetTransformLinkMatrix (FbxAMatrix &pMatrix) const
	Get matrix associated with the link node.
void	SetTransformAssociateModelMatrix (const FbxAMatrix &pMatrix)
	Set matrix associated with the associate model.
FbxAMatrix &	GetTransformAssociateModelMatrix (FbxAMatrix &pMatrix) const
	Get matrix associated with the associate model.
void	SetTransformParentMatrix (const FbxAMatrix &pMatrix)
	Set matrix associated with the parent node.
FbxAMatrix &	GetTransformParentMatrix (FbxAMatrix &pMatrix) const
	Get matrix associated with the parent node.
bool	IsTransformParentSet () const
	Get the Transform Parent set flag value.

pIndex	The index of the control point.
pWeight	The link weight for this control point.

void SetUserData	(	const char *	pUserDataID,
		const char *	pUserData
	)

FbxCluster Class Reference

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

General Functions

Link Mode, Link Node, Associate Model

Control Points

Transformation matrices

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation