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

Definition at line 246 of file kfbxanimcurvefilters.h.

#include <kfbxanimcurvefilters.h>

Inheritance diagram for KFbxAnimCurveFilterConstantKeyReducer:

List of all members.

Public Member Functions
	KFbxAnimCurveFilterConstantKeyReducer ()
	Constructor.
virtual	~KFbxAnimCurveFilterConstantKeyReducer ()
	Destructor.
virtual const char *	GetName () const
	Get the name of the filter.
virtual bool	Apply (KFbxAnimCurveNode &pCurveNode)
	Apply filter on all the curves of an animation curve node.
virtual bool	Apply (KFbxAnimCurve &pCurve)
	Apply filter on an animation curve.
virtual void	Reset ()
	Reset the filter to its default parameters.
double	GetDerivativeTolerance () const
	Get the derivative tolerance.
void	SetDerivativeTolerance (double pValue)
	Set the derivative tolerance.
double	GetValueTolerance () const
	Get the tolerance value.
void	SetValueTolerance (double pValue)
	Set the tolerance value.
bool	GetKeepFirstAndLastKeys () const
	Get the state of the KeepFirstAndLastKeys flag.
void	SetKeepFirstAndLastKeys (bool pKeepFirstAndLastKeys)
	Set the state of the KeepFirstAndLastKeys flag.
bool	GetKeepOneKey () const
	Get the state of the KeepOneKey flag.
void	SetKeepOneKey (bool pKeepOneKey)
	Set the state of the KeepOneKey flag.
void	SetKeepNotPureAutoKeys (bool pKeep)
	Tell the filter keep cubic curve keys which are not pure auto.
void	SetTranslationThreshold (double pTranslationThreshold)
void	SetRotationThreshold (double pRotationThreshold)
void	SetScalingThreshold (double pScalingThreshold)
void	SetDefaultThreshold (double pDefaultThreshold)
void	SetModes (bool pExporting, KFbxIOSettings &pIOS)
Exposed parent class methods
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 (KFbxAnimCurve **pCurve, int pCount)
	Apply filter on an array of animation curves.

---

Constructor & Destructor Documentation

KFbxAnimCurveFilterConstantKeyReducer

(

)

Constructor.

virtual ~KFbxAnimCurveFilterConstantKeyReducer

(

)

[inline, virtual]

Destructor.

Definition at line 253 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 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 264 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 265 of file kfbxanimcurvefilters.h.

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

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

Search for all occurrences

Apply filter on an array of animation curves.

Parameters:

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

Returns:

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

Reimplemented from KFbxAnimCurveFilter.

Definition at line 266 of file kfbxanimcurvefilters.h.

{ return KFbxAnimCurveFilter::Apply(pCurve, pCount); }

virtual 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:

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

Reimplemented from KFbxAnimCurveFilter.

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

Implements KFbxAnimCurveFilter.

virtual void Reset

(

)

[virtual]

Search for all occurrences

Reset the filter to its default parameters.

Reimplemented from KFbxAnimCurveFilter.

double GetDerivativeTolerance

(

)

const

Search for all occurrences

Get the derivative tolerance.

Returns:

The value of the derivative tolerance.

void SetDerivativeTolerance

(

double

pValue

)

Search for all occurrences

Set the derivative tolerance.

Parameters:

pValue

Value derivative tolerance.

double GetValueTolerance

(

)

const

Search for all occurrences

Get the tolerance value.

Returns:

The tolerance value.

void SetValueTolerance

(

double

pValue

)

Search for all occurrences

Set the tolerance value.

Parameters:

pValue

Tolerance value.

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.

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.

bool GetKeepOneKey

(

)

const

Search for all occurrences

Get the state of the KeepOneKey flag.

Returns:

true if the filter keeps one keys.

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.

void SetKeepNotPureAutoKeys

(

bool

pKeep

)

Search for all occurrences

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

Parameters:

pKeep

KeepNotPureAutoKeys flag.

void SetTranslationThreshold

(

double

pTranslationThreshold

)

Search for all occurrences

void SetRotationThreshold

(

double

pRotationThreshold

)

Search for all occurrences

void SetScalingThreshold

(

double

pScalingThreshold

)

Search for all occurrences

void SetDefaultThreshold

(

double

pDefaultThreshold

)

Search for all occurrences

void SetModes	(	bool	pExporting,
		KFbxIOSettings &	pIOS
	)

Search for all occurrences

---

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

• fbxfilesdk/kfbxplugins/kfbxanimcurvefilters.h