FbxAnimCurveFilterKeySync Class Reference

Search for all occurrences

#include <fbxanimcurvefilters.h>

---

Class Description

Key sync filter.

Filter to synchronize the keys of a set of animation curves.

Definition at line 608 of file fbxanimcurvefilters.h.

Inheritance diagram for FbxAnimCurveFilterKeySync:

List of all members.

Public Member Functions
	FbxAnimCurveFilterKeySync ()
	Constructor.
virtual	~FbxAnimCurveFilterKeySync ()
	Destructor.
virtual const char *	GetName () const
	Get the name 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 &, FbxStatus *pStatus=NULL)
	One single curve cannot be sync'ed.
virtual bool	Apply (FbxAnimCurve **pCurve, int pCount, FbxStatus *pStatus=NULL)
	Apply filter on the given animation curve.
virtual bool	Apply (FbxAnimCurve &, FbxStatus *pStatus=NULL)
	Apply filter on an animation curve.
Exposed parent class methods.
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	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.

---

Constructor & Destructor Documentation

FbxAnimCurveFilterKeySync

(

)

Constructor.

virtual ~FbxAnimCurveFilterKeySync

(

)

[inline, virtual]

Destructor.

Definition at line 615 of file fbxanimcurvefilters.h.

{};

---

Member Function Documentation

virtual const char* GetName

(

)

const [virtual]

Search for all occurrences

Get the name of the filter.

Returns:

Pointer to name.

Reimplemented from FbxAnimCurveFilter.

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

Search for all occurrences

Check if any curve on the animation stack needs an application of the filter.

Parameters:

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

Returns:

true if at least one animated property needs an application of the filter.

Reimplemented from FbxAnimCurveFilter.

Definition at line 626 of file fbxanimcurvefilters.h.

{ return FbxAnimCurveFilter::NeedApply(pAnimStack, pStatus); }

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

Search for all occurrences

Check if all the animated properties of the object need an application of the filter.

Parameters:

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

Returns:

true if at least one animated property needs an application of the filter.

Reimplemented from FbxAnimCurveFilter.

Definition at line 627 of file fbxanimcurvefilters.h.

{ return FbxAnimCurveFilter::NeedApply(pObj, pAnimStack, pStatus); }

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

Search for all occurrences

Check if the animation curve node needs an application of the filter.

Parameters:

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

Returns:

true if the animation curve node needs an application of the filter.

Remarks:

This method collects all the FbxAnimCurve objects connected to the curve node and calls NeedApply(FbxAnimCurve**, int)

Reimplemented from FbxAnimCurveFilter.

Definition at line 628 of file fbxanimcurvefilters.h.

{ return FbxAnimCurveFilter::NeedApply(pCurveNode, pStatus); }

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

Search for all occurrences

Apply filter to all the curves stored in the animation stack.

Parameters:

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

Returns:

true if the curve filtering operation was successful, false otherwise.

Reimplemented from FbxAnimCurveFilter.

Definition at line 629 of file fbxanimcurvefilters.h.

{ return FbxAnimCurveFilter::Apply(pAnimStack, pStatus); }

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

Search for all occurrences

Apply filter to all the animated properties of the object.

Parameters:

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.

Returns:

true if the curve filtering operation was successful, false otherwise.

Reimplemented from FbxAnimCurveFilter.

Definition at line 630 of file fbxanimcurvefilters.h.

{ return FbxAnimCurveFilter::Apply(pObj, pAnimStack, pStatus); }

virtual bool Apply	(	FbxAnimCurveNode &	pCurveNode,
		FbxStatus *	pStatus = NULL
	)		[inline, virtual]

Search for all occurrences

Apply filter on all the curves of an animation curve node.

Parameters:

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

Returns:

true if the curve filtering operation was successful, false otherwise.

Remarks:

This method collects all the FbxAnimCurve objects connected to the curve node and calls Apply(FbxAnimCurve**, int)

Reimplemented from FbxAnimCurveFilter.

Definition at line 631 of file fbxanimcurvefilters.h.

{ return FbxAnimCurveFilter::Apply(pCurveNode, pStatus); }

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

Search for all occurrences

Check if the given animation curve need an application of the filter.

Parameters:

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.

Returns:

true if at least one animation curve in the array needs an application of the filter.

Reimplemented from FbxAnimCurveFilter.

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

Search for all occurrences

One single curve cannot be sync'ed.

Parameters:

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

Returns:

false

Reimplemented from FbxAnimCurveFilter.

Definition at line 647 of file fbxanimcurvefilters.h.

{ FBX_UNUSED(pStatus); return false; }

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

Search for all occurrences

Apply filter on the given animation curve.

Parameters:

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

Returns:

true if the curve filtering operation was successful, false otherwise.

Reimplemented from FbxAnimCurveFilter.

virtual bool Apply	(	FbxAnimCurve &	,
		FbxStatus *	pStatus = NULL
	)		[inline, virtual]

Search for all occurrences

Apply filter on an animation curve.

Parameters:

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

Returns:

true.

Remarks:

Has no effect since there is only one curve.

Implements FbxAnimCurveFilter.

Definition at line 663 of file fbxanimcurvefilters.h.

{ FBX_UNUSED(pStatus); return true; }

---

The documentation for this class was generated from the following file:

• fbxsdk/scene/animation/fbxanimcurvefilters.h