FCurve class.
Public Member Functions | |
__init__ (object pObject=None) | |
Constructor. | |
FBDelete () | |
Virtual FBDelete function. | |
float | Evaluate (FBTime pTime) |
Evaluate FCurve at pTime. | |
EditBegin (int pKeyCount=-1) | |
Setup function to begin adding keys. | |
EditEnd (int pKeyCount=-1) | |
End key adding sequence. | |
EditClear () | |
Empty FCurve of all keys. | |
int | KeyAdd (FBTime pTime, float pValue, FBInterpolation pInterpolation=kFBInterpolationCubic, FBTangentMode pTangentMode=kFBTangentModeAuto) |
Add a key at the specified time. | |
bool | KeyRemove (int pIndex) |
Remove key at index. | |
bool | KeyDelete (int pStartIndex, int pStopIndex) |
Delete keys within an index range. | |
bool | KeyDelete (FBTime pStart=FBTime::MinusInfinity, FBTime pStop=FBTime::Infinity, bool pInclusive=False) |
Delete keys within a time range. | |
KeyInsert (FBTime pTime, FBInterpolation pInterpolation=kFBInterpolationCubic, FBTangentMode pTangentMode=kFBTangentModeAuto) | |
Insert a key without affecting the curve shape. | |
KeyReplaceBy (FBFCurve pSource, FBTime pStart=FBTime::MinusInfinity, FBTime pStop=FBTime::Infinity, bool pUseExactGivenSpan=False, bool pKeyStartEndOnNoKey=True) | |
Replace keys within a range in current function curve with keys found in a source function curve. | |
Replace (FBFCurve pSource, FBTime pStart=FBTime::MinusInfinity, FBTime pStop=FBTime::Infinity, bool pUseExactGivenSpan=False, bool pKeyStartEndOnNoKey=True) | |
Replace keys within a range in current function curve with keys found in a source function curve. | |
FBFCurve | CreateInterpolatorCurve (FBInterpolatorCurveType pCurveType) |
Create and interpolator curve. | |
Public Attributes | |
FBPropertyListFCurveKey | Keys |
List: Keys. |
__init__ | ( | object | pObject = None | ) |
Constructor.
pObject | For internal use only (default is NULL). |
Reimplemented from FBComponent.
FBDelete | ( | ) |
Evaluate FCurve at pTime.
pTime | Time at which FCurve is to be evaluated. |
EditBegin | ( | int | pKeyCount = -1 | ) |
Setup function to begin adding keys.
pKeyCount | Key to begin adding at(default is -1). |
EditEnd | ( | int | pKeyCount = -1 | ) |
End key adding sequence.
pKeyCount | Key to finish adding at (default is -1). |
EditClear | ( | ) |
Empty FCurve of all keys.
int KeyAdd | ( | FBTime | pTime, |
float | pValue, | ||
FBInterpolation | pInterpolation = kFBInterpolationCubic , |
||
FBTangentMode | pTangentMode = kFBTangentModeAuto |
||
) |
Add a key at the specified time.
pTime | Time at which to insert the key. |
pValue | Value of the key. |
pInterpolation | Interpolation type of the inserted key, default value is Cubic interpolation. |
pTangentMode | Tangent calculation method of the inserted key, default value is Auto (Smooth). |
Remove key at index.
pIndex | Index of the key to remove. |
Delete keys within an index range.
Index range is inclusive. This function is much faster than multiple removes.
pStartIndex | Index of first deleted key. |
pStopIndex | Index of last deleted key. |
true
if the function curve contains keys, false
otherwise.bool KeyDelete | ( | FBTime | pStart = FBTime::MinusInfinity , |
FBTime | pStop = FBTime::Infinity , |
||
bool | pInclusive = False |
||
) |
Delete keys within a time range.
This function is much faster than multiple removes.
pStart | Start of time range. |
pStop | End of time range. |
pInclusive | Time range include the keys at pStart and pStop if true. |
true
if the function curve contains keys, false
otherwise. KeyInsert | ( | FBTime | pTime, |
FBInterpolation | pInterpolation = kFBInterpolationCubic , |
||
FBTangentMode | pTangentMode = kFBTangentModeAuto |
||
) |
Insert a key without affecting the curve shape.
pTime | Time at which the key is to be inserted. |
pInterpolation | Interpolation type of the inserted key, default value is Cubic interpolation. |
pTangentMode | Tangent calculation method of the inserted key, default value is Auto (Smooth). |
KeyReplaceBy | ( | FBFCurve | pSource, |
FBTime | pStart = FBTime::MinusInfinity , |
||
FBTime | pStop = FBTime::Infinity , |
||
bool | pUseExactGivenSpan = False , |
||
bool | pKeyStartEndOnNoKey = True |
||
) |
Replace keys within a range in current function curve with keys found in a source function curve.
pSource | Source function curve. |
pStart | Start of time range. |
pStop | End of time range. |
pUseExactGivenSpan | When false , the time of the first and last key in the range will be used. |
pKeyStartEndOnNoKey | When true , inserts a key at the beginning and at the end of the range if there is no key to insert. |
Replace | ( | FBFCurve | pSource, |
FBTime | pStart = FBTime::MinusInfinity , |
||
FBTime | pStop = FBTime::Infinity , |
||
bool | pUseExactGivenSpan = False , |
||
bool | pKeyStartEndOnNoKey = True |
||
) |
Replace keys within a range in current function curve with keys found in a source function curve.
pSource | Source function curve. |
pStart | Start of time range. |
pStop | End of time range. |
pUseExactGivenSpan | When false , the time of the first and last key in the range will be used. |
pKeyStartEndOnNoKey | When true , inserts a key at the beginning and at the end of the range if there is no key to insert. |
FBFCurve CreateInterpolatorCurve | ( | FBInterpolatorCurveType | pCurveType | ) |
Create and interpolator curve.
pCurveType | Interpolator curve type to create. |
List: Keys.