FBFCurveKey Class Reference
 
 
 
FBFCurveKey Class Reference

#include <fbdata.h>


Class Description

KeyFrame for an FCurve.

Definition at line 167 of file fbdata.h.

Public Member Functions

  FBFCurveKey (::KFCurve *pFCurve=NULL, int pKeyIndex=1)
  Constructor.
  FBFCurveKey (const FBFCurveKey &pFCurveKey)
  Constructor.
  ~FBFCurveKey ()
  Destructor.
bool  operator== (const FBFCurveKey &pValue) const
  Overloaded == operator.

Public Attributes

FBPropertyFloat  Value
  Read Write Property: Value of Key
FBPropertyFloat  LeftDerivative
  Read Write Property: Left derivative, in units/seconds.
FBPropertyFloat  RightDerivative
  Read Write Property: Right derivative, in units/seconds.
FBPropertyFloat  LeftTangentWeight
  Read Write Property: Left tangent weight
FBPropertyFloat  RightTangentWeight
  Read Write Property: Right tangent weight
FBPropertyFloat  LeftBezierTangent
  Read Write Property: Left bezier tangent
FBPropertyFloat  RightBezierTangent
  Read Write Property: Right bezier tangent
FBPropertyFloat  Tension
  Read Write Property: Tension (TCB).
FBPropertyFloat  Continuity
  Read Write Property: Continuity (TCB).
FBPropertyFloat  Bias
  Read Write Property: Bias (TCB).
FBPropertyTime  Time
  Read Write Property: Time of key.
FBPropertyInterpolation  Interpolation
  Read Write Property: Type of interpolation.
FBPropertyTangentMode  TangentMode
  Read Write Property: Tangeant calculation method.
FBPropertyTangentClampMode  TangentClampMode
  Read Write Property: Tangent's clamp method.
FBPropertyBool  TangentBreak
  Read Write Property: Tangent's break status
FBPropertyTangentConstantMode  TangentConstantMode
  Read Write Property: Tangent's constant mode

Friends

class  FBFCurve
class  FBPropertyListFCurveKey

Constructor & Destructor Documentation

FBFCurveKey::FBFCurveKey ( ::KFCurve *  pFCurve = NULL,
int  pKeyIndex = 1 
)

Constructor.

Parameters:
pFCurve Parent FCurve (default is NULL).
pKeyIndex Key frame index (default is 1).
FBFCurveKey::FBFCurveKey ( const FBFCurveKey pFCurveKey )

Constructor.

Parameters:
pFCurveKey FCurveKey to copy information from.
FBFCurveKey::~FBFCurveKey ( )

Destructor.


Member Function Documentation

bool FBFCurveKey::operator== ( const FBFCurveKey pValue ) const

Overloaded == operator.

Parameters:
pValue FCurveKey to compare with.
Returns:
true if equal.
Warning:
. The overload of the == operator will always return false.

Friends And Related Function Documentation

friend class FBFCurve [friend]

Definition at line 225 of file fbdata.h.

friend class FBPropertyListFCurveKey [friend]

Definition at line 226 of file fbdata.h.


Member Data Documentation

Read Write Property: Value of Key

Definition at line 205 of file fbdata.h.

Read Write Property: Left derivative, in units/seconds.

Definition at line 206 of file fbdata.h.

Read Write Property: Right derivative, in units/seconds.

Definition at line 207 of file fbdata.h.

Read Write Property: Left tangent weight

Definition at line 208 of file fbdata.h.

Read Write Property: Right tangent weight

Definition at line 209 of file fbdata.h.

Read Write Property: Left bezier tangent

Definition at line 210 of file fbdata.h.

Read Write Property: Right bezier tangent

Definition at line 211 of file fbdata.h.

Read Write Property: Tension (TCB).

Definition at line 214 of file fbdata.h.

Read Write Property: Continuity (TCB).

Definition at line 215 of file fbdata.h.

Read Write Property: Bias (TCB).

Definition at line 216 of file fbdata.h.

Read Write Property: Time of key.

Definition at line 218 of file fbdata.h.

FBPropertyInterpolation FBFCurveKey::Interpolation

Read Write Property: Type of interpolation.

Definition at line 219 of file fbdata.h.

FBPropertyTangentMode FBFCurveKey::TangentMode

Read Write Property: Tangeant calculation method.

Definition at line 220 of file fbdata.h.

FBPropertyTangentClampMode FBFCurveKey::TangentClampMode

Read Write Property: Tangent's clamp method.

Definition at line 221 of file fbdata.h.

Read Write Property: Tangent's break status

Definition at line 222 of file fbdata.h.

FBPropertyTangentConstantMode FBFCurveKey::TangentConstantMode

Read Write Property: Tangent's constant mode

Definition at line 223 of file fbdata.h.


The documentation for this class was generated from the following file: