Detailed Description

Matrix conversion filter.

Remarks:: The current implementation of this filter expects to process 9 curves.; This is now a deprecated class and should be replaced with its KFbxAnimCurveFilter equivalent.

Definition at line 653 of file kfbxkfcurvefilters.h.

#include <kfbxkfcurvefilters.h>

Inheritance diagram for KFbxKFCurveFilterMatrixConverter:

Public Types
enum	EMatrixID { ePreGlobal, ePreTranslate, ePostTranslate, ePreRotate, ePostRotate, ePreScale, ePostScale, ePostGlobal, eScaleOffset, eInactivePre, eInactivePost, eRotationPivot, eScalingPivot, eMatrixCount }
	Matrix ID ePreGlobal ePreTranslate ePostTranslate ePreRotate ePreScale ePostGlobal eScaleOffset eInactivePre eInactivePost eRotationPivot eScalingPivot eMatrixCount. More...
Public Member Functions
virtual K_DEPRECATED const char *	GetName () const
	Get the name of the filter.
virtual K_DEPRECATED KTime &	GetStartTime ()
	Get the start time for the application of the filter.
virtual K_DEPRECATED void	SetStartTime (KTime &pTime)
	Set the start time for the application of the filter.
virtual K_DEPRECATED KTime &	GetStopTime ()
	Get the stop time for the application of the filter.
virtual K_DEPRECATED void	SetStopTime (KTime &pTime)
	Set the stop time for the application of the filter.
virtual K_DEPRECATED int	GetStartKey (KFbxAnimCurve &pCurve) const
	Get the index of start key on the given curve.
virtual K_DEPRECATED int	GetStopKey (KFbxAnimCurve &pCurve) const
	Get the index of stop key on the given curve.
virtual K_DEPRECATED bool	NeedApply (KFbxAnimStack *pAnimStack)
	This filter expects to works with interdependent curves.
virtual K_DEPRECATED bool	NeedApply (KFbxAnimCurveNode *pCurveNode[3])
	Check if the animation curve nodes need an application of the filter.
virtual K_DEPRECATED bool	NeedApply (KFbxAnimCurve **pCurve, int pCount)
	Check if the given animation curves need an application of the filter.
virtual K_DEPRECATED bool	NeedApply (KFbxAnimCurve &pCurve)
	This filter expects to works with interdependent curves.
virtual K_DEPRECATED KError *	GetError ()
	Retrieve error object.
virtual K_DEPRECATED int	GetLastErrorID () const
	Get last error ID.
virtual K_DEPRECATED const char *	GetLastErrorString () const
	Get last error string.
virtual K_DEPRECATED bool	Apply (KFbxAnimStack *pAnimStack)
	This filter expects to works with interdependent curves.
virtual K_DEPRECATED bool	Apply (KFbxAnimCurveNode *pCurveNode[3])
	Apply filter on all the curves of the animation curve nodes.
virtual K_DEPRECATED bool	Apply (KFbxAnimCurve **pCurve, int pCount)
	Apply filter on the given animation curve.
virtual K_DEPRECATED bool	Apply (KFbxAnimCurve &pCurve)
	This filter expects to works with interdependent curves.
virtual K_DEPRECATED void	Reset ()
	Reset the filter to its default parameters.
K_DEPRECATED void	GetSourceMatrix (EMatrixID pIndex, KFbxXMatrix &pMatrix) const
	Get the Translation Rotation Scaling source matrix.
K_DEPRECATED void	SetSourceMatrix (EMatrixID pIndex, KFbxXMatrix &pMatrix)
	Set the Translation Rotation Scaling source matrix.
K_DEPRECATED void	GetDestMatrix (EMatrixID pIndex, KFbxXMatrix &pMatrix) const
	Get the Translation Rotation Scaling destination matrix.
K_DEPRECATED void	SetDestMatrix (EMatrixID pIndex, KFbxXMatrix &pMatrix)
	Set the Translation Rotation Scaling destination matrix.
K_DEPRECATED KTime	GetResamplingPeriod () const
	Get the resampling period.
K_DEPRECATED void	SetResamplingPeriod (KTime &pResamplingPeriod)
	Set the resampling period.
K_DEPRECATED bool	GetGenerateLastKeyExactlyAtEndTime () const
	Check if the last key is exactly at the end time.
K_DEPRECATED void	SetGenerateLastKeyExactlyAtEndTime (bool pFlag)
	Set the last key to be is exactly at end time or not.
K_DEPRECATED bool	GetResamplingOnFrameRateMultiple () const
	Check if resampling is on frame rate multiple.
K_DEPRECATED void	SetResamplingOnFrameRateMultiple (bool pFlag)
	Set the resample on a frame rate multiple.
K_DEPRECATED bool	GetApplyUnroll () const
	Get if Apply Unroll is used.
