KFbxAnimCurveKeyImpl Class Reference

#include <kfbxanimcurve.h>
Inheritance diagram for KFbxAnimCurveKeyImpl:
Inheritance graph
[legend]

List of all members.

Detailed Description

Interface for animation key objects.

Users always use KFbxAnimCurveKey. A KFbxAnimCurveKey points to a KFbxAnimCurveKeyImpl. See KFbxAnimCurveKFCurveKey for an example of implemented class.

Definition at line 165 of file kfbxanimcurve.h.


Public Member Functions
virtual  ~KFbxAnimCurveKeyImpl ()
  destructor.
virtual KFbxAnimCurveKeyImpl &  operator= (const KFbxAnimCurveKeyImpl &pFKey)=0
  Assignment operator.
virtual void  Set (KTime pTime, float pValue)=0
  Set time and value of key.
virtual void  SetTCB (KTime pTime, float pValue, float pData0=0.0f, float pData1=0.0f, float pData2=0.0f)=0
  Set a key with cubic interpolation, TCB tangent mode.
virtual float  GetValue () const =0
  Get key value.
virtual void  SetValue (float pValue)=0
  Set key value.
virtual
KFbxAnimCurveDef::EInterpolationType 		 GetInterpolation () const =0
  Get key interpolation.
virtual void  SetInterpolation (KFbxAnimCurveDef::EInterpolationType pInterpolation)=0
  Set key interpolation.
virtual
KFbxAnimCurveDef::ETangentMode 		 GetTangentMode (bool pIncludeOverrides=false) const =0
  Get tangent mode.
virtual void  SetTangentMode (KFbxAnimCurveDef::ETangentMode pTangentMode)=0
  Set tangent mode.
virtual
KFbxAnimCurveDef::EWeightedMode 		 GetTangentWeightMode () const =0
  Get key tangent weight mode.
virtual void  SetTangentWeightMode (KFbxAnimCurveDef::EWeightedMode pTangentWeightMode, KFbxAnimCurveDef::EWeightedMode pMask=KFbxAnimCurveDef::eWEIGHTED_ALL)=0
  Set key tangent weight mode as double value (cubic interpolation, non TCB tangent mode).
virtual
KFbxAnimCurveDef::EVelocityMode 		 GetTangentVelocityMode () const =0
  Get key tangent velocity mode.
virtual void  SetTangentVelocityMode (KFbxAnimCurveDef::EVelocityMode pTangentVelocityMode, KFbxAnimCurveDef::EVelocityMode pMask=KFbxAnimCurveDef::eVELOCITY_ALL)=0
  Set key tangent velocity mode as double value (cubic interpolation, non TCB tangent mode).
virtual
KFbxAnimCurveDef::EConstantMode 		 GetConstantMode () const =0
  Get key constant mode.
virtual void  SetConstantMode (KFbxAnimCurveDef::EConstantMode pMode)=0
  Set constant mode.
virtual float  GetDataFloat (KFbxAnimCurveDef::EKFbxAnimCurveDataIndex pIndex) const =0
  Get data float.
virtual void  SetDataFloat (KFbxAnimCurveDef::EKFbxAnimCurveDataIndex pIndex, float pValue)=0
  Set data float.
virtual void  SetTangentVisibility (KFbxAnimCurveDef::ETangentVisibility pVisibility)=0
  Set tangent visibility mode.
virtual
KFbxAnimCurveDef::ETangentVisibility 		 GetTangentVisibility () const =0
  Return tangent visibility mode.
virtual void  SetBreak (bool pVal)=0
  Set/Unset Break tangent Only valid for User and Auto keys.
virtual bool  GetBreak () const =0
  Get if tangent is break Only valid for User and Auto keys.

Constructor & Destructor Documentation

virtual ~KFbxAnimCurveKeyImpl (  )  [inline, virtual]

destructor.

Definition at line 170 of file kfbxanimcurve.h.

Member Function Documentation

virtual KFbxAnimCurveKeyImpl& operator= ( const KFbxAnimCurveKeyImpl &  pFKey  )  [pure virtual]

