#include<kfbxkfcurvefilters.h>

Inheritance diagram for KFbxKFCurveFilterMatrixConverter:

Detailed Description

Matrix conversion filter.

Definition at line372of filekfbxkfcurvefilters.h.


Public Types
enum	EMatrixID
	Matrix ID ePreGlobal ePreTranslate ePostTranslate ePreRotate ePreScale ePostGlobal eScaleOffset eInactivePre eInactivePost eRotationPivot eScalingPivot eMatrixCount. More...
Public Member Functions
const char *	GetName()
	Get the Name of the Filter.
KTime&	GetStartTime()
	Get the Start Time.
void	SetStartTime(KTime&pTime)
	Set the Start Time.
KTime&	GetStopTime()
	Get the Stop Time.
void	SetStopTime(KTime&pTime)
	Set the Stoping Time.
int	GetStartKey(KFCurve&pCurve)
	Get the Start Key.
int	GetStopKey(KFCurve&pCurve)
	Get the Stop Key.
bool	NeedApply(KFCurveNode&pCurveNode, bool pRecursive=true)
	Check if theKFCurveNodeneeds an application of the filter.
bool	NeedApply(KFCurve**pCurve, int pCount)
	Check if oneKFCurvein an array needs an application of the filter.
bool	NeedApply(KFCurve&pCurve)
	Check if aKFCurveneed an application of the filter.
KError&	GetError()
	Retrieve error object.
int	GetLastErrorID() const
	Get last error ID.
const char *	GetLastErrorString() const
	Get last error name.
bool	Apply(KFCurveNode&pCurveNode, bool pRecursive=true)
	Apply filter on aKFCurveNode.
bool	Apply(KFCurve**pCurve, int pCount)
	Apply filter on a number ofKFCurve.
bool	Apply(KFCurve&pCurve)
	Apply filter on aKFCurve.
void	Reset()
	Reset default parameters.
void	GetSourceMatrix(EMatrixIDpIndex,KFbxXMatrix&pMatrix)
	Get the Translation Rotation Scaling source matrix.
void	SetSourceMatrix(EMatrixIDpIndex,KFbxXMatrix&pMatrix)
	Set the Translation Rotation Scaling source matrix.
void	GetDestMatrix(EMatrixIDpIndex,KFbxXMatrix&pMatrix)
	Get the Translation Rotation Scaling destination matrix.
void	SetDestMatrix(EMatrixIDpIndex,KFbxXMatrix&pMatrix)
	Set the Translation Rotation Scaling destination matrix.
KTime	GetResamplingPeriod()
	Get the Resampling Period.
void	SetResamplingPeriod(KTime&pResamplingPeriod)
	Set the Resampling period.
bool	GetGenerateLastKeyExactlyAtEndTime()
	Check if the last key is exactly at the end time.
void	SetGenerateLastKeyExactlyAtEndTime(bool pFlag)
	Set the last key to be is exactly at end time or not.
bool	GetResamplingOnFrameRateMultiple()
	Check if resampling is on frame rate multiple.
void	SetResamplingOnFrameRateMultiple(bool pFlag)
	Set the resample on a frame rate multiple.
bool	GetApplyUnroll()
	Get if Apply Unroll is used.
void	SetApplyUnroll(bool pFlag)
	Set if Apply Unroll is used.
bool	GetApplyConstantKeyReducer()
	Get if constant key reducer is used.
void	SetApplyConstantKeyReducer(bool pFlag)
	Set if constant key reducer is used.
bool	GetResampleTranslation()
	Get if the Resample Translation is used.
void	SetResampleTranslation(bool pFlag)
	Set the resample translation data.
void	SetSrcRotateOrder(int pOrder)
	Set the Rotation Order of the Source.
void	SetDestRotateOrder(int pOrder)
	Set the Rotation Order of the Destination.
void	SetForceApply(bool pVal)
	Set to force apply even if source and destination matrices are equivalent.
bool	GetForceApply()
	Get if the force apply is used.

Member Enumeration Documentation

enumEMatrixID

Matrix ID

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

Definition at line488of filekfbxkfcurvefilters.h.

Member Function Documentation

const char* GetName ( ) [virtual]

Get the Name of the Filter.

Returns:: Pointer to name

Reimplemented fromKFbxKFCurveFilters.

KTime&GetStartTime ( ) [virtual]

Get the Start Time.

Returns:: The time expressed asKTime.

Reimplemented fromKFbxKFCurveFilters.

void SetStartTime ( KTime& pTime ) [virtual]

Set the Start Time.

Parameters:

pTime

the time to be set

Reimplemented fromKFbxKFCurveFilters.

KTime&GetStopTime ( ) [virtual]

Get the Stop Time.

Returns:: The time expressed asKTime.

Reimplemented fromKFbxKFCurveFilters.

void SetStopTime ( KTime& pTime ) [virtual]

Set the Stoping Time.

Parameters:

pTime

the time to be set

Reimplemented fromKFbxKFCurveFilters.