K_DEPRECATED void	SetApplyUnroll (bool pFlag)
	Set if Apply Unroll is used.
K_DEPRECATED bool	GetApplyConstantKeyReducer () const
	Get if constant key reducer is used.
K_DEPRECATED void	SetApplyConstantKeyReducer (bool pFlag)
	Set if constant key reducer is used.
K_DEPRECATED bool	GetResampleTranslation () const
	Get if the resample translation is used.
K_DEPRECATED void	SetResampleTranslation (bool pFlag)
	Set the resample translation data.
K_DEPRECATED void	SetSrcRotateOrder (int pOrder)
	Set the rotation order of the source.
K_DEPRECATED void	SetDestRotateOrder (int pOrder)
	Set the rotation order of the destination.
K_DEPRECATED void	SetForceApply (bool pVal)
	Set to force apply even if source and destination matrices are equivalent.
K_DEPRECATED bool	GetForceApply () const
	Get if the force apply is used.
Protected Member Functions
	KFbxKFCurveFilterMatrixConverter (KFbxSdkManager &pManager, char const *pName)
	Constructor.
virtual void	Destruct (bool pRecursive, bool pDependents)
Protected Attributes
KFCurveFilterMatrixConverter *	mDataCurveFilter

Member Enumeration Documentation

enum EMatrixID

Search for all occurrences

Matrix ID

ePreGlobal
ePreTranslate
ePostTranslate
ePreRotate
ePreScale
ePostGlobal
eScaleOffset
eInactivePre
eInactivePost
eRotationPivot
eScalingPivot
eMatrixCount.

Enumerator:

ePreGlobal	Search for all occurrences
ePreTranslate	Search for all occurrences
ePostTranslate	Search for all occurrences
ePreRotate	Search for all occurrences
ePostRotate	Search for all occurrences
ePreScale	Search for all occurrences
ePostScale	Search for all occurrences
ePostGlobal	Search for all occurrences
eScaleOffset	Search for all occurrences
eInactivePre	Search for all occurrences
eInactivePost	Search for all occurrences
eRotationPivot	Search for all occurrences
eScalingPivot	Search for all occurrences
eMatrixCount	Search for all occurrences

Definition at line 781 of file kfbxkfcurvefilters.h.

    {
        ePreGlobal,
        ePreTranslate,
        ePostTranslate,
        ePreRotate,
        ePostRotate,
        ePreScale,
        ePostScale,
        ePostGlobal,
        eScaleOffset,
        eInactivePre,
        eInactivePost,
        eRotationPivot,
        eScalingPivot,
        eMatrixCount
    };

Constructor & Destructor Documentation

KFbxKFCurveFilterMatrixConverter	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

Constructor.

Member Function Documentation

virtual K_DEPRECATED const char* GetName ( ) const [virtual]

Search for all occurrences

Get the name of the filter.

Returns:: Pointer to name.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED KTime& GetStartTime ( ) [virtual]

Search for all occurrences

Get the start time for the application of the filter.

The part of the animation curves before the start time will remain untouched.

Returns:: The time expressed as KTime.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED void SetStartTime ( KTime & pTime ) [virtual]

Search for all occurrences

Set the start time for the application of the filter.

The part of the animation curves before the start time will remain untouched.

Parameters:

pTime The time to be set.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED KTime& GetStopTime ( ) [virtual]

Search for all occurrences

Get the stop time for the application of the filter.

The part of the animation curves after the stop time will remain untouched.

Returns:: The time expressed as KTime.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED void SetStopTime ( KTime & pTime ) [virtual]

Search for all occurrences

Set the stop time for the application of the filter.

The part of the animation curves after the stop time will remain untouched.

Parameters:

pTime The time to be set.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED int GetStartKey ( KFbxAnimCurve & pCurve ) const [virtual]

Search for all occurrences

Get the index of start key on the given curve.

This is the index of the first key after the filter's start time.

Parameters:

pCurve Curve on which we want to retrieve the start key.

Returns:: Index of the start key.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED int GetStopKey ( KFbxAnimCurve & pCurve ) const [virtual]

Search for all occurrences

Get the index of stop key on the given curve.

This is the index of the last key before the filter's stop time.

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 bool NeedApply ( KFbxAnimStack * pAnimStack ) [inline, virtual]

Search for all occurrences

This filter expects to works with 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 705 of file kfbxkfcurvefilters.h.

{ return false; }

virtual K_DEPRECATED bool NeedApply ( KFbxAnimCurveNode * pCurveNode[3] ) [virtual]

Search for all occurrences

Check if the animation curve nodes need an application of the filter.

Parameters:

pCurveNode Curves to test if they needs application of filter

Returns:: true if the animation curve node needs an application of the filter.

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

