KFbxAnimCurveFilterResample Class Reference

Search for all occurrences

---

Detailed Description

Resampling filter.

Filter to resample animation curves.

Definition at line 691 of file kfbxanimcurvefilters.h.

#include <kfbxanimcurvefilters.h>

Inheritance diagram for KFbxAnimCurveFilterResample:

List of all members.

Public Member Functions
	KFbxAnimCurveFilterResample ()
	Constructor.
virtual	~KFbxAnimCurveFilterResample ()
	Destructor.
virtual const char *	GetName () const
	Get the name of the filter.
virtual bool	Apply (KFbxAnimCurve &pCurve)
	Apply 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.
KTime	GetPeriodTime () const
	Get the Resampling period.
void	SetPeriodTime (KTime &pPeriod)
	Set the Resampling Period.
bool	GetIntelligentMode () const
	Get the Intelligent Mode.
void	SetIntelligentMode (bool pIntelligent)
	Set the Intelligent Mode.
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 (KFbxAnimCurveNode &pCurveNode)
	Apply filter on all the curves of an animation curve node.
virtual bool	Apply (KFbxAnimCurve **pCurve, int pCount)
	Apply filter on an array of animation curves.

---

Constructor & Destructor Documentation

KFbxAnimCurveFilterResample

(

)

Constructor.

virtual ~KFbxAnimCurveFilterResample

(

)

[inline, virtual]

Destructor.

Definition at line 698 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 709 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 710 of file kfbxanimcurvefilters.h.

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

virtual bool Apply

(

KFbxAnimCurveNode &

pCurveNode

)

[inline, 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.

Definition at line 711 of file kfbxanimcurvefilters.h.

{ return KFbxAnimCurveFilter::Apply(pCurveNode); }

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 712 of file kfbxanimcurvefilters.h.

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

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.

void SetKeysOnFrame

(

bool

pKeysOnFrame

)

Search for all occurrences

Set if the keys are on frame.

Parameters:

pKeysOnFrame

value if keys are set on frame multiples.

bool GetKeysOnFrame

(

)

const

Search for all occurrences

Get if the keys are on frame.

Returns:

Value if keys are on frame multiples.

KTime GetPeriodTime

(

)

const

Search for all occurrences

Get the Resampling period.

Returns:

The Resampling period

void SetPeriodTime

(

KTime &

pPeriod

)

Search for all occurrences

Set the Resampling Period.

Parameters:

pPeriod

The Resampling Period to be set

bool GetIntelligentMode

(

)

const

Search for all occurrences

Get the Intelligent Mode.

Returns:

the Intelligent Mode

void SetIntelligentMode

(

bool

pIntelligent

)

Search for all occurrences

Set the Intelligent Mode.

Parameters:

pIntelligent

the Intelligent Mode to be set

---

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

• fbxfilesdk/kfbxplugins/kfbxanimcurvefilters.h