KFbxKFCurveFilterMatrixConverter Class Reference

#include <kfbxkfcurvefilters.h>
Inheritance diagram for KFbxKFCurveFilterMatrixConverter:
Inheritance graph
[legend]

List of all members.

Detailed Description

Matrix conversion filter.
Remarks:
The current implementation of this filter expects to process 9 curves.

Definition at line 677 of file kfbxkfcurvefilters.h.


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 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)
  This filter expects to works with interdependent curves.
virtual bool  NeedApply (KFbxAnimCurveNode *pCurveNode[3])
  Check if the KFbxAnimCurveNodes 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 KFbxAnimCurves 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 interdependent curves.
virtual bool  Apply (KFbxAnimCurveNode *pCurveNode[3])
  Apply filter on all the curves of the KFbxAnimCurveNodes.
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.
void  GetSourceMatrix (EMatrixID pIndex, KFbxXMatrix &pMatrix) const
  Get the Translation Rotation Scaling source matrix.
void  SetSourceMatrix (EMatrixID pIndex, KFbxXMatrix &pMatrix)
  Set the Translation Rotation Scaling source matrix.
void  GetDestMatrix (EMatrixID pIndex, KFbxXMatrix &pMatrix) const
  Get the Translation Rotation Scaling destination matrix.
void  SetDestMatrix (EMatrixID pIndex, KFbxXMatrix &pMatrix)
  Set the Translation Rotation Scaling destination matrix.
KTime  GetResamplingPeriod () const
  Get the Resampling Period.
void  SetResamplingPeriod (KTime &pResamplingPeriod)
  Set the Resampling period.
bool  GetGenerateLastKeyExactlyAtEndTime () const
  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 () const
  Check if resampling is on frame rate multiple.
void  SetResamplingOnFrameRateMultiple (bool pFlag)
  Set the resample on a frame rate multiple.
bool  GetApplyUnroll () const
  Get if Apply Unroll is used.
void  SetApplyUnroll (bool pFlag)
  Set if Apply Unroll is used.
bool  GetApplyConstantKeyReducer () const
  Get if constant key reducer is used.
void  SetApplyConstantKeyReducer (bool pFlag)
  Set if constant key reducer is used.
bool  GetResampleTranslation () const
  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 () const
  Get if the force apply is used.

Member Enumeration Documentation

enum EMatrixID

Matrix ID

  • ePreGlobal
  • ePreTranslate
  • ePostTranslate
  • ePreRotate
  • ePreScale
  • ePostGlobal
  • eScaleOffset
  • eInactivePre
  • eInactivePost
  • eRotationPivot
  • eScalingPivot
  • eMatrixCount.
Enumerator:
ePreGlobal 
ePreTranslate 
ePostTranslate 
ePreRotate 
ePostRotate 
ePreScale 
ePostScale 
ePostGlobal 
eScaleOffset 
eInactivePre 
eInactivePost 
eRotationPivot 
eScalingPivot 
eMatrixCount 

Definition at line 836 of file kfbxkfcurvefilters.h.

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]

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 731 of file kfbxkfcurvefilters.h.

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

Check if the KFbxAnimCurveNodes 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.

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 KFbxAnimCurves 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 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 783 of file kfbxkfcurvefilters.h.

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

Apply filter on all the curves of the KFbxAnimCurveNodes.

Parameters:
pCurveNode  Curve to apply the filter.
Returns:
true if successful, false otherwise.

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.

void GetSourceMatrix ( EMatrixID  pIndex,
KFbxXMatrix &  pMatrix  
) const

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  
) const

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.

KTime GetResamplingPeriod (  )  const

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 (  )  const

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

Returns:
true if 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 (  )  const

Check if resampling is on frame rate multiple.

Returns:
true if 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 guarantee interpolation, keys must match with the moment when the curve is evaluated.

bool GetApplyUnroll (  )  const

Get if Apply Unroll is used.

Returns:
true if unroll is applied.

void SetApplyUnroll ( bool  pFlag  ) 

Set if Apply Unroll is used.

Parameters:
pFlag  Value to set

bool GetApplyConstantKeyReducer (  )  const

Get if constant key reducer is used.

Returns:
true if constant key reducer is applied.

void SetApplyConstantKeyReducer ( bool  pFlag  ) 

Set if constant key reducer is used.

Parameters:
pFlag  value to set

bool GetResampleTranslation (  )  const

Get if the Resample Translation is used.

Returns:
true if 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 (  )  const

Get if the force apply is used.

Returns:
true if the force apply is used
KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter
KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter KFbxKFCurveFilterMatrixConverter