Assignment operator.

Implemented in KFbxAnimCurveKFCurveKey.

virtual void Set ( KTime  pTime,
float  pValue  
) [pure virtual]

Set time and value of key.

Parameters:
pTime  New time of this key.
pValue  New value of this key.

Implemented in KFbxAnimCurveKFCurveKey.

virtual void SetTCB ( KTime  pTime,
float  pValue,
float  pData0 = 0.0f,
float  pData1 = 0.0f,
float  pData2 = 0.0f  
) [pure virtual]

Set a key with cubic interpolation, TCB tangent mode.

Parameters:
pTime  Key time.
pValue  Key value.
pData0  Tension.
pData1  Continuity.
pData2  Bias.

Implemented in KFbxAnimCurveKFCurveKey.

virtual float GetValue (  )  const [pure virtual]

Get key value.

Returns:
Key value.

Implemented in KFbxAnimCurveKFCurveKey.

virtual void SetValue ( float  pValue  )  [pure virtual]

Set key value.

Parameters:
pValue  Key value to set.

Implemented in KFbxAnimCurveKFCurveKey.

virtual KFbxAnimCurveDef::EInterpolationType GetInterpolation (  )  const [pure virtual]

Get key interpolation.

Returns:
Key interpolation.

Implemented in KFbxAnimCurveKFCurveKey.

virtual void SetInterpolation ( KFbxAnimCurveDef::EInterpolationType  pInterpolation  )  [pure virtual]

Set key interpolation.

Parameters:
pInterpolation  Interpolation type to set.

Implemented in KFbxAnimCurveKFCurveKey.

virtual KFbxAnimCurveDef::ETangentMode GetTangentMode ( bool  pIncludeOverrides = false  )  const [pure virtual]

Get tangent mode.

Returns:
Tangent mode.

Implemented in KFbxAnimCurveKFCurveKey.

Referenced by KFbxAnimCurveKFCurveKey::GetDataFloat(), and KFbxAnimCurveKFCurveKey::SetDataFloat().

virtual void SetTangentMode ( KFbxAnimCurveDef::ETangentMode  pTangentMode  )  [pure virtual]

Set tangent mode.

Parameters:
pTangentMode  Tangent mode to set.

Implemented in KFbxAnimCurveKFCurveKey.

virtual KFbxAnimCurveDef::EWeightedMode GetTangentWeightMode (  )  const [pure virtual]

Get key tangent weight mode.

Warning: This method is meaningful for cubic interpolation only. Tangent weight modes are: KFCURVE_WEIGHTED_NONE, KFCURVE_WEIGHTED_RIGHT, KFCURVE_WEIGHTED_NEXT_LEFT, KFCURVE_WEIGHTED_ALL

Implemented in KFbxAnimCurveKFCurveKey.

virtual void SetTangentWeightMode ( KFbxAnimCurveDef::EWeightedMode  pTangentWeightMode,
KFbxAnimCurveDef::EWeightedMode  pMask = KFbxAnimCurveDef::eWEIGHTED_ALL  
) [pure virtual]

Set key tangent weight mode as double value (cubic interpolation, non TCB tangent mode).

Warning: This method is meaningful for cubic interpolation only.

Parameters:
pTangentWeightMode  Weight mode KFCURVE_WEIGHTED_NONE KFCURVE_WEIGHTED_RIGHT KFCURVE_WEIGHTED_NEXT_LEFT KFCURVE_WEIGHTED_ALL
pMask  Used to select the affected tangents KFCURVE_WEIGHTED_RIGHT KFCURVE_WEIGHTED_NEXT_LEFT KFCURVE_WEIGHTED_ALL

Implemented in KFbxAnimCurveKFCurveKey.

virtual KFbxAnimCurveDef::EVelocityMode GetTangentVelocityMode (  )  const [pure virtual]

Get key tangent velocity mode.

