This reference page is linked to from the following overview topics: FBX SDK 2012, List of Python FBX classes.

Detailed Description

A shape describes the deformation on a set of control points, which is similar to the cluster deformer in Maya.

For example, we can add a shape to a created geometry. And the shape and the geometry have the same topological information but different position of the control points. With varying amounts of influence, the geometry performs a deformation effect.

See also:: KFbxGeometry

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

Definition at line 58 of file kfbxshape.h.

#include <kfbxshape.h>

Inheritance diagram for KFbxShape:

[legend]

List of all members.

Public Member Functions
bool	SetBlendShapeChannel (KFbxBlendShapeChannel *pBlendShapeChannel)
	Set the blend shape channel that contains this target shape.
KFbxBlendShapeChannel *	GetBlendShapeChannel () const
	Get the blend shape channel that contains this target shape.
KFbxGeometry *	GetBaseGeometry ()
	Get the base geometry of this target shape.
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.
void	SetControlPointIndicesCount (int pCount)
	Set the array size for the control point indices.
void	AddControlPointIndex (int pIndex)
	Add a control point index to the control point indices array.
void	Reset ()
	Restore the shape to its initial state.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
Protected Member Functions
virtual EAttributeType	GetAttributeType () const
	Return the type of node attribute which is EAttributeType::eUNIDENTIFIED.
virtual KStringList	GetTypeFlags () const
	KFbxShape (KFbxSdkManager &pManager, char const *pName)
virtual bool	ConstructProperties (bool pForceSet)
Protected Attributes
KArrayTemplate< int >	mControlPointIndices
Friends
class	KFbxGeometry

Constructor & Destructor Documentation

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

Member Function Documentation

bool SetBlendShapeChannel ( KFbxBlendShapeChannel * pBlendShapeChannel )

Search for all occurrences

Set the blend shape channel that contains this target shape.

Parameters:

pBlendShapeChannel Pointer to the blend shape channel to set.

Returns:: true on success, false otherwise.

KFbxBlendShapeChannel* GetBlendShapeChannel ( ) const

Search for all occurrences

Get the blend shape channel that contains this target shape.

Returns:: a pointer to the blend shape channel if set or NULL.

KFbxGeometry* GetBaseGeometry ( )

Search for all occurrences

Get the base geometry of this target shape.

Returns:: a pointer to the base geometry if set or NULL.

Remarks:: Since target shape can only connected to its base geometry through blend shape channel and blend shape deformer. So only when this target shape is connected to a blend shape channel, and the blend shape channel is connected to a blend shape deformer, and the blend shape deformer is used on a base geometry, then to get base geometry will success.

int GetControlPointIndicesCount ( ) const

Search for all occurrences

Get the length of the arrays of control point indices and weights.

Returns:: Length of the arrays of control point indices and weights. Returns 0 if no control point indices have been added or the arrays have been reset.

int* GetControlPointIndices ( ) const

Search for all occurrences

Get the array of control point indices.

Returns:: Pointer to the array of control point indices. NULL if no control point indices have been added or the array has been reset.

void SetControlPointIndicesCount ( int pCount )

Search for all occurrences

Set the array size for the control point indices.

Parameters:

pCount The new count.

void AddControlPointIndex ( int pIndex )

Search for all occurrences

Add a control point index to the control point indices array.

Parameters:

pIndex The control point index to add.

void Reset ( )

Search for all occurrences

Restore the shape to its initial state.

Calling this function will clear the following:

Pointer to blend shape channel.
Control point indices.

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

virtual EAttributeType GetAttributeType ( ) const [protected, virtual]

Search for all occurrences

Return the type of node attribute which is EAttributeType::eUNIDENTIFIED.

EAttributeType::eUNIDENTIFIED is returned because this class derives accidentally from KFbxNodeAttribute but its instances are not meant to be assigned to nodes.

Reimplemented from KFbxLayerContainer.

virtual KStringList GetTypeFlags ( ) const [protected, virtual]

Search for all occurrences

Reimplemented from KFbxObject.

virtual bool ConstructProperties ( bool pForceSet ) [protected, virtual]

Search for all occurrences

Reimplemented from KFbxGeometryBase.