FBFCurveKey Class Reference

FBFCurveKey Class Reference

#include <fbdata.h>

Class Description

KeyFrame for an FCurve.

Definition at line 224 of file fbdata.h.

Public Member Functions

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

Public Attributes

FBPropertyFloat Value
 Read Write Property: Value of Key More...
 
FBPropertyFloat LeftDerivative
 Read Write Property: Left derivative, in units/seconds. More...
 
FBPropertyFloat RightDerivative
 Read Write Property: Right derivative, in units/seconds. More...
 
FBPropertyFloat LeftTangentWeight
 Read Write Property: Left tangent weight More...
 
FBPropertyFloat RightTangentWeight
 Read Write Property: Right tangent weight More...
 
FBPropertyFloat LeftBezierTangent
 Read Write Property: Left bezier tangent More...
 
FBPropertyFloat RightBezierTangent
 Read Write Property: Right bezier tangent More...
 
FBPropertyFloat Tension
 Read Write Property: Tension (TCB). More...
 
FBPropertyFloat Continuity
 Read Write Property: Continuity (TCB). More...
 
FBPropertyFloat Bias
 Read Write Property: Bias (TCB). More...
 
FBPropertyTime Time
 Read Write Property: Time of key. More...
 
FBPropertyInterpolation Interpolation
 Read Write Property: Type of interpolation. More...
 
FBPropertyTangentMode TangentMode
 Read Write Property: Tangent calculation method. More...
 
FBPropertyTangentClampMode TangentClampMode
 Read Write Property: Tangent's clamp method. More...
 
FBPropertyBool TangentBreak
 Read Write Property: Tangent's break status More...
 
FBPropertyTangentConstantMode TangentConstantMode
 Read Write Property: Tangent's constant mode More...
 
FBPropertyTangentWeightMode TangentWeightMode
 Read Write Property: Tangent's weight mode. More...
 
FBPropertyExtrapolationMode ExtrapolationMode
 Read Write Property: Extrapolation mode More...
 
FBPropertyTangentCustomIndex TangentCustomIndex
 Read Write Property: Tangent's custom index More...
 
FBPropertyBool Selected
 Read Write Property: Is the key selected. More...
 
FBPropertyBool MarkedForManipulation
 Read Write Property: Is the key marked for manipulation. More...
 

Friends

class FBFCurve
 
class FBPropertyListFCurveKey
 

Constructor & Destructor Documentation

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

Constructor.

Parameters
pFCurveParent FCurve (default is NULL).
pKeyIndexKey frame index (default is 1).
FBFCurveKey ( const FBFCurveKey pFCurveKey)

Constructor.

Parameters
pFCurveKeyFCurveKey to copy information from.

Destructor.

Member Function Documentation

bool operator== ( const FBFCurveKey pValue) const

Overloaded == operator.

Parameters
pValueFCurveKey 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 288 of file fbdata.h.

friend class FBPropertyListFCurveKey
friend

Definition at line 289 of file fbdata.h.

Member Data Documentation

Read Write Property: Bias (TCB).

Definition at line 273 of file fbdata.h.

FBPropertyFloat Continuity

Read Write Property: Continuity (TCB).

Definition at line 272 of file fbdata.h.

FBPropertyExtrapolationMode ExtrapolationMode

Read Write Property: Extrapolation mode

Definition at line 282 of file fbdata.h.

FBPropertyInterpolation Interpolation

Read Write Property: Type of interpolation.

Definition at line 276 of file fbdata.h.

FBPropertyFloat LeftBezierTangent

Read Write Property: Left bezier tangent

Definition at line 267 of file fbdata.h.

FBPropertyFloat LeftDerivative

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

Definition at line 263 of file fbdata.h.

FBPropertyFloat LeftTangentWeight

Read Write Property: Left tangent weight

Definition at line 265 of file fbdata.h.

FBPropertyBool MarkedForManipulation

Read Write Property: Is the key marked for manipulation.

Definition at line 286 of file fbdata.h.

FBPropertyFloat RightBezierTangent

Read Write Property: Right bezier tangent

Definition at line 268 of file fbdata.h.

FBPropertyFloat RightDerivative

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

Definition at line 264 of file fbdata.h.

FBPropertyFloat RightTangentWeight

Read Write Property: Right tangent weight

Definition at line 266 of file fbdata.h.

FBPropertyBool Selected

Read Write Property: Is the key selected.

Definition at line 285 of file fbdata.h.

FBPropertyBool TangentBreak

Read Write Property: Tangent's break status

Definition at line 279 of file fbdata.h.

FBPropertyTangentClampMode TangentClampMode

Read Write Property: Tangent's clamp method.

Definition at line 278 of file fbdata.h.

FBPropertyTangentConstantMode TangentConstantMode

Read Write Property: Tangent's constant mode

Definition at line 280 of file fbdata.h.

FBPropertyTangentCustomIndex TangentCustomIndex

Read Write Property: Tangent's custom index

Definition at line 283 of file fbdata.h.

FBPropertyTangentMode TangentMode

Read Write Property: Tangent calculation method.

Definition at line 277 of file fbdata.h.

FBPropertyTangentWeightMode TangentWeightMode

Read Write Property: Tangent's weight mode.

Setting the value for LeftTangentWeight/RightTangentWeight will also activate the weight for that part. Please see the note provided with FBTangentWeightMode for the left weight of a key.

Definition at line 281 of file fbdata.h.

FBPropertyFloat Tension

Read Write Property: Tension (TCB).

Definition at line 271 of file fbdata.h.

Read Write Property: Time of key.

Definition at line 275 of file fbdata.h.

Read Write Property: Value of Key

Definition at line 262 of file fbdata.h.


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