KFbxKFCurveFilterScale Class Reference

#include <kfbxkfcurvefilters.h>

Inheritance diagram for KFbxKFCurveFilterScale:

[legend]

List of all members.

---

Detailed Description

Key scale filter.

Filter to scale the keys of a set of function curves.

Definition at line 1902 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 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)
	Check if any curves on the animation stack need an application of the filter.
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)
	Check if a KFbxAnimCurve need an application of the filter.
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)
	Apply filter to all the curves stored in the AnimStack.
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)
	Apply filter on a KFbxAnimCurve.
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.
float	GetScale () const
	GetScale.
void	SetScale (float pScale)
	SetScale.

---

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.

virtual 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]

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

Definition at line 1954 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]

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 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]

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

Definition at line 2006 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]

Apply filter on a KFbxAnimCurve.

Parameters:

pCurve

Curve to apply the filter.

Returns:

true if successful, false otherwise.

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.

float GetScale

(

)

const

GetScale.

Returns:

the current scale factor.

void SetScale

(

float

pScale

)

SetScale.

Parameters:

pScale

The new scale factor.

Returns: