Detailed Description
Re-sampling filter.
Filter to re-sample animation curves.
Definition at line 715 of file fbxanimcurvefilters.h.
#include <fbxanimcurvefilters.h>
Public Member Functions |
|
| FbxAnimCurveFilterResample () | |
| Constructor. |
|
| virtual | ~FbxAnimCurveFilterResample () |
| Destructor. |
|
| virtual const char * | GetName () const |
| Get the name of the filter. |
|
| virtual bool | Apply (FbxAnimCurve &pCurve) |
| Apply the filter on an animation curve.
|
|
| virtual void | Reset () |
| Reset the filter to its default parameters.
|
|
| void | SetKeysOnFrame (bool pKeysOnFrame) |
| Set if the keys are on frame. |
|
| bool | GetKeysOnFrame () const |
| Get if the keys are on frame. |
|
| FbxTime | GetPeriodTime () const |
| Get the re-sampling period. |
|
| void | SetPeriodTime (FbxTime &pPeriod) |
| Set the re-sampling period. |
|
| bool | GetIntelligentMode () const |
| Get the mode that determines how the
re-sample filter will set the interpolation and tangent of each
key. |
|
| void | SetIntelligentMode (bool pIntelligent) |
| Set the mode that determines how the
re-sample filter will set the interpolation and tangent of each
key. |
|
Exposed parent class methods. |
|
| virtual bool | Apply (FbxAnimStack *pAnimStack) |
| Apply filter to all the curves stored in the
animation stack. |
|
| virtual bool | Apply (FbxObject *pObj, FbxAnimStack *pAnimStack) |
| Apply filter to all the animated properties
of the object. |
|
| virtual bool | Apply (FbxAnimCurveNode &pCurveNode) |
| Apply filter on all the curves of an
animation curve node. |
|
| virtual bool | Apply (FbxAnimCurve **pCurve, int pCount) |
| Apply filter on an array of animation
curves. |
|
Constructor & Destructor Documentation
Constructor.
| virtual ~FbxAnimCurveFilterResample | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual const char* GetName | ( | ) | const [virtual] |
| virtual bool Apply | ( | FbxAnimStack * | pAnimStack | ) | [inline, virtual] |
Apply filter to all the curves stored in the animation stack.
- Parameters:
-
pAnimStack Animation stack where to retrieve the animation curves
- Returns:
trueif the curve filtering operation was successful,falseotherwise.
Reimplemented from FbxAnimCurveFilter.
Definition at line 733 of file fbxanimcurvefilters.h.
{ return FbxAnimCurveFilter::Apply(pAnimStack); }
| virtual bool Apply | ( | FbxObject * | pObj, |
| FbxAnimStack * | pAnimStack | ||
| ) | [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
- Returns:
trueif the curve filtering operation was successful,falseotherwise.
Reimplemented from FbxAnimCurveFilter.
Definition at line 734 of file fbxanimcurvefilters.h.
{ return FbxAnimCurveFilter::Apply(pObj, pAnimStack); }
| virtual bool Apply | ( | FbxAnimCurveNode & | pCurveNode | ) | [inline, virtual] |
Apply filter on all the curves of an animation curve node.
- Parameters:
-
pCurveNode Curve node to which the filter is applied.
- Returns:
trueif the curve filtering operation was successful,falseotherwise.
- Remarks:
- This method collects all the FbxAnimCurve objects connected to the curve node and calls Apply(FbxAnimCurve**, int)
Reimplemented from FbxAnimCurveFilter.
Definition at line 735 of file fbxanimcurvefilters.h.
{ return FbxAnimCurveFilter::Apply(pCurveNode); }
| virtual bool Apply | ( | FbxAnimCurve ** | pCurve, |
| int | pCount | ||
| ) | [inline, virtual] |
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:
trueif the curve filtering operation was successful,falseotherwise.
Reimplemented from FbxAnimCurveFilter.
Definition at line 736 of file fbxanimcurvefilters.h.
{ return FbxAnimCurveFilter::Apply(pCurve, pCount); }
| virtual bool Apply | ( | FbxAnimCurve & | pCurve | ) | [virtual] |
Apply the filter on an animation curve.
- Parameters:
-
pCurve Curve to which the filter is applied.
- Returns:
trueif the curve filtering operation was successful,falseotherwise.
Implements FbxAnimCurveFilter.
| virtual void Reset | ( | ) | [virtual] |
Reset the filter to its default parameters.
Reimplemented from FbxAnimCurveFilter.
| void SetKeysOnFrame | ( | bool | pKeysOnFrame | ) |
Set if the keys are on frame.
- Parameters:
-
pKeysOnFrame value if keys are set on frame multiples.
| bool GetKeysOnFrame | ( | ) | const |
Get if the keys are on frame.
- Returns:
- Value if keys are on frame multiples.
| FbxTime GetPeriodTime | ( | ) | const |
| void SetPeriodTime | ( | FbxTime & | pPeriod | ) |
Set the re-sampling period.
- Parameters:
-
pPeriod The re-sampling period to be set.
| bool GetIntelligentMode | ( | ) | const |
Get the mode that determines how the re-sample filter will set the interpolation and tangent of each key.
- Returns:
trueif the intelligent mode is on,falseotherwise.
- Remarks:
- If intelligent mode is on, interpolation type and tangent mode of each created curve key are set equal to the interpolation type and tangent mode of the closest curve key encountered. If intelligent mode is off, the interpolation type of each created curve key will always be set to CUBIC, and tangent mode will always be set to AUTO.
| void SetIntelligentMode | ( | bool | pIntelligent | ) |
Set the mode that determines how the re-sample filter will set the interpolation and tangent of each key.
- Parameters:
-
pIntelligent true, set interpolation type and tangent mode of each created curve key equal to the interpolation type and tangent mode of the closest curve key encountered.false, always set the interpolation type of each created curve key to CUBIC, and always set the tangent mode to AUTO.
The documentation for this class was generated from the following file:
- fbxsdk/scene/animation/fbxanimcurvefilters.h
