Detailed 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 keys, 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 (KFbxAnimCurve), 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 (KFbxAnimStack), an object (KFbxObject) with animated properties, an animation curve node (KFbxAnimCurveNode), or an array of animation curves (KFbxAnimCurve). For example, an unroll filter acts on 3 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.

Remarks:: This is now a deprecated class and should be replaced with its KFbxAnimCurveFilter equivalent.

Definition at line 91 of file kfbxkfcurvefilters.h.

#include <kfbxkfcurvefilters.h>

Inheritance diagram for KFbxKFCurveFilter:

[legend]

List of all members.

Protected Member Functions
	KFbxKFCurveFilter (KFbxSdkManager &pManager, char const *pName)
void	GetKFCurvesFromAnimCurve (KFbxAnimCurve pSrc, int pSrcCount, KFCurve pDst, int &pDstCount)
Protected Attributes
KTime	mTime
Member functions
virtual const char *	GetName () const
	Get the name of the filter.
virtual KTime &	GetStartTime ()
	Get the start time for the application of the filter.
virtual void	SetStartTime (KTime &pTime)
	Set the start time for the application of the filter.
virtual KTime &	GetStopTime ()
	Get the stop time for the application of the filter.
virtual void	SetStopTime (KTime &pTime)
	Set the stop time for the application of the filter.
virtual int	GetStartKey (KFbxAnimCurve &pCurve) const
	Get the index of start key on the given curve.
virtual int	GetStopKey (KFbxAnimCurve &pCurve) const
	Get the index of stop key on the given curve.
virtual bool	NeedApply (KFbxAnimStack *pAnimStack)
	Check if any curve on the animation stack needs an application of the filter.
virtual bool	NeedApply (KFbxObject pObj, KFbxAnimStack pAnimStack)
	Check if all the animated properties of the object need an application of the filter.
virtual bool	NeedApply (KFbxAnimCurveNode &pCurveNode)
	Check if the animation curve node needs an application of the filter.
virtual bool	NeedApply (KFbxAnimCurve **pCurve, int pCount)
	Check if the given animation curve need an application of the filter.
virtual bool	NeedApply (KFbxAnimCurve &pCurve)
	Check if an animation curve need an application of the filter.
virtual bool	Apply (KFbxAnimStack *pAnimStack)
	Apply filter to all the curves stored in the animation stack.
virtual bool	Apply (KFbxObject pObj, KFbxAnimStack pAnimStack)
	Apply filter to all the animated properties of the object.
virtual bool	Apply (KFbxAnimCurveNode &pCurveNode)
	Apply filter on all the curves of an animation curve node.
virtual bool	Apply (KFbxAnimCurve **pCurve, int pCount)
	Apply filter on an array of animation curves.
virtual bool	Apply (KFbxAnimCurve &pCurve)
	Apply filter on an animation curve.
virtual void	Reset ()
	Reset the filter to its default parameters.
virtual KError *	GetError ()
	Retrieve error object.
virtual int	GetLastErrorID ()
	Get last error ID.
virtual char *	GetLastErrorString ()
	Get last error string.
Deprecated functions
virtual int	GetStartKey (KFCurve &pCurve) const
virtual int	GetStopKey (KFCurve &pCurve) const
virtual bool	NeedApply (KFCurveNode &pCurveNode, bool pRecursive=true)
virtual bool	NeedApply (KFCurve **pCurve, int pCount)
virtual bool	NeedApply (KFCurve &pCurve)
virtual bool	Apply (KFCurveNode &pCurveNode, bool pRecursive=true)
virtual bool	Apply (KFCurve **pCurve, int pCount)
virtual bool	Apply (KFCurve &pCurve)

Constructor & Destructor Documentation

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

Member Function Documentation

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

virtual bool NeedApply	(	KFbxObject *	pObj,
		KFbxAnimStack *	pAnimStack
	)		`[virtual]`

pObj	Object containing the properties to test.
pAnimStack	Animation stack where to retrieve the animation curves

virtual bool NeedApply	(	KFbxAnimCurve **	pCurve,
		int	pCount
	)		`[inline, virtual]`

pCurve	Array of curves to test if they need the and application of the filter.
pCount	Number of curves in array.

virtual bool Apply	(	KFbxObject *	pObj,
		KFbxAnimStack *	pAnimStack
	)		`[virtual]`

pObj	Object containing the animated properties to which the filter is applied.
pAnimStack	Animation stack where to retrieve the animation curves

pCurve	Array of curves to which the filter is applied.
pCount	Number of curves in the array.

virtual bool NeedApply	(	KFCurveNode &	pCurveNode,
		bool	pRecursive = `true`
	)		`[inline, virtual]`

pCurveNode	Curve node to test if it needs application of filter.
pRecursive	Apply recursively to all curve node children.

virtual bool NeedApply	(	KFCurve **	pCurve,
		int	pCount
	)		`[inline, virtual]`

pCurveNode	Curve node to which the filter is applied.
pRecursive	Apply recursively to all curve node children.

void GetKFCurvesFromAnimCurve	(	KFbxAnimCurve **	pSrc,
		int	pSrcCount,
		KFCurve **	pDst,
		int &	pDstCount
	)		`[protected]`

KFbxKFCurveFilter Class Reference

Detailed Description

Protected Member Functions

Protected Attributes

Member functions

Deprecated functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation