FCurve class. More...

Public Member Functions | |
| FBFCurve () | |
| Constructor. More... | |
| FBFCurve | CreateInterpolatorCurve (FBInterpolatorCurveType pCurveType) |
| Create and interpolator curve. More... | |
| EditBegin (int pKeyCount=-1) | |
| Setup function to begin adding keys. More... | |
| EditClear () | |
| Empty FCurve of all keys. More... | |
| EditEnd (int pKeyCount=-1) | |
| End key adding sequence. More... | |
| float | Evaluate (FBTime pTime) |
| Evaluate FCurve at pTime. More... | |
| int | GetPostExtrapolationCount () |
| Get count for post extrapolation. More... | |
| FBExtrapolationMode | GetPostExtrapolationMode () |
| Get modes for post extrapolation. More... | |
| int | GetPreExtrapolationCount () |
| Get count for pre extrapolation. More... | |
| FBExtrapolationMode | GetPreExtrapolationMode () |
| Get modes for pre extrapolation. More... | |
| int | KeyAdd (FBTime pTime, float pValue, FBInterpolation pInterpolation=kFBInterpolationCubic, FBTangentMode pTangentMode=kFBTangentModeAuto) |
| Add a key at the specified time. More... | |
| bool | KeyDelete (int pStartIndex, int pStopIndex) |
| Delete keys within an index range. More... | |
| bool | KeyDelete (FBTime pStart=FBTime::MinusInfinity, FBTime pStop=FBTime::Infinity, bool pInclusive=False) |
| Delete keys within a time range. More... | |
| FBInterpolation | KeyGetInterpolation (int pIndex) |
| Get the key interpolation type at the specified index. More... | |
| float | KeyGetLeftBezierTangent (int pIndex) |
| Get the key left bezier tangent value at the specified index. More... | |
| float | KeyGetLeftDerivative (int pIndex) |
| Get the key left derivative value at the specified index. More... | |
| float | KeyGetLeftTangentWeight (int pIndex) |
| Get the key left tangent weight at the specified index. More... | |
| bool | KeyGetMarkedForManipulation (int pIndex) |
| Get the key manipulation state. More... | |
| float | KeyGetRightBezierTangent (int pIndex) |
| Get the key right bezier tangent value at the specified index. More... | |
| float | KeyGetRightDerivative (int pIndex) |
| Get the key right derivative value at the specified index. More... | |
| float | KeyGetRightTangentWeight (int pIndex) |
| Get the key right tangent weight at the specified index. More... | |
| bool | KeyGetSelected (int pIndex) |
| Get the key selected state. More... | |
| float | KeyGetTCBBias (int pIndex) |
| Get the key bias value at the specified index (TCB key). More... | |
| float | KeyGetTCBContinuity (int pIndex) |
| Get the key continuity value at the specified index (TCB key). More... | |
| float | KeyGetTCBTension (int pIndex) |
| Get the key tension value at the specified index (TCB key). More... | |
| bool | KeyGetTangentBreak (int pIndex) |
| Get the key tangent's break status at the specified index. More... | |
| FBTangentClampMode | KeyGetTangentClampMode (int pIndex) |
| Get the key tangent's clamp method at the specified index. More... | |
| FBTangentConstantMode | KeyGetTangentConstantMode (int pIndex) |
| Get the key tangent's constant mode at the specified index. More... | |
| FBTangentCustomIndex | KeyGetTangentCustomIndex (int pIndex) |
| Get the key tangent's custom index at the specified index. More... | |
| FBTangentMode | KeyGetTangentMode (int pIndex) |
| Get the key tangent mode at the specified index. More... | |
| FBTangentWeightMode | KeyGetTangentWeightMode (int pIndex) |
| Get the tangent weight mode for a key. More... | |
| FBTime | KeyGetTime (int pIndex) |
| Get the key time value at the specified index. More... | |
| float | KeyGetValue (int pIndex) |
| Get the key value at the specified index. More... | |
| KeyInsert (FBTime pTime, FBInterpolation pInterpolation=kFBInterpolationCubic, FBTangentMode pTangentMode=kFBTangentModeAuto) | |
| Insert a key without affecting the curve shape. More... | |
| bool | KeyOffset (FBTime pOffsetTime, int pStartIndex, int pStopIndex) |
| Offset keys within an index range by a given offset time. More... | |
| bool | KeyOffset (FBTime pOffsetTime, FBTime pStartTime=FBTime::MinusInfinity, FBTime pStopTime=FBTime::Infinity, bool pInclusive=True) |
| Offset keys within a time range by a given offset time. More... | |
| 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. More... | |
| KeySetInterpolation (int pIndex, FBInterpolation pValue) | |
| Set the key interpolation type at the specified index. More... | |
| KeySetLeftBezierTangent (int pIndex, float pValue) | |
| Set the key left bezier tangent value at the specified index. More... | |
| KeySetLeftDerivative (int pIndex, float pValue) | |
| Set the key left derivative value at the specified index. More... | |
| KeySetLeftTangentWeight (int pIndex, float pValue) | |
| Set the key left tangent weight at the specified index. More... | |
| bool | KeySetMarkedForManipulation (int pIndex, bool pValue) |
| Set the key manipulation state. More... | |
| KeySetRightBezierTangent (int pIndex, float pValue) | |
| Set the key right bezier tangent value at the specified index. More... | |
| KeySetRightDerivative (int pIndex, float pValue) | |
| Set the key right derivative value at the specified index. More... | |
| KeySetRightTangentWeight (int pIndex, float pValue) | |
| Set the key right tangent weight at the specified index. More... | |
| bool | KeySetSelected (int pIndex, bool pValue) |
| Set the key selected state. More... | |
| KeySetTCBBias (int pIndex, float pValue) | |
| Set the key bias value at the specified index (TCB key). More... | |
| KeySetTCBContinuity (int pIndex, float pValue) | |
| Set the key continuity value at the specified index (TCB key). More... | |
| KeySetTCBTension (int pIndex, float pValue) | |
| Set the key tension value at the specified index (TCB key). More... | |
| KeySetTangentBreak (int pIndex, bool pValue) | |
| Set the key tangent's break status at the specified index. More... | |
| KeySetTangentClampMode (int pIndex, FBTangentClampMode pValue) | |
| Set the key tangent's clamp method at the specified index. More... | |
| KeySetTangentConstantMode (int pIndex, FBTangentConstantMode pValue) | |
| Set the key tangent's constant mode at the specified index. More... | |
| KeySetTangentCustomIndex (int pIndex, FBTangentCustomIndex pValue) | |
| Set the key tangent's custom index at the specified index. More... | |
| KeySetTangentMode (int pIndex, FBTangentMode pValue) | |
| Set the key tangent mode at the specified index. More... | |
| KeySetTangentWeightMode (int pIndex, FBTangentWeightMode pValue) | |
| Change the tangent weight for a key. More... | |
| KeySetTime (int pIndex, FBTime pValue) | |
| Set the key time value at the specified index. More... | |
| KeySetValue (int pIndex, float pValue) | |
| Set the key value at the specified index. More... | |
| SetPostExtrapolationCount (int pCount) | |
| Set count for post extrapolation. More... | |
| SetPostExtrapolationMode (FBExtrapolationMode pExtrapolationMode) | |
| Set modes for post extrapolation. More... | |
| SetPreExtrapolationCount (int pCount) | |
| Set count for pre extrapolation. More... | |
| SetPreExtrapolationMode (FBExtrapolationMode pExtrapolationMode) | |
| Set modes for pre extrapolation. More... | |
Public Member Functions inherited from FBComponent | |
| FBComponent () | |
| Constructor. More... | |
| str | ClassName () |
| Get the class name. More... | |
| DisableObjectFlags (FBObjectFlag pFlags) | |
| Disable a specific Object Flags. More... | |
| EnableObjectFlags (FBObjectFlag pFlags) | |
| Enable a specific Object Flags. More... | |
| bool | FBCreate () |
| Open Reality Creation function. More... | |
| FBDelete () | |
| Open Reality deletion function. More... | |
| FBDestroy () | |
| Open Reality destruction function. More... | |
| FBObjectFlag | GetObjectFlags () |
| Get all Object Flags (concatenated). More... | |
| bool | GetObjectStatus (FBObjectStatus pStatus) |
| Check to see if an object status is enabled. More... | |
| FBFileReference | GetOwnerFileReference (p0) |
| Get the owner FileReference object. More... | |
| HardSelect () | |
| HardSelect. More... | |
| bool | HasObjectFlags (FBObjectFlag pFlags) |
| Check whether a specific object flag is enabled. More... | |
| bool | Is (int pTypeId) |
| Returns true if object is of type TypeId. More... | |
| bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessNamespaceHierarchy. More... | |
| bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessObjectNamespace. More... | |
| int | PropertyAdd (FBProperty pProperty) |
| Add a property to the component's property manager. More... | |
| bool | PropertyAddReferenceProperty (FBProperty pReferenceProperty) |
| Add a reference property to the component's property manager. More... | |
| FBProperty | PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None) |
| Create user or dynamic property. More... | |
| PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags) | |
| Get list of properties which have been modified since last loading. More... | |
| PropertyRemove (FBProperty pProperty) | |
| Remove a Property from the component's Property manager. More... | |
| SetObjectFlags (FBObjectFlag pFlags) | |
| SetObjectFlags. More... | |
| SetObjectStatus (FBObjectStatus pStatus, bool pValue) | |
| Enable/Disable a specific Object Status. More... | |
Public Attributes | |
| FBListFCurveKey | Keys |
| List: Keys. More... | |
Public Attributes inherited from FBComponent | |
| FBListComponent | Components |
| List: List of components. More... | |
| str | LongName |
| Read Write Property: Name and namespace for object. More... | |
| str | Name |
| Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. More... | |
| FBListComponent | Parents |
| List: Parents. More... | |
| FBManager | PropertyList |
| Read Only Property: Manages all of the properties for the component. More... | |
| bool | Selected |
| Read Write Property: Selected property. More... | |
| int | TypeInfo |
| Contains the Type information of the object. More... | |
Public Attributes inherited from FBPlug | |
| str | ClassGroupName |
| ClassGroupName of the object. More... | |
| int | TypeInfo |
| TypeInfo. More... | |
| FBFCurve | ( | ) |
Constructor.
| FBFCurve CreateInterpolatorCurve | ( | FBInterpolatorCurveType | pCurveType | ) |
Create and interpolator curve.
| pCurveType | Interpolator curve type to create. |
| EditBegin | ( | int | pKeyCount = -1 | ) |
Setup function to begin adding keys.
| pKeyCount | Key to begin adding at(default is -1). |
| EditClear | ( | ) |
Empty FCurve of all keys.
| EditEnd | ( | int | pKeyCount = -1 | ) |
End key adding sequence.
| pKeyCount | Key to finish adding at (default is -1). |
Evaluate FCurve at pTime.
| pTime | Time at which FCurve is to be evaluated. |
| int GetPostExtrapolationCount | ( | ) |
Get count for post extrapolation.
| FBExtrapolationMode GetPostExtrapolationMode | ( | ) |
Get modes for post extrapolation.
| int GetPreExtrapolationCount | ( | ) |
Get count for pre extrapolation.
| FBExtrapolationMode GetPreExtrapolationMode | ( | ) |
Get modes for pre extrapolation.
| 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). |
| 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 | True to include within the time range the keys at pStartTime and pStopTime, false otherwise. |
Delete keys within an index range.
This function is much faster than multiple removes.
| pStartIndex | Index of first deleted key. |
| pStopIndex | Index of last deleted key. |
| FBInterpolation KeyGetInterpolation | ( | int | pIndex | ) |
Get the key interpolation type at the specified index.
| pIndex | Index of the key to query. |
Get the key left bezier tangent value at the specified index.
| pIndex | Index of the key to query. |
Get the key left derivative value at the specified index.
| pIndex | Index of the key to query. |
Get the key left tangent weight at the specified index.
| pIndex | Index of the key to query. |
Get the key manipulation state.
| pIndex | Index of the key to query. |
Get the key right bezier tangent value at the specified index.
| pIndex | Index of the key to query. |
Get the key right derivative value at the specified index.
| pIndex | Index of the key to query. |
Get the key right tangent weight at the specified index.
| pIndex | Index of the key to query. |
Get the key selected state.
| pIndex | Index of the key to query. |
Get the key tangent's break status at the specified index.
| pIndex | Index of the key to query. |
| FBTangentClampMode KeyGetTangentClampMode | ( | int | pIndex | ) |
Get the key tangent's clamp method at the specified index.
| pIndex | Index of the key to query. |
| FBTangentConstantMode KeyGetTangentConstantMode | ( | int | pIndex | ) |
Get the key tangent's constant mode at the specified index.
| pIndex | Index of the key to query. |
| FBTangentCustomIndex KeyGetTangentCustomIndex | ( | int | pIndex | ) |
Get the key tangent's custom index at the specified index.
| pIndex | Index of the key to query. |
| FBTangentMode KeyGetTangentMode | ( | int | pIndex | ) |
Get the key tangent mode at the specified index.
| pIndex | Index of the key to query. |
| FBTangentWeightMode KeyGetTangentWeightMode | ( | int | pIndex | ) |
Get the tangent weight mode for a key.
| pIndex | Index of the key to query. |
Get the key bias value at the specified index (TCB key).
| pIndex | Index of the key to query. |
Get the key continuity value at the specified index (TCB key).
| pIndex | Index of the key to query. |
Get the key tension value at the specified index (TCB key).
| pIndex | Index of the key to query. |
Get the key time value at the specified index.
| pIndex | Index of the key to query. |
Get the key value at the specified index.
| pIndex | Index of the key to query. |
| 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). |
| bool KeyOffset | ( | FBTime | pOffsetTime, |
| FBTime | pStartTime = FBTime::MinusInfinity, |
||
| FBTime | pStopTime = FBTime::Infinity, |
||
| bool | pInclusive = True |
||
| ) |
Offset keys within a time range by a given offset time.
Non-moving keys that are situated in the target range are deleted automatically, to preserve the animation being offset.
| pOffsetTime | The offset time to apply on keys. |
| pStartTime | Start of time range. |
| pStopTime | End of time range. |
| pInclusive | True to include within the time range the keys at pStartTime and pStopTime, false otherwise. |
Offset keys within an index range by a given offset time.
When offsetting many keys at once, all non-moving keys that are situated in the target range are deleted automatically, to preserve the animation being offset.
| pOffsetTime | The offset time to apply on keys. |
| pStartIndex | Index of first key to be offset. |
| pStopIndex | Index of last key to be offset. |
| 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. |
| KeySetInterpolation | ( | int | pIndex, |
| FBInterpolation | pValue | ||
| ) |
Set the key interpolation type at the specified index.
| pIndex | Index of the key to set. |
| pValue | Type of interpolation. |
Set the key left bezier tangent value at the specified index.
| pIndex | Index of the key to set. |
| pValue | Left bezier tangent. |
Set the key left derivative value at the specified index.
| pIndex | Index of the key to set. |
| pValue | Left derivative value, in units/seconds. |
Set the key left tangent weight at the specified index.
| pIndex | Index of the key to set. |
| pValue | Left tangent weight. |
Set the key manipulation state.
| pIndex | Index of the key to set. |
| pValue | New manipulation state. |
Set the key right bezier tangent value at the specified index.
| pIndex | Index of the key to set. |
| pValue | Right bezier tangent. |
Set the key right derivative value at the specified index.
| pIndex | Index of the key to set. |
| pValue | Right derivative value, in units/seconds. |
Set the key right tangent weight at the specified index.
| pIndex | Index of the key to set. |
| pValue | Right tangent weight. |
Set the key selected state.
| pIndex | Index of the key to set. |
| pValue | New selection state. |
Set the key tangent's break status at the specified index.
| pIndex | Index of the key to set. |
| pValue | Tangent's break status. |
| KeySetTangentClampMode | ( | int | pIndex, |
| FBTangentClampMode | pValue | ||
| ) |
Set the key tangent's clamp method at the specified index.
| pIndex | Index of the key to set. |
| pValue | Tangent's clamp method. |
| KeySetTangentConstantMode | ( | int | pIndex, |
| FBTangentConstantMode | pValue | ||
| ) |
Set the key tangent's constant mode at the specified index.
| pIndex | Index of the key to set. |
| pValue | Tangent's constant mode. |
| KeySetTangentCustomIndex | ( | int | pIndex, |
| FBTangentCustomIndex | pValue | ||
| ) |
Set the key tangent's custom index at the specified index.
| pIndex | Index of the key to set. |
| pValue | Tangent's custom index. |
| KeySetTangentMode | ( | int | pIndex, |
| FBTangentMode | pValue | ||
| ) |
Set the key tangent mode at the specified index.
| pIndex | Index of the key to set. |
| pValue | Tangent calculation method. |
| KeySetTangentWeightMode | ( | int | pIndex, |
| FBTangentWeightMode | pValue | ||
| ) |
Change the tangent weight for a key.
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.
| pIndex | Index of the key to set. |
| pValue | Set the pValue according to the desired mode, kFBTangentWeightModeNone to disable it. |
Set the key bias value at the specified index (TCB key).
| pIndex | Index of the key to set. |
| pValue | Bias value. |
Set the key continuity value at the specified index (TCB key).
| pIndex | Index of the key to set. |
| pValue | Continuity value. |
Set the key tension value at the specified index (TCB key).
| pIndex | Index of the key to set. |
| pValue | Tension value. |
Set the key time value at the specified index.
| pIndex | Index of the key to set. |
| pValue | Time of key. |
Set the key value at the specified index.
| pIndex | Index of the key to set. |
| pValue | Value of the key. |
| SetPostExtrapolationCount | ( | int | pCount | ) |
Set count for post extrapolation.
| SetPostExtrapolationMode | ( | FBExtrapolationMode | pExtrapolationMode | ) |
Set modes for post extrapolation.
| SetPreExtrapolationCount | ( | int | pCount | ) |
Set count for pre extrapolation.
| SetPreExtrapolationMode | ( | FBExtrapolationMode | pExtrapolationMode | ) |
Set modes for pre extrapolation.
| FBListFCurveKey Keys |
List: Keys.