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 (KFbxGeometry). 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 (KFbxNode) 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 KFbxDeformer, KFbxSkin). 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 (KFbxSkin). 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.

Examples:: ExportScene01/main.cxx, ImportScene/DisplayLink.cxx, SwitchBinding/main.cxx, and ViewScene/DrawScene.cxx.

Definition at line 82 of file kfbxcluster.h.

#include <kfbxcluster.h>

Inheritance diagram for KFbxCluster:

[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 KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
Public Attributes
KString	mBeforeVersion6LinkName
KString	mBeforeVersion6AssociateModelName
Protected Member Functions
	KFbxCluster (KFbxSdkManager &pManager, char const *pName)
virtual void	Construct (const KFbxCluster *pFrom)
virtual bool	ConstructProperties (bool pForceSet)
virtual KStringList	GetTypeFlags () const
Protected Attributes
ELinkMode	mLinkMode
KString	mUserDataID
KString	mUserData
KArrayTemplate< int >	mControlPointIndices
KArrayTemplate< double >	mControlPointWeights
KFbxMatrix	mTransform
KFbxMatrix	mTransformLink
KFbxMatrix	mTransformAssociate
KFbxMatrix	mTransformParent
bool	mIsTransformParentSet
KFbxTypedProperty< fbxReference >	SrcModel
KFbxTypedProperty< fbxReference >	SrcModelReference
Friends
class	KFbxScene
General Functions
ESubDeformerType	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, eTOTAL1 }
	Link modes. More...
void	SetLinkMode (ELinkMode pMode)
	Set the link mode.
ELinkMode	GetLinkMode () const
	Get the link mode.
void	SetLink (KFbxNode const *pNode)
	Set the link node.
KFbxNode *	GetLink ()
	Get the link node.
KFbxNode const *	GetLink () const
	Get the link node (as const).
void	SetAssociateModel (KFbxNode *pNode)
	Set the associate model.
KFbxNode *	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 KFbxGeometry 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 KFbxXMatrix &pMatrix)
	Set matrix associated with the node containing the link.
KFbxXMatrix &	GetTransformMatrix (KFbxXMatrix &pMatrix) const
	Get matrix associated with the node containing the link.
void	SetTransformLinkMatrix (const KFbxXMatrix &pMatrix)
	Set matrix associated with the link node.
KFbxXMatrix &	GetTransformLinkMatrix (KFbxXMatrix &pMatrix) const
	Get matrix associated with the link node.
void	SetTransformAssociateModelMatrix (const KFbxXMatrix &pMatrix)
	Set matrix associated with the associate model.
KFbxXMatrix &	GetTransformAssociateModelMatrix (KFbxXMatrix &pMatrix) const
	Get matrix associated with the associate model.
void	SetTransformParentMatrix (const KFbxXMatrix &pMatrix)
	Set matrix associated with the parent node.
KFbxXMatrix &	GetTransformParentMatrix (KFbxXMatrix &pMatrix) const
	Get matrix associated with the parent node.
bool	IsTransformParentSet () const
	Get the Transform Parent set flag value.
User Data
Service functions to store and retrieve extra data about the link.Only used by the Maya plugin, should move somewhere out of here...
void	SetUserData (KString pUserDataID, KString pUserData)
	Set user data.
KString	GetUserDataID () const
	Get the user data identifier.
KString	GetUserData () const
	Get the user data.
KString	GetUserData (KString pUserDataID) const
	Get the user data by identifier.

eNORMALIZE	Search for all occurrences
eADDITIVE	Search for all occurrences
eTOTAL1	Search for all occurrences

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

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

KFbxCluster Class Reference

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

General Functions

Link Mode, Link Node, Associate Model

Control Points

Transformation Matrices

User Data

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation