KFbxKFCurveFilterUnroll Class Reference

#include <kfbxkfcurvefilters.h>

Inheritance diagram for KFbxKFCurveFilterUnroll:

[legend]

List of all members.

---

Detailed Description

Unroll filter.

Remarks:

The current implementation of this filter expects to process 3 curves.

Definition at line 1186 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.
void	SetStartTime (KTime &pTime)
	Set the Start Time.
virtual KTime &	GetStopTime ()
	Get the Stop Time.
virtual void	SetStopTime (KTime &pTime)
	Set the Stopping Time.
virtual int	GetStartKey (KFbxAnimCurve &pCurve) const
	Get the Start Key.
virtual K_DEPRECATED 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 K_DEPRECATED int	GetStopKey (KFCurve &pCurve) const
	This method is deprecated and should be replaced with a call to GetStopKey(KFbxAnimCurve& .
virtual bool	NeedApply (KFbxAnimStack *pAnimStack)
	This filter expects to works with 3 interdependent curves.
virtual bool	NeedApply (KFbxAnimCurveNode &pCurveNode)
	Check if the KFbxAnimCurveNode need an application of the filter.
virtual K_DEPRECATED 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 K_DEPRECATED 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)
	This filter expects to works with interdependent curves.
virtual K_DEPRECATED bool	NeedApply (KFCurve &pCurve)
	This method is deprecated and should be replaced with a call to NeedApply(KFbxAnimCurve& .
virtual KError *	GetError ()
	Retrieve error object.
virtual int	GetLastErrorID () const
	Get last error ID.
virtual const char *	GetLastErrorString () const
	Get last error name.
virtual bool	Apply (KFbxAnimStack *pAnimStack)
	This filter expects to works with 3 interdependent curves.
virtual bool	Apply (KFbxAnimCurveNode &pCurveNode)
	Apply filter on all the curves of a KFbxAnimCurveNode.
virtual K_DEPRECATED 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 the given KFbxAnimCurve.
virtual K_DEPRECATED 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)
	This filter expects to works with interdependent curves.
virtual K_DEPRECATED bool	Apply (KFCurve &pCurve)
	This method is deprecated and should be replaced with a call to Apply(KFbxAnimCurve& .
virtual void	Reset ()
	Reset default parameters.
double	GetQualityTolerance () const
	Get quality tolerance.
void	SetQualityTolerance (double pQualityTolerance)
	Set quality tolerance.
bool	GetTestForPath () const
	Get if the test path is enabled.
void	SetTestForPath (bool pTestForPath)
	Set if the test path is enabled.
void	SetRotationOrder (int pOrder)

---

Member Function Documentation

virtual const char* GetName

(

)

const [virtual]

Get the Name of the Filter.

Returns:

Pointer to name.

Reimplemented from KFbxKFCurveFilter.

virtual KTime& GetStartTime

(

)

[virtual]

Get the Start Time.

Returns:

The time expressed as KTime.

Reimplemented from KFbxKFCurveFilter.

void SetStartTime

(

KTime &

pTime

)

[virtual]

Set the Start Time.

Parameters:

pTime

The time to be set.

Reimplemented from KFbxKFCurveFilter.

virtual KTime& GetStopTime

(

)

[virtual]

Get the Stop Time.

Returns:

The time expressed as KTime.

Reimplemented from KFbxKFCurveFilter.

virtual void SetStopTime

(

KTime &

pTime

)

[virtual]

Set the Stopping Time.

Parameters:

pTime

The time to be set.

Reimplemented from KFbxKFCurveFilter.

virtual int GetStartKey

(

KFbxAnimCurve &

pCurve

)

const [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 from KFbxKFCurveFilter.

virtual K_DEPRECATED int GetStartKey

(

KFCurve &

pCurve

)

const [virtual]

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

..)

Parameters:

pCurve

Reimplemented from KFbxKFCurveFilter.

virtual int GetStopKey

(

KFbxAnimCurve &

pCurve

)

const [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 from KFbxKFCurveFilter.

virtual K_DEPRECATED int GetStopKey

(

KFCurve &

pCurve

)

const [virtual]

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

..)

Parameters:

pCurve

Reimplemented from KFbxKFCurveFilter.

virtual bool NeedApply

(

KFbxAnimStack *

pAnimStack

)

[inline, virtual]

This filter expects to works with 3 interdependent curves.

Passing the animation stack makes no sense since this object would not know which curves to handle.

Parameters:

pAnimStack

Animation stack

Returns:

false.

Reimplemented from KFbxKFCurveFilter.

Definition at line 1240 of file kfbxkfcurvefilters.h.

virtual bool NeedApply

(

KFbxAnimCurveNode &

pCurveNode

)

[virtual]

Check if the KFbxAnimCurveNode need an application of the filter.

Parameters:

pCurveNode

Curves to test if they needs application of filter

Returns:

true if the KFbxAnimCurveNode need an application of the filter.

Reimplemented from KFbxKFCurveFilter.

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

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

..)