int GetStartKey ( KFCurve& pCurve ) [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 fromKFbxKFCurveFilters.

int GetStopKey ( KFCurve& pCurve ) [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 fromKFbxKFCurveFilters.

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

Check if theKFCurveNodeneeds an application of the filter.

Parameters:

	pCurveNode	Curve to test if it needs application of filter
	pRecursive	Check recursively through the Curve

Returns:: trueif theKFCurveNodeneeds an application of the filter.

Reimplemented fromKFbxKFCurveFilters.

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

Check if oneKFCurvein an array needs an application of the filter.

Parameters:

	pCurve	Array of Curves to test if it needs application of filter
	pCount	Number of Curves in array to test

Returns:: trueif oneKFCurvein an array need an application of the filter.

Reimplemented fromKFbxKFCurveFilters.

bool NeedApply ( KFCurve& pCurve ) [virtual]

Check if aKFCurveneed an application of the filter.

Parameters:

pCurve

Curve to test if it needs application of filter

Returns:: trueif theKFCurveneed an application of the filter.

Reimplemented fromKFbxKFCurveFilters.

KError&GetError ( ) [virtual]

Retrieve error object.

Returns:: Error object.

Reimplemented fromKFbxKFCurveFilters.

int GetLastErrorID ( ) const

Get last error ID.

Returns:: Last error ID.

const char* GetLastErrorString ( ) const

Get last error name.

Returns:: Last error name.

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

Apply filter on aKFCurveNode.

Parameters:

	pCurveNode	Curve to apply the filter
	pRecursive	Apply recursively through the Curve

Returns:: trueif successful,falseotherwise.

Reimplemented fromKFbxKFCurveFilters.

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

Apply filter on a number ofKFCurve.

Parameters:

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

Returns:: trueif successful,falseotherwise.

Reimplemented fromKFbxKFCurveFilters.

bool Apply ( KFCurve& pCurve ) [virtual]

Apply filter on aKFCurve.

Parameters:

pCurve

Curve to apply the filter

Returns:: trueif successful,falseotherwise.

Reimplemented fromKFbxKFCurveFilters.

void Reset ( ) [virtual]

Reset default parameters.

Reimplemented fromKFbxKFCurveFilters.

void GetSourceMatrix	(	EMatrixID	pIndex,
		KFbxXMatrix&	pMatrix
	)

Get the Translation Rotation Scaling source matrix.

Parameters:

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

void SetSourceMatrix	(	EMatrixID	pIndex,
		KFbxXMatrix&	pMatrix
	)

Set the Translation Rotation Scaling source matrix.

Parameters:

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

void GetDestMatrix	(	EMatrixID	pIndex,
		KFbxXMatrix&	pMatrix
	)

Get the Translation Rotation Scaling destination matrix.

Parameters:

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

void SetDestMatrix	(	EMatrixID	pIndex,
		KFbxXMatrix&	pMatrix
	)

Set the Translation Rotation Scaling destination matrix.

Parameters:

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

KTimeGetResamplingPeriod ( )

Get the Resampling Period.

Returns:: the Resampling Period.

void SetResamplingPeriod ( KTime& pResamplingPeriod )

Set the Resampling period.

Parameters:

pResamplingPeriod

The Resampling Period to be set.

bool GetGenerateLastKeyExactlyAtEndTime ( )

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

Returns:: trueif last key is set exactly at end time.

void SetGenerateLastKeyExactlyAtEndTime ( bool pFlag )

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.

bool GetResamplingOnFrameRateMultiple ( )

Check if resampling is on frame rate multiple.

Returns:: trueif resampling is on a frame rate multiple.

void SetResamplingOnFrameRateMultiple ( bool pFlag )

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 garantee interpolation, keys must match with the moment when the curve is evaluated.

bool GetApplyUnroll ( )

Get if Apply Unroll is used.

Returns:: trueif unroll is applied.

void SetApplyUnroll ( bool pFlag )

Set if Apply Unroll is used.

Parameters:

pFlag

Value to set

bool GetApplyConstantKeyReducer ( )

Get if constant key reducer is used.

Returns:: trueif constant key reducer is applied.

void SetApplyConstantKeyReducer ( bool pFlag )

Set if constant key reducer is used.

Parameters:

pFlag

value to set

bool GetResampleTranslation ( )

Get if the Resample Translation is used.

Returns:: trueif translation data is resampled upon conversion.

Remarks:: If this flag isn't set, translation data must be calculated after the conversion process, overriding the resampling process.

void SetResampleTranslation ( bool pFlag )

Set the resample translation data.

Parameters:

pFlag

Value to be set.

Remarks:: If this flag isn't set, translation data must be calculated after the conversion process, overriding the resampling process.

void SetSrcRotateOrder ( int pOrder )

Set the Rotation Order of the Source.

Parameters:

pOrder

the order to be set

void SetDestRotateOrder ( int pOrder )

Set the Rotation Order of the Destination.

Parameters:

pOrder

the order to be set

void SetForceApply ( bool pVal )

Set to force apply even if source and destination matrices are equivalent.

Parameters:

pVal

If the forces apply is to be used

bool GetForceApply ( )

Get if the force apply is used.

Returns:: trueif the force apply is used

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation