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

#include <fbxanimcurvefilters.h>

Class Description

Base class for animation curve filters.

Animation curves can be modified through filters. The filters act on the curve keys and values. They can move, add or remove keys, modify key values and key tangents, depending on the desired action of the filter. Some simple examples are:

A scale filter, that would multiply all key values of a curve, and the curve default value, by a given scale.
A constant key reducer filter, that would clean a curve by removing redundant keys that all have the same value.

Filters can act on a single animation curve (FbxAnimCurve), but some filters need to work on many animation curves at the same time. For this reason, the input to a filter can be an animation stack (FbxAnimStack), an object (FbxObject) with animated properties, an animation curve node (FbxAnimCurveNode), or an array of animation curves (FbxAnimCurve). For example, an unroll filter acts on 3 Euler rotation curves (X, Y and Z) at the same time.

A filter has a start time (that can be as low as TC_MINFINITY) and a stop time (that can be as high as TC_INFINITY). The filter is only applied to the parts of the animation curves that are between the start and stop time.

The following are two code samples about how to use filter. Code sample to use sync filter:

    FbxAnimCurve* lWorkCurves[3]; //Put some keys in the lWorkCurves and they sync them up.
    FbxAnimCurveFilterKeySync lSyncFilter;
    FbxTime pStart, pStop; //Given start and stop time.
    lSyncFilter.SetStartTime( pStart );
    lSyncFilter.SetStopTime ( pStop  );
    if( lSyncFilter.NeedApply( lWorkCurves, 3 ) )
    {
        lSyncFilter.Apply( lWorkCurves, 3 );
    }

Code sample to use unroll filter:

    FbxAnimCurveNode* pCurveNode; //An Euler rotation animation curve node.
    FbxAnimCurveFilterUnroll lUnrollFilter;
    lUnrollFilter.SetForceAutoTangents(true);
    lUnrollFilter.Apply(*pCurveNode);

Definition at line 74 of file fbxanimcurvefilters.h.

Inheritance diagram for FbxAnimCurveFilter:

List of all members.

Public Member Functions
	FbxAnimCurveFilter ()
	Constructor.
virtual	~FbxAnimCurveFilter ()
	Destructor.
Member functions
virtual const char *	GetName () const
	Get the name of the filter.
FbxTime &	GetStartTime ()
	Get the start time for the application of the filter.
void	SetStartTime (FbxTime &pTime)
	Set the start time for the application of the filter.
FbxTime &	GetStopTime ()
	Get the stop time for the application of the filter.
void	SetStopTime (FbxTime &pTime)
	Set the stop time for the application of the filter.
int	GetStartKey (FbxAnimCurve &pCurve) const
	Get the index of start key on the given curve.
int	GetStopKey (FbxAnimCurve &pCurve) const
	Get the index of stop key on the given curve.
virtual bool	NeedApply (FbxAnimStack pAnimStack, FbxStatus pStatus=NULL)
	Check if any curve on the animation stack needs an application of the filter.
virtual bool	NeedApply (FbxObject pObj, FbxAnimStack pAnimStack, FbxStatus *pStatus=NULL)
	Check if all the animated properties of the object need an application of the filter.
virtual bool	NeedApply (FbxAnimCurveNode &pCurveNode, FbxStatus *pStatus=NULL)
	Check if the animation curve node needs an application of the filter.
virtual bool	NeedApply (FbxAnimCurve *pCurve, int pCount, FbxStatus pStatus=NULL)
	Check if the given animation curve need an application of the filter.
virtual bool	NeedApply (FbxAnimCurve &pCurve, FbxStatus *pStatus=NULL)
	Check if an animation curve need an application of the filter.
virtual bool	Apply (FbxAnimStack pAnimStack, FbxStatus pStatus=NULL)
	Apply filter to all the curves stored in the animation stack.
virtual bool	Apply (FbxObject pObj, FbxAnimStack pAnimStack, FbxStatus *pStatus=NULL)
	Apply filter to all the animated properties of the object.
virtual bool	Apply (FbxAnimCurveNode &pCurveNode, FbxStatus *pStatus=NULL)
	Apply filter on all the curves of an animation curve node.
virtual bool	Apply (FbxAnimCurve *pCurve, int pCount, FbxStatus pStatus=NULL)
	Apply filter on an array of animation curves.
virtual bool	Apply (FbxAnimCurve &pCurve, FbxStatus *pStatus=NULL)=0
	Apply filter on an animation curve.
virtual void	Reset ()
	Reset the filter to its default parameters.

Constructor & Destructor Documentation

FbxAnimCurveFilter ( )

Constructor.

virtual ~FbxAnimCurveFilter ( ) [inline, virtual]

Destructor.

Definition at line 81 of file fbxanimcurvefilters.h.

{};

Member Function Documentation

virtual const char* GetName ( ) const [inline, virtual]

virtual bool NeedApply	(	FbxAnimStack *	pAnimStack,
		FbxStatus *	pStatus = `NULL`
	)		`[virtual]`

pAnimStack	Animation stack where to retrieve the animation curves
pStatus	The FbxStatus object to hold error codes.

virtual bool NeedApply	(	FbxObject *	pObj,
		FbxAnimStack *	pAnimStack,
		FbxStatus *	pStatus = `NULL`
	)		`[virtual]`

pObj	Object containing the properties to test.
pAnimStack	Animation stack where to retrieve the animation curves
pStatus	The FbxStatus object to hold error codes.

virtual bool NeedApply	(	FbxAnimCurveNode &	pCurveNode,
		FbxStatus *	pStatus = `NULL`
	)		`[virtual]`

pCurveNode	Curve node to test.
pStatus	The FbxStatus object to hold error codes.

virtual bool NeedApply	(	FbxAnimCurve **	pCurve,
		int	pCount,
		FbxStatus *	pStatus = `NULL`
	)		`[virtual]`

pCurve	Array of curves to test if they need the and application of the filter.
pCount	Number of curves in array.
pStatus	The FbxStatus object to hold error codes.

virtual bool NeedApply	(	FbxAnimCurve &	pCurve,
		FbxStatus *	pStatus = `NULL`
	)		`[virtual]`

pCurve	Curve to test if it needs application of filter.
pStatus	The FbxStatus object to hold error codes.

virtual bool Apply	(	FbxAnimStack *	pAnimStack,
		FbxStatus *	pStatus = `NULL`
	)		`[virtual]`

pObj	Object containing the animated properties to which the filter is applied.
pAnimStack	Animation stack where to retrieve the animation curves
pStatus	The FbxStatus object to hold error codes.

pCurveNode	Curve node to which the filter is applied.
pStatus	The FbxStatus object to hold error codes.

pCurve	Array of curves to which the filter is applied.
pCount	Number of curves in the array.
pStatus	The FbxStatus object to hold error codes.

pCurve	Curve to which the filter is applied.
pStatus	The FbxStatus object to hold error codes.

Class Description

Public Member Functions

Member functions

Constructor & Destructor Documentation

Member Function Documentation