Warning: This method is meaningful for cubic interpolation only. Tangent weight modes are: KFCURVE_VELOCITY_NONE, KFCURVE_VELOCITY_RIGHT, KFCURVE_VELOCITY_NEXT_LEFT, KFCURVE_VELOCITY_ALL

Implemented in KFbxAnimCurveKFCurveKey.

virtual void SetTangentVelocityMode ( KFbxAnimCurveDef::EVelocityMode  pTangentVelocityMode,
KFbxAnimCurveDef::EVelocityMode  pMask = KFbxAnimCurveDef::eVELOCITY_ALL  
) [pure virtual]

Set key tangent velocity mode as double value (cubic interpolation, non TCB tangent mode).

Warning: This method is meaningful for cubic interpolation only.

Parameters:
pTangentVelocityMode  Weight mode KFCURVE_VELOCITY_NONE KFCURVE_VELOCITY_RIGHT KFCURVE_VELOCITY_NEXT_LEFT KFCURVE_VELOCITY_ALL
pMask  Used to select the affected tangents KFCURVE_VELOCITY_RIGHT KFCURVE_VELOCITY_NEXT_LEFT KFCURVE_VELOCITY_ALL

Implemented in KFbxAnimCurveKFCurveKey.

virtual KFbxAnimCurveDef::EConstantMode GetConstantMode (  )  const [pure virtual]

Get key constant mode.

Warning: This method is meaningful for constant interpolation only. Using this method for non constant interpolated key will return unpredicted value. Constant modes are: KFCURVE_CONSTANT_STANDARD KFCURVE_CONSTANT_NEXT

Returns:
Key constant mode.

Implemented in KFbxAnimCurveKFCurveKey.

virtual void SetConstantMode ( KFbxAnimCurveDef::EConstantMode  pMode  )  [pure virtual]

Set constant mode.

Parameters:
pMode  Constant mode to set.

Implemented in KFbxAnimCurveKFCurveKey.

virtual float GetDataFloat ( KFbxAnimCurveDef::EKFbxAnimCurveDataIndex  pIndex  )  const [pure virtual]

Get data float.

Parameters:
pIndex  Data index, dependent on the key tangent mode.
Returns:
Data value.

Implemented in KFbxAnimCurveKFCurveKey.

virtual void SetDataFloat ( KFbxAnimCurveDef::EKFbxAnimCurveDataIndex  pIndex,
float  pValue  
) [pure virtual]

Set data float.

Parameters:
pIndex  Data index, dependent on the key tangent mode.
pValue  Data value to set.

Implemented in KFbxAnimCurveKFCurveKey.

virtual void SetTangentVisibility ( KFbxAnimCurveDef::ETangentVisibility  pVisibility  )  [pure virtual]

Set tangent visibility mode.

Warning: This method is meaningful for cubic interpolation only.

Parameters:
pVisibility  Tangent visibility mode. Tangent visibility modes are: KFCURVE_TANGEANT_SHOW_NONE KFCURVE_TANGEANT_SHOW_LEFT KFCURVE_TANGEANT_SHOW_RIGHT

Implemented in KFbxAnimCurveKFCurveKey.

virtual KFbxAnimCurveDef::ETangentVisibility GetTangentVisibility (  )  const [pure virtual]

Return tangent visibility mode.

Warning: This method is meaningful for cubic interpolation only.

Returns:
Tangent visibility mode. Tangent visibility modes are: KFCURVE_TANGEANT_SHOW_NONE KFCURVE_TANGEANT_SHOW_LEFT KFCURVE_TANGEANT_SHOW_RIGHT

Implemented in KFbxAnimCurveKFCurveKey.

virtual void SetBreak ( bool  pVal  )  [pure virtual]

Set/Unset Break tangent Only valid for User and Auto keys.

Parameters:
pVal  The break flag.

Implemented in KFbxAnimCurveKFCurveKey.

virtual bool GetBreak (  )  const [pure virtual]

Get if tangent is break Only valid for User and Auto keys.

Implemented in KFbxAnimCurveKFCurveKey.

KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl
KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl KFbxAnimCurveKeyImpl