Detailed Description

Key sync filter.

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

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

Definition at line 1560 of file kfbxkfcurvefilters.h.

#include <kfbxkfcurvefilters.h>

Inheritance diagram for KFbxKFCurveFilterKeySync:

[legend]

List of all members.

Public Member Functions
virtual K_DEPRECATED const char *	GetName () const
	Get the name of the filter.
virtual K_DEPRECATED KTime &	GetStartTime ()
	Get the start time for the application of the filter.
virtual K_DEPRECATED void	SetStartTime (KTime &pTime)
	Set the start time for the application of the filter.
virtual K_DEPRECATED KTime &	GetStopTime ()
	Get the stop time for the application of the filter.
virtual K_DEPRECATED void	SetStopTime (KTime &pTime)
	Set the stop time for the application of the filter.
virtual K_DEPRECATED int	GetStartKey (KFbxAnimCurve &pCurve) const
	Get the index of start key on the given curve.
virtual K_DEPRECATED int	GetStopKey (KFbxAnimCurve &pCurve) const
	Get the index of stop key on the given curve.
virtual K_DEPRECATED bool	NeedApply (KFbxAnimStack *pAnimStack)
	Check if any curve on the animation stack needs an application of the filter.
virtual K_DEPRECATED bool	NeedApply (KFbxAnimCurveNode &pCurveNode)
	Check if the animation curve node needs an application of the filter.
virtual K_DEPRECATED bool	NeedApply (KFbxAnimCurve **pCurve, int pCount)
	Check if the given animation curve need an application of the filter.
virtual K_DEPRECATED bool	NeedApply (KFbxAnimCurve &pCurve)
	Check if an animation curve need an application of the filter.
virtual K_DEPRECATED KError *	GetError ()
	Retrieve error object.
virtual K_DEPRECATED int	GetLastErrorID () const
	Get last error ID.
virtual K_DEPRECATED const char *	GetLastErrorString () const
	Get last error string.
virtual K_DEPRECATED bool	Apply (KFbxAnimStack *pAnimStack)
	Apply filter to all the curves stored in the animation stack.
virtual K_DEPRECATED bool	Apply (KFbxAnimCurveNode &pCurveNode)
	Apply filter on all the curves of an animation curve node.
virtual K_DEPRECATED bool	Apply (KFbxAnimCurve **pCurve, int pCount)
	Apply filter on the given animation curve.
virtual K_DEPRECATED bool	Apply (KFbxAnimCurve &pCurve)
	Apply filter on an animation curve.
virtual K_DEPRECATED void	Reset ()
	Reset the filter to its default parameters.
Protected Member Functions
	KFbxKFCurveFilterKeySync (KFbxSdkManager &pManager, char const *pName)
	Constructor.
virtual void	Destruct (bool pRecursive, bool pDependents)
Protected Attributes
KFCurveFilterKeySync *	mDataCurveFilter

Constructor & Destructor Documentation

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

Constructor.

Member Function Documentation

virtual K_DEPRECATED const char* GetName ( ) const [virtual]

Search for all occurrences

Get the name of the filter.

Returns:: Pointer to name.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED KTime& GetStartTime ( ) [virtual]

Search for all occurrences

Get the start time for the application of the filter.

The part of the animation curves before the start time will remain untouched.

Returns:: The time expressed as KTime.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED void SetStartTime ( KTime & pTime ) [virtual]

Search for all occurrences

Set the start time for the application of the filter.

The part of the animation curves before the start time will remain untouched.

Parameters:

pTime The time to be set.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED KTime& GetStopTime ( ) [virtual]

Search for all occurrences

Get the stop time for the application of the filter.

The part of the animation curves after the stop time will remain untouched.

Returns:: The time expressed as KTime.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED void SetStopTime ( KTime & pTime ) [virtual]

Search for all occurrences

Set the stop time for the application of the filter.

The part of the animation curves after the stop time will remain untouched.

Parameters:

pTime The time to be set.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED int GetStartKey ( KFbxAnimCurve & pCurve ) const [virtual]

Search for all occurrences

Get the index of start key on the given curve.

This is the index of the first key after the filter's start time.

Parameters:

pCurve Curve on which we want to retrieve the start key.

Returns:: Index of the start key.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED int GetStopKey ( KFbxAnimCurve & pCurve ) const [virtual]

Search for all occurrences

Get the index of stop key on the given curve.

This is the index of the last key before the filter's stop time.

Parameters:

pCurve Curve on which we want to retrieve the stop key

Returns:: The position of the stop key

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED 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 KFbxKFCurveFilter.

Definition at line 1610 of file kfbxkfcurvefilters.h.

{ return ParentClass::NeedApply(pAnimStack); }

virtual K_DEPRECATED bool NeedApply ( KFbxAnimCurveNode & pCurveNode ) [virtual]

Search for all occurrences

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

Parameters:

pCurveNode Curves to test if they needs application of filter

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

Remarks:: The current implementation of this filter limits the number of animation curves on the animation curve node to 20.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED 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 KFbxKFCurveFilter.

virtual K_DEPRECATED bool NeedApply ( KFbxAnimCurve & pCurve ) [virtual]

Search for all occurrences

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

Parameters:

pCurve Curve to test if it needs application of filter.

Returns:: true if the animation curve needs an application of the filter.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED KError* GetError ( ) [virtual]

Search for all occurrences

Retrieve error object.

Returns:: Error object.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED int GetLastErrorID ( ) const [virtual]

Search for all occurrences

Get last error ID.

Returns:: Last error ID.

virtual K_DEPRECATED const char* GetLastErrorString ( ) const [virtual]

Search for all occurrences

Get last error string.

Returns:: Last error string.

virtual K_DEPRECATED 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 KFbxKFCurveFilter.

Definition at line 1650 of file kfbxkfcurvefilters.h.

{ return ParentClass::Apply(pAnimStack); }

virtual K_DEPRECATED bool Apply ( KFbxAnimCurveNode & pCurveNode ) [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:: The current implementation of this filter limits the number of animation curves on the animation curve node to 20.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED 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 KFbxKFCurveFilter.

virtual K_DEPRECATED bool Apply ( KFbxAnimCurve & pCurve ) [virtual]

Search for all occurrences

Apply filter on an animation curve.

Parameters:

pCurve Curve to which the filter is applied.

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

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED void Reset ( ) [virtual]

Search for all occurrences

Reset the filter to its default parameters.

Reimplemented from KFbxKFCurveFilter.

virtual void Destruct	(	bool	pRecursive,
		bool	pDependents
	)		`[protected, virtual]`

Search for all occurrences

Reimplemented from KFbxObject.

Member Data Documentation

KFCurveFilterKeySync* mDataCurveFilter [protected]

Search for all occurrences

Definition at line 1690 of file kfbxkfcurvefilters.h.

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

fbxfilesdk/kfbxplugins/kfbxkfcurvefilters.h

KFbxKFCurveFilterKeySync Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation