FbxAnimCurveFilterKeyReducer Class Reference
 
 
 
FbxAnimCurveFilterKeyReducer Class Reference

#include <fbxanimcurvefilters.h>


Class Description

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 529 of file fbxanimcurvefilters.h.

Inheritance diagram for FbxAnimCurveFilterKeyReducer:
FbxAnimCurveFilter

List of all members.

Public Member Functions

  FbxAnimCurveFilterKeyReducer ()
  Constructor.
virtual  ~FbxAnimCurveFilterKeyReducer ()
  Destructor.
virtual const char *  GetName () const
  Get the name of the filter.
virtual bool  Apply (FbxAnimCurve **pCurve, int pCount, FbxStatus *pStatus=NULL)
  Apply filter on the given animation curve.
virtual bool  Apply (FbxAnimCurve &pCurve, FbxStatus *pStatus=NULL)
  Apply filter on an animation curve.
virtual void  Reset ()
  Reset the filter to its default parameters.
double  GetPrecision () const
  Get precision.
void  SetPrecision (double pPrecision)
  Set precision.
bool  GetKeySync () const
  Return true key sync is applied at the end.
void  SetKeySync (bool pKeySync)
  Set to true to apply key sync at the end.

Exposed parent class methods.

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

Constructor.

virtual ~FbxAnimCurveFilterKeyReducer ( ) [inline, virtual]

Destructor.

Definition at line 536 of file fbxanimcurvefilters.h.

{};

Member Function Documentation

virtual const char* GetName ( ) const [virtual]

Get the name of the filter.

Returns:
Pointer to name.

Reimplemented from FbxAnimCurveFilter.

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

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 547 of file fbxanimcurvefilters.h.

{ return FbxAnimCurveFilter::Apply(pAnimStack, pStatus); }
virtual bool Apply ( FbxObject pObj,
FbxAnimStack pAnimStack,
FbxStatus pStatus = NULL 
) [inline, virtual]

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 548 of file fbxanimcurvefilters.h.

{ return FbxAnimCurveFilter::Apply(pObj, pAnimStack, pStatus); }
virtual bool Apply ( FbxAnimCurveNode pCurveNode,
FbxStatus pStatus = NULL 
) [inline, virtual]

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 549 of file fbxanimcurvefilters.h.

{ return FbxAnimCurveFilter::Apply(pCurveNode, pStatus); }
virtual bool Apply ( FbxAnimCurve **  pCurve,
int  pCount,
FbxStatus pStatus = NULL 
) [virtual]

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 pCurve,
FbxStatus pStatus = NULL 
) [virtual]

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 if the curve filtering operation was successful, false otherwise.

Implements FbxAnimCurveFilter.

virtual void Reset ( ) [virtual]

Reset the filter to its default parameters.

Reimplemented from FbxAnimCurveFilter.

double GetPrecision ( ) const
void SetPrecision ( double  pPrecision )

Set precision.

Parameters:
pPrecision The precision to set.
bool GetKeySync ( ) const

Return true key sync is applied at the end.

void SetKeySync ( bool  pKeySync )

Set to true to apply key sync at the end.

Parameters:
pKeySync Key sync flag.

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