Parameters:

	pCurveNode
	pRecursive

Reimplemented from KFbxKFCurveFilter.

virtual bool NeedApply	(	KFbxAnimCurve **	pCurve,
		int	pCount
	)			[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 an array need an application of the filter.

Reimplemented from KFbxKFCurveFilter.

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

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

..)

Parameters:

	pCurve
	pCount

Reimplemented from KFbxKFCurveFilter.

virtual bool NeedApply

(

KFbxAnimCurve &

pCurve

)

[virtual]

This filter expects to works with interdependent curves.

Receiving one single curve is useless.

Returns:

false

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED bool NeedApply

(

KFCurve &

pCurve

)

[virtual]

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

..)

Parameters:

pCurve

Reimplemented from KFbxKFCurveFilter.

virtual KError* GetError

(

)

[virtual]

Retrieve error object.

Returns:

Error object.

Reimplemented from KFbxKFCurveFilter.

virtual int GetLastErrorID

(

)

const [virtual]

Get last error ID.

Returns:

Last error ID.

virtual const char* GetLastErrorString

(

)

const [virtual]

Get last error name.

Returns:

Last error name.

virtual bool Apply

(

KFbxAnimStack *

pAnimStack

)

[inline, virtual]

This filter expects to works with 3 interdependent curves.

Passing the animation stack makes no sense since this object would not know which curves to handle.

Parameters:

pAnimStack

Animation stack

Returns:

false.

Reimplemented from KFbxKFCurveFilter.

Definition at line 1292 of file kfbxkfcurvefilters.h.

virtual bool Apply

(

KFbxAnimCurveNode &

pCurveNode

)

[virtual]

Apply filter on all the curves of a KFbxAnimCurveNode.

Parameters:

pCurveNode

Curve to apply the filter.

Returns:

true if successful, false otherwise.

Reimplemented from KFbxKFCurveFilter.

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

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

..)

Parameters:

	pCurveNode
	pRecursive

Reimplemented from KFbxKFCurveFilter.

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

Apply filter on the given KFbxAnimCurve.

Parameters:

	pCurve	Array of Curve to apply the filter.
	pCount	Number of Curves in array.

Returns:

true if successful, false otherwise.

Reimplemented from KFbxKFCurveFilter.

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

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

..)

Parameters:

	pCurve
	pCount

Reimplemented from KFbxKFCurveFilter.

virtual bool Apply

(

KFbxAnimCurve &

pCurve

)

[virtual]

This filter expects to works with interdependent curves.

Receiving one single curve is useless.

Returns:

false

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED bool Apply

(

KFCurve &

pCurve

)

[virtual]

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

..)

Parameters:

pCurve

Reimplemented from KFbxKFCurveFilter.

virtual void Reset

(

)

[virtual]

Reset default parameters.

Reimplemented from KFbxKFCurveFilter.

double GetQualityTolerance

(

)

const

Get quality tolerance.

Returns:

The Quality Tolerance

void SetQualityTolerance

(

double

pQualityTolerance

)

Set quality tolerance.

Parameters:

pQualityTolerance

Value to be set.

bool GetTestForPath

(

)

const

Get if the test path is enabled.

Returns:

true if test for path is enabled.

void SetTestForPath

(

bool

pTestForPath

)

Set if the test path is enabled.

Parameters:

pTestForPath

Value to set if test for path is to be enabled.

void SetRotationOrder

(

int

pOrder

)