KFbxKFCurveFilterConstantKeyReducer Class Reference

Search for all occurrences

---

Detailed Description

Constant Key reducing filter.

Filter to test if each key is really necessary to define the curve at a definite degree of precision. It filters recursively from the strongest difference first. All useless keys are eliminated.

Remarks:

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

Definition at line 459 of file kfbxkfcurvefilters.h.

#include <kfbxkfcurvefilters.h>

Inheritance diagram for KFbxKFCurveFilterConstantKeyReducer:

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.
K_DEPRECATED double	GetDerivativeTolerance () const
	Get the derivative tolerance.
K_DEPRECATED void	SetDerivativeTolerance (double pValue)
	Set the derivative tolerance.
K_DEPRECATED double	GetValueTolerance () const
	Get the tolerance value.
K_DEPRECATED void	SetValueTolerance (double pValue)
	Set the tolerance value.
K_DEPRECATED bool	GetKeepFirstAndLastKeys () const
	Get the state of the KeepFirstAndLastKeys flag.
K_DEPRECATED void	SetKeepFirstAndLastKeys (bool pKeepFirstAndLastKeys)
	Set the state of the KeepFirstAndLastKeys flag.
K_DEPRECATED bool	GetKeepOneKey () const
	Get the state of the KeepOneKey flag.
K_DEPRECATED void	SetKeepOneKey (bool pKeepOneKey)
	Set the state of the KeepOneKey flag.
K_DEPRECATED void	SetKeepNotPureAutoKeys (bool pKeep)
	Tell the filter keep cubic curve keys which are not pure auto.
K_DEPRECATED void	SetTranslationThreshold (double pTranslationThreshold)
K_DEPRECATED void	SetRotationThreshold (double pRotationThreshold)
K_DEPRECATED void	SetScalingThreshold (double pScalingThreshold)
K_DEPRECATED void	SetDefaultThreshold (double pDefaultThreshold)
Protected Member Functions
	KFbxKFCurveFilterConstantKeyReducer (KFbxSdkManager &pManager, char const *pName)
	Constructor.
virtual void	Destruct (bool pRecursive, bool pDependents)
Protected Attributes
KFCurveFilterConstantKeyReducer *	mDataCurveFilter

---

Constructor & Destructor Documentation

KFbxKFCurveFilterConstantKeyReducer	(	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 510 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.

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

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.

K_DEPRECATED double GetDerivativeTolerance

(

)

const

Search for all occurrences

Get the derivative tolerance.

Returns:

The value of the derivative tolerance.

K_DEPRECATED void SetDerivativeTolerance

(

double

pValue

)

Search for all occurrences

Set the derivative tolerance.

Parameters:

pValue

Value derivative tolerance.

K_DEPRECATED double GetValueTolerance

(

)

const

Search for all occurrences

Get the tolerance value.

Returns:

The tolerance value.

K_DEPRECATED void SetValueTolerance

(

double

pValue

)

Search for all occurrences

Set the tolerance value.

Parameters:

pValue

Tolerance value.

K_DEPRECATED bool GetKeepFirstAndLastKeys

(

)

const

Search for all occurrences

Get the state of the KeepFirstAndLastKeys flag.

Returns:

true if the filter keeps the first and last keys.

K_DEPRECATED void SetKeepFirstAndLastKeys

(

bool

pKeepFirstAndLastKeys

)

Search for all occurrences

Set the state of the KeepFirstAndLastKeys flag.

Parameters:

pKeepFirstAndLastKeys

Set to true if you want the filter to keep the first and last keys.

K_DEPRECATED bool GetKeepOneKey

(

)

const

Search for all occurrences

Get the state of the KeepOneKey flag.

Returns:

true if the filter keeps one keys.

K_DEPRECATED void SetKeepOneKey

(

bool

pKeepOneKey

)

Search for all occurrences

Set the state of the KeepOneKey flag.

Parameters:

pKeepOneKey

Set to true if you want the filter to keep one key.

K_DEPRECATED void SetKeepNotPureAutoKeys

(

bool

pKeep

)

Search for all occurrences

Tell the filter keep cubic curve keys which are not pure auto.

Parameters:

pKeep

KeepNotPureAutoKeys flag.

K_DEPRECATED void SetTranslationThreshold

(

double

pTranslationThreshold

)

Search for all occurrences

K_DEPRECATED void SetRotationThreshold

(

double

pRotationThreshold

)

Search for all occurrences

K_DEPRECATED void SetScalingThreshold

(

double

pScalingThreshold

)

Search for all occurrences

K_DEPRECATED void SetDefaultThreshold

(

double

pDefaultThreshold

)

Search for all occurrences

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

Search for all occurrences

Reimplemented from KFbxObject.

---

Member Data Documentation

KFCurveFilterConstantKeyReducer* mDataCurveFilter [protected]

Search for all occurrences

Definition at line 639 of file kfbxkfcurvefilters.h.

---

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

• fbxfilesdk/kfbxplugins/kfbxkfcurvefilters.h