KFbxKFCurveFilter Class Reference

#include <kfbxkfcurvefilters.h>
Inheritance diagram for KFbxKFCurveFilter:
Inheritance graph
[legend]

List of all members.

Detailed Description

Base class for KFCurveNode and KFCurve filtering.

A class is necessary to hold the parameters of a filtering algorithm. Independent UI can then be attached to those parameters.

Definition at line 72 of file kfbxkfcurvefilters.h.


Public Member Functions
virtual const char *  GetName () const
  Get the Name of the Filter.
virtual KTime &  GetStartTime ()
  Get the Start Time.
virtual void  SetStartTime (KTime &pTime)
  Set the Start Time.
virtual KTime &  GetStopTime ()
  Get the Stop Time.
virtual void  SetStopTime (KTime &pTime)
  Set the Stop Time.
virtual int  GetStartKey (KFbxAnimCurve &pCurve) const
  Get the Start Key.
virtual int  GetStartKey (KFCurve &pCurve) const
  This method is deprecated and should be replaced with a call to GetStartKey(KFbxAnimCurve& .
virtual int  GetStopKey (KFbxAnimCurve &pCurve) const
  Get the Stop Key.
virtual int  GetStopKey (KFCurve &pCurve) const
  This method is deprecated and should be replaced with a call to GetStopKey(KFbxAnimCurve& .
virtual bool  NeedApply (KFbxAnimStack *pAnimStack)
  Check if any curves on the animation stack need 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 KFbxAnimCurveNode need an application of the filter.
virtual bool  NeedApply (KFCurveNode &pCurveNode, bool pRecursive=true)
  This method is deprecated and should be replaced with a call to NeedApply(KFbxAnimCurveNode& .
virtual bool  NeedApply (KFbxAnimCurve **pCurve, int pCount)
  Check if the given KFbxAnimCurve need an application of the filter.
virtual bool  NeedApply (KFCurve **pCurve, int pCount)
  This method is deprecated and should be replaced with a call to NeedApply(KFbxAnimCurve** .
virtual bool  NeedApply (KFbxAnimCurve &pCurve)
  Check if a KFbxAnimCurve need an application of the filter.
virtual bool  Apply (KFbxAnimStack *pAnimStack)
  Apply filter to all the curves stored in the AnimStack.
virtual bool  Apply (KFbxObject *pObj, KFbxAnimStack *pAnimStack)
  Apply filter to all the animated properties of the object.
virtual bool  NeedApply (KFCurve &pCurve)
  This method is deprecated and should be replaced with a call to NeedApply(KFbxAnimCurve& .
virtual bool  Apply (KFbxAnimCurveNode &pCurveNode)
  Apply filter on all the curves of a KFbxAnimCurveNode.
virtual bool  Apply (KFCurveNode &pCurveNode, bool pRecursive=true)
  This method is deprecated and should be replaced with a call to Apply(KFbxAnimCurveNode& .
virtual bool  Apply (KFbxAnimCurve **pCurve, int pCount)
  Apply filter on a number of KFbxAnimCurve.
virtual bool  Apply (KFCurve **pCurve, int pCount)
  This method is deprecated and should be replaced with a call to Apply(KFbxAnimCurve** .
virtual bool  Apply (KFbxAnimCurve &pCurve)
  Apply filter on a KFbxAnimCurve.
virtual bool  Apply (KFCurve &pCurve)
  This method is deprecated and should be replaced with a call to Apply(KFbxAnimCurve& .
virtual void  Reset ()
  Reset default parameters.
virtual KError *  GetError ()
  Retrieve error object.
virtual int  GetLastErrorID ()
  Get last error ID.
virtual char *  GetLastErrorString ()
  Get last error name.

Member Function Documentation

virtual const char* GetName (  )  const [inline, virtual]

Get the Name of the Filter.

Returns:
Pointer to name.

Reimplemented from KFbxObject.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 80 of file kfbxkfcurvefilters.h.

References NULL.

virtual KTime& GetStartTime (  )  [inline, virtual]

Get the Start Time.

Returns:
The time expressed as KTime.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 85 of file kfbxkfcurvefilters.h.

virtual void SetStartTime ( KTime &  pTime  )  [inline, virtual]

Set the Start Time.

Parameters:
pTime  The time to be set.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 90 of file kfbxkfcurvefilters.h.

virtual KTime& GetStopTime (  )  [inline, virtual]

Get the Stop Time.

Returns:
The time expressed as KTime.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 95 of file kfbxkfcurvefilters.h.

virtual void SetStopTime ( KTime &  pTime  )  [inline, virtual]

Set the Stop Time.

Parameters:
pTime  The time to be set.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 100 of file kfbxkfcurvefilters.h.

virtual int GetStartKey ( KFbxAnimCurve &  pCurve  )  const [inline, virtual]

Get the Start Key.

Parameters:
pCurve  Curve on which we want to retrieve the start key.
Returns:
The position of the start key.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 106 of file kfbxkfcurvefilters.h.

virtual int GetStartKey ( KFCurve &  pCurve  )  const [inline, virtual]

This method is deprecated and should be replaced with a call to GetStartKey(KFbxAnimCurve& .

..)

Parameters:
pCurve 

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 111 of file kfbxkfcurvefilters.h.

virtual int GetStopKey ( KFbxAnimCurve &  pCurve  )  const [inline, virtual]

Get the Stop Key.

Parameters:
pCurve  Curve on which we want to retrieve the stop key.
Returns:
The position of the stop key.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 117 of file kfbxkfcurvefilters.h.

virtual int GetStopKey ( KFCurve &  pCurve  )  const [inline, virtual]

This method is deprecated and should be replaced with a call to GetStopKey(KFbxAnimCurve& .

..)

Parameters:
pCurve 

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 122 of file kfbxkfcurvefilters.h.

virtual bool NeedApply ( KFbxAnimStack *  pAnimStack  )  [virtual]

Check if any curves on the animation stack need an application of the filter.

Parameters:
pAnimStack  Animation stack where to retrieve the AnimCurves
Returns:
true if one or more animated properti(es) need an application of the filter.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

virtual bool NeedApply ( KFbxObject *  pObj,
KFbxAnimStack *  pAnimStack  
) [virtual]

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 AnimCurves
Returns:
true if one or more animated properti(es) need an application of the filter.

virtual bool NeedApply ( KFbxAnimCurveNode &  pCurveNode  )  [inline, virtual]

Check if the KFbxAnimCurveNode need an application of the filter.

Parameters:
pCurveNode  Curve to test if it needs application of filter.
Returns:
true if the KFbxAnimCurveNode need an application of the filter.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 141 of file kfbxkfcurvefilters.h.

virtual bool NeedApply ( KFCurveNode &  pCurveNode,
bool  pRecursive = true  
) [inline, virtual]

This method is deprecated and should be replaced with a call to NeedApply(KFbxAnimCurveNode& .

...)

Parameters:
pCurveNode 
pRecursive 

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 147 of file kfbxkfcurvefilters.h.

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

Check if the given KFbxAnimCurve 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 one or more KFbxAnimCurve in the array need an application of the filter.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 154 of file kfbxkfcurvefilters.h.

virtual bool NeedApply ( KFCurve **  pCurve,
int  pCount  
) [inline, virtual]

This method is deprecated and should be replaced with a call to NeedApply(KFbxAnimCurve** .

...)

Parameters:
pCurve 
pCount 

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 160 of file kfbxkfcurvefilters.h.

virtual bool NeedApply ( KFbxAnimCurve &  pCurve  )  [inline, virtual]

Check if a KFbxAnimCurve need an application of the filter.

Parameters:
pCurve  Curve to test if it needs application of filter.
Returns:
true if the KFbxAnimCurve need an application of the filter.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 166 of file kfbxkfcurvefilters.h.

virtual bool Apply ( KFbxAnimStack *  pAnimStack  )  [virtual]

Apply filter to all the curves stored in the AnimStack.

Parameters:
pAnimStack  Animation stack where to retrieve the AnimCurves
Returns:
true if successful, false otherwise.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

virtual bool Apply ( KFbxObject *  pObj,
KFbxAnimStack *  pAnimStack  
) [virtual]

Apply filter to all the animated properties of the object.

Parameters:
pObj  Object containing the properties to apply the filter.
pAnimStack  Animation stack where to retrieve the AnimCurves
Returns:
true if successful, false otherwise.

virtual bool NeedApply ( KFCurve &  pCurve  )  [inline, virtual]

This method is deprecated and should be replaced with a call to NeedApply(KFbxAnimCurve& .

...)

Parameters:
pCurve 

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 184 of file kfbxkfcurvefilters.h.

virtual bool Apply ( KFbxAnimCurveNode &  pCurveNode  )  [inline, virtual]

Apply filter on all the curves of a KFbxAnimCurveNode.

Parameters:
pCurveNode  Curve to apply the filter.
Returns:
true if successful, false otherwise.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 190 of file kfbxkfcurvefilters.h.

virtual bool Apply ( KFCurveNode &  pCurveNode,
bool  pRecursive = true  
) [inline, virtual]

This method is deprecated and should be replaced with a call to Apply(KFbxAnimCurveNode& .

...)

Parameters:
pCurveNode 
pRecursive 

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 196 of file kfbxkfcurvefilters.h.

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

Apply filter on a number of KFbxAnimCurve.

Parameters:
pCurve  Array of curves to apply the filter.
pCount  Number of curves in array to apply the filter.
Returns:
true if successful, false otherwise.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 203 of file kfbxkfcurvefilters.h.

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

This method is deprecated and should be replaced with a call to Apply(KFbxAnimCurve** .

...)

Parameters:
pCurve 
pCount 

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 209 of file kfbxkfcurvefilters.h.

virtual bool Apply ( KFbxAnimCurve &  pCurve  )  [inline, virtual]

Apply filter on a KFbxAnimCurve.

Parameters:
pCurve  Curve to apply the filter.
Returns:
true if successful, false otherwise.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 215 of file kfbxkfcurvefilters.h.

virtual bool Apply ( KFCurve &  pCurve  )  [inline, virtual]

This method is deprecated and should be replaced with a call to Apply(KFbxAnimCurve& .

...)

Parameters:
pCurve 

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 220 of file kfbxkfcurvefilters.h.

virtual void Reset (  )  [inline, virtual]

Reset default parameters.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 224 of file kfbxkfcurvefilters.h.

virtual KError* GetError (  )  [inline, virtual]

Retrieve error object.

Returns:
Error object.

Reimplemented in KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Definition at line 229 of file kfbxkfcurvefilters.h.

References NULL.

virtual int GetLastErrorID (  )  [inline, virtual]

Get last error ID.

Returns:
Last error ID.

Definition at line 234 of file kfbxkfcurvefilters.h.

virtual char* GetLastErrorString (  )  [inline, virtual]

Get last error name.

Returns:
Last error name.

Definition at line 239 of file kfbxkfcurvefilters.h.

References NULL.

KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter
KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter KFbxKFCurveFilter