KFbxAnimCurveFilterKeySync Class Reference

Search for all occurrences

---

Detailed Description

Key sync filter.

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

Definition at line 620 of file kfbxanimcurvefilters.h.

#include <kfbxanimcurvefilters.h>

Inheritance diagram for KFbxAnimCurveFilterKeySync:

List of all members.

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

---

Constructor & Destructor Documentation

KFbxAnimCurveFilterKeySync

(

)

Constructor.

virtual ~KFbxAnimCurveFilterKeySync

(

)

[inline, virtual]

Destructor.

Definition at line 627 of file kfbxanimcurvefilters.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 KFbxAnimCurveFilter.

virtual bool NeedApply

(

KFbxAnimStack *

pAnimStack

)

[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

Returns:

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

Reimplemented from KFbxAnimCurveFilter.

Definition at line 638 of file kfbxanimcurvefilters.h.

{ return KFbxAnimCurveFilter::NeedApply(pAnimStack); }

virtual bool NeedApply	(	KFbxObject *	pObj,
		KFbxAnimStack *	pAnimStack
	)		[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

Returns:

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

Reimplemented from KFbxAnimCurveFilter.

Definition at line 639 of file kfbxanimcurvefilters.h.

{ return KFbxAnimCurveFilter::NeedApply(pObj, pAnimStack); }

virtual bool NeedApply

(

KFbxAnimCurveNode &

pCurveNode

)

[inline, virtual]

Search for all occurrences

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

Parameters:

pCurveNode

Curve node to test.

Returns:

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

Remarks:

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

Reimplemented from KFbxAnimCurveFilter.

Definition at line 640 of file kfbxanimcurvefilters.h.

{ return KFbxAnimCurveFilter::NeedApply(pCurveNode); }

virtual bool Apply

(

KFbxAnimStack *

pAnimStack

)

[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

Returns:

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

Reimplemented from KFbxAnimCurveFilter.

Definition at line 641 of file kfbxanimcurvefilters.h.

{ return KFbxAnimCurveFilter::Apply(pAnimStack); }

virtual bool Apply	(	KFbxObject *	pObj,
		KFbxAnimStack *	pAnimStack
	)		[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

Returns:

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

Reimplemented from KFbxAnimCurveFilter.

Definition at line 642 of file kfbxanimcurvefilters.h.

{ return KFbxAnimCurveFilter::Apply(pObj, pAnimStack); }

virtual bool Apply

(

KFbxAnimCurveNode &

pCurveNode

)

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

Returns:

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

Remarks:

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

Reimplemented from KFbxAnimCurveFilter.

Definition at line 643 of file kfbxanimcurvefilters.h.

{ return KFbxAnimCurveFilter::Apply(pCurveNode); }

virtual bool NeedApply	(	KFbxAnimCurve **	pCurve,
		int	pCount
	)		[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.

Returns:

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

Reimplemented from KFbxAnimCurveFilter.

virtual bool NeedApply

(

KFbxAnimCurve &

pCurve

)

[inline, virtual]

Search for all occurrences

One single curve cannot be sync'ed.

Parameters:

pCurve

Curve to test if it needs application of filter.

Returns:

false

Reimplemented from KFbxAnimCurveFilter.

Definition at line 657 of file kfbxanimcurvefilters.h.

{ return false; }

virtual bool Apply	(	KFbxAnimCurve **	pCurve,
		int	pCount
	)		[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.

Returns:

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

Reimplemented from KFbxAnimCurveFilter.

virtual bool Apply

(

KFbxAnimCurve &

pCurve

)

[inline, virtual]

Search for all occurrences

Apply filter on an animation curve.

Parameters:

pCurve

Curve to which the filter is applied.

Returns:

true.

Remarks:

Has no effect since there is only one curve.

Implements KFbxAnimCurveFilter.

Definition at line 671 of file kfbxanimcurvefilters.h.

{ return true; }

---

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

• fbxfilesdk/kfbxplugins/kfbxanimcurvefilters.h