Search for all occurrences

Check if the given animation curves 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 at least one animation curve in the array needs an application of the filter.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED bool NeedApply ( KFbxAnimCurve & pCurve ) [virtual]

Search for all occurrences

This filter expects to works with interdependent curves.

Receiving one single curve is useless.

Returns:: false

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED KError* GetError ( ) [virtual]

Search for all occurrences

Retrieve error object.

Returns:: Error object.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED int GetLastErrorID ( ) const [virtual]

Search for all occurrences

Get last error ID.

Returns:: Last error ID.

virtual K_DEPRECATED const char* GetLastErrorString ( ) const [virtual]

Search for all occurrences

Get last error string.

Returns:: Last error string.

virtual K_DEPRECATED bool Apply ( KFbxAnimStack * pAnimStack ) [inline, virtual]

Search for all occurrences

This filter expects to works with 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 743 of file kfbxkfcurvefilters.h.

{ return false; }

virtual K_DEPRECATED bool Apply ( KFbxAnimCurveNode * pCurveNode[3] ) [virtual]

Search for all occurrences

Apply filter on all the curves of the animation curve nodes.

Parameters:

pCurveNode Curve node to which the filter is applied.

Returns:: true if the curve filtering operation was successful, false otherwise.

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

Search for all occurrences

Apply filter on the given animation curve.

Parameters:

pCurve	Array of curve to which the filter is applied.
pCount	Number of curves in array.

Returns:: true if the curve filtering operation was successful, false otherwise.

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED bool Apply ( KFbxAnimCurve & pCurve ) [virtual]

Search for all occurrences

This filter expects to works with interdependent curves.

Receiving one single curve is useless.

Returns:: false

Reimplemented from KFbxKFCurveFilter.

virtual K_DEPRECATED void Reset ( ) [virtual]

Search for all occurrences

Reset the filter to its default parameters.

Reimplemented from KFbxKFCurveFilter.

K_DEPRECATED void GetSourceMatrix	(	EMatrixID	pIndex,
		KFbxXMatrix &	pMatrix
	)		const

Search for all occurrences

Get the Translation Rotation Scaling source matrix.

Parameters:

pIndex	The matrix ID.
pMatrix	The matrix used to receive the source matrix.

K_DEPRECATED void SetSourceMatrix	(	EMatrixID	pIndex,
		KFbxXMatrix &	pMatrix
	)

Search for all occurrences

Set the Translation Rotation Scaling source matrix.

Parameters:

pIndex	The matrix ID.
pMatrix	The matrix used to set the source matrix.

K_DEPRECATED void GetDestMatrix	(	EMatrixID	pIndex,
		KFbxXMatrix &	pMatrix
	)		const

Search for all occurrences

Get the Translation Rotation Scaling destination matrix.

Parameters:

pIndex	The matrix ID.
pMatrix	The matrix used to receive the destination matrix.

K_DEPRECATED void SetDestMatrix	(	EMatrixID	pIndex,
		KFbxXMatrix &	pMatrix
	)

Search for all occurrences

Set the Translation Rotation Scaling destination matrix.

Parameters:

pIndex	The matrix ID.
pMatrix	The matrix used to set the destination matrix.

K_DEPRECATED KTime GetResamplingPeriod ( ) const

Search for all occurrences

Get the resampling period.

Returns:: the resampling period.

K_DEPRECATED void SetResamplingPeriod ( KTime & pResamplingPeriod )

Search for all occurrences

Set the resampling period.

Parameters:

pResamplingPeriod The resampling period to be set.

K_DEPRECATED bool GetGenerateLastKeyExactlyAtEndTime ( ) const

Search for all occurrences

Check if the last key is exactly at the end time.

Returns:: true if last key is set exactly at end time.

K_DEPRECATED void SetGenerateLastKeyExactlyAtEndTime ( bool pFlag )

Search for all occurrences

Set the last key to be is exactly at end time or not.

Parameters:

pFlag value to set if last key is set exactly at end time.

K_DEPRECATED bool GetResamplingOnFrameRateMultiple ( ) const

Search for all occurrences

Check if resampling is on frame rate multiple.

Returns:: true if resampling is on a frame rate multiple.

K_DEPRECATED void SetResamplingOnFrameRateMultiple ( bool pFlag )

Search for all occurrences

Set the resample on a frame rate multiple.

Parameters:

pFlag The value to be set

Remarks:: It might be necessary that the starting time of the converted animation starts at an multiple of frame period starting from time 0. Most softwares play their animation at a definite frame rate, starting from time 0. As resampling occurs when we can't guarantee interpolation, keys must match with the moment when the curve is evaluated.

K_DEPRECATED bool GetApplyUnroll ( ) const

Search for all occurrences

Get if Apply Unroll is used.