FBFCurve Class Reference

#include <fbdata.h>

Class Description

FCurve class.

Definition at line 304 of file fbdata.h.

+ Inheritance diagram for FBFCurve:

Public Member Functions

 FBFCurve (HIObject pObject=((void *) 0))
 Constructor. More...
 
virtual void FBDelete ()
 Virtual FBDelete function. More...
 
float Evaluate (FBTime &pTime)
 Evaluate FCurve at pTime. More...
 
void EditBegin (int pKeyCount=-1)
 Setup function to begin adding keys. More...
 
void EditEnd (int pKeyCount=-1)
 End key adding sequence. More...
 
void EditClear ()
 Empty FCurve of all keys. More...
 
int KeyAdd (FBTime &pTime, double pValue, FBInterpolation pInterpolation=kFBInterpolationCubic, FBTangentMode pTangentMode=kFBTangentModeAuto)
 Add a key at the specified time. More...
 
bool KeyRemove (int pIndex)
 Remove key at index. 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...
 
void KeyInsert (FBTime &pTime, FBInterpolation pInterpolation=kFBInterpolationCubic, FBTangentMode pTangentMode=kFBTangentModeAuto)
 Insert a key without affecting the curve shape. More...
 
void 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...
 
void 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. More...
 
FBExtrapolationMode GetPostExtrapolationMode ()
 Get modes for post extrapolation. More...
 
void SetPostExtrapolationMode (FBExtrapolationMode pExtrapolationMode)
 Set modes for post extrapolation. More...
 
long GetPostExtrapolationCount ()
 Get count for post extrapolation. More...
 
void SetPostExtrapolationCount (int pCount)
 Set count for post extrapolation. More...
 
FBExtrapolationMode GetPreExtrapolationMode ()
 Get modes for pre extrapolation. More...
 
void SetPreExtrapolationMode (FBExtrapolationMode pExtrapolationMode)
 Set modes for pre extrapolation. More...
 
long GetPreExtrapolationCount ()
 Get count for pre extrapolation. More...
 
void SetPreExtrapolationCount (int pCount)
 Set count for pre extrapolation. More...
 
FBPropertyListFCurveKey GetKeys ()
 
void SetKeys (FBPropertyListFCurveKey pKeys)
 
- Public Member Functions inherited from FBComponent
 FBComponent (HIObject pObject)
 Constructor. More...
 
virtual ~FBComponent ()
 Destructor. More...
 
virtual bool FBCreate ()
 Open Reality Creation function. More...
 
virtual void FBDestroy ()
 Open Reality destruction function. More...
 
virtual bool SetHIObject (HIObject pObject, bool pSDKComponent)
 Assign component to an internal pointer. More...
 
virtual 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...
 
void PropertyRemove (FBProperty *pProperty)
 Remove a Property from the component's Property manager. More...
 
void PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading. More...
 
FBPropertyPropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=((void *) 0))
 Create user or dynamic property. More...
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated). More...
 
void SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags. More...
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled. More...
 
void EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags. More...
 
void DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags. More...
 
void SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status. More...
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled. More...
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=((void *) 0), bool pAddRight=true)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=((void *) 0), bool pAddRight=true)
 ProcessObjectNamespace. More...
 
virtual const char * ClassName ()
 Get the class name. More...
 
virtual bool UseCustomPropertyViewSet () const
 Use the custom property viewSet or not. More...
 
const char * GetFullName (void)
 Get the full name. More...
 
void SetOwnerNamespace (FBNamespace *pOwnerNSObj)
 Set the owner Namespace object. More...
 
FBNamespaceGetOwnerNamespace (void)
 Get the owner Namespace object. More...
 
FBFileReferenceGetOwnerFileReference (void)
 Get the owner FileReference object. More...
 
void HardSelect ()
 HardSelect. More...
 
virtual bool Is (int pTypeId)
 Returns true if object is of type TypeId. More...
 
virtual int GetTypeId ()
 GetTypeId( int pTypeId ) More...
 
- Public Member Functions inherited from IObject
virtual HIObject IQuery (kInterfaceID pInterfaceID, int IsLocal=0)=0
 
virtual void Destroy (int IsLocal=0)=0
 
- Public Member Functions inherited from FBWrapperHolder
 FBWrapperHolder ()
 
virtual ~FBWrapperHolder ()
 
FBScriptWrapperGetWrapper ()
 Return the wrapper interface of this FBObject. More...
 
void AddWrapper (FBScriptWrapper *)
 
void RemoveWrapper (FBScriptWrapper *)
 

Static Public Member Functions

static FBFCurveCreateInterpolatorCurve (FBInterpolatorCurveType pCurveType)
 Create and interpolator curve. More...
 
- Static Public Member Functions inherited from FBComponent
static int GetInternalClassId ()
 
static void FBComponentSetName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetName (FBComponent *pObject)
 
static void FBComponentSetLongName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetLongName (FBComponent *pObject)
 

Public Attributes

FBPropertyListFCurveKey Keys
 List: Keys. More...
 
- Public Attributes inherited from FBComponent
FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyListComponent Components
 List: List of components. More...
 
FBPropertyListComponent Parents
 List: Parents. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
FBPropertyString LongName
 Read Write Property: Name and namespace for object. More...
 
FBPropertyFolder Folder
 Read Write Property: The folder that contain this component. More...
 

Additional Inherited Members

- Static Public Attributes inherited from FBComponent
static int TypeInfo
 Contains the Type information of the object. More...
 
- Protected Member Functions inherited from FBPlug
bool IsSDKComponent ()
 Return whether or not item is an SDK component. More...
 
bool ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool DisconnectDst (FBPlug *pDst)
 Remove a destination connection. More...
 
bool DisconnectSrc (FBPlug *pSrc)
 Remove a source connection. More...
 
void DisconnectAllSrc ()
 Remove all source connections. More...
 
void DisconnectAllDst ()
 Remove all destination connections. More...
 
bool DisconnectDstAt (int pIndex)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrcAt (int pIndex)
 Remove a source connection at a specified index. More...
 
bool ReplaceDstAt (int pIndex, FBPlug *pDst)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (int pIndex, FBPlug *pSrc)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (int pIndexA, int pIndexB)
 Swap source connection at index A with source connection at index B. More...
 
bool MoveSrcAt (int pIndex, int pAtIndex)
 Move source connection at pIndex to pAtIndex. More...
 
bool MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
 Move source connection pSrc to the position of pAtSrc. More...
 
int GetSrcCount ()
 Get source connection count. More...
 
FBPlugGetSrc (int pIndex)
 Get a source connection's plug at specified index. More...
 
FBConnectionType GetSrcType (int pIndex)
 Get a source connection's type at specified index. More...
 
int GetDstCount ()
 Get destination connection count. More...
 
FBPlugGetDst (int pIndex)
 Get a destination connection's plug at specified index. More...
 
FBConnectionType GetDstType (int pIndex)
 Get a destination connection's type at specified index. More...
 
bool BeginChange ()
 Begins a change on multiple plugs. More...
 
void EndChange ()
 Ends a change on multiple plugs. More...
 
void SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlugModificationFlag pFlag)
 Tell if the plug's self has changed. More...
 
void SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlugModificationFlag pFlag)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
 Revert the plug's modification to original status. More...
 
void SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
 Set the plug's status flag. More...
 
bool GetStatusFlag (FBPlugStatusFlag pStatus) const
 Tell if the plug's status has changed. More...
 
FBPlugGetOwner ()
 Get the owner of this plug. More...
 
FBPlugGetOwned (int pIndex)
 Get the owned plug at specified index. More...
 
int GetOwnedCount ()
 Get the owned plug count. More...
 
virtual bool PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=((void *) 0), void *pDataOld=((void *) 0), int pDataSize=0)
 PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...
 
virtual bool PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=((void *) 0), void *pDataOld=((void *) 0), int pDataSize=0)
 PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...
 
virtual bool PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=((void *) 0), FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=((void *) 0))
 PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...
 
- Static Protected Member Functions inherited from FBPlug
static int GetInternalClassId ()
 Internal class Id. More...
 
- Protected Attributes inherited from FBPlug
bool mAllocated
 Contain the Allocation State of the Component. More...
 
HIObject mObject
 Handle on the Plug. More...
 
bool mSDKComponent
 bool Plug is an SDK component. More...
 
- Static Protected Attributes inherited from FBPlug
static const char * ClassGroupName
 ClassGroupName of the object. More...
 
static int TypeInfo
 TypeInfo. More...
 
static int mGlobalTypeInfo
 Represente the Type Index. More...
 

Constructor & Destructor Documentation

FBFCurve ( HIObject  pObject = ((void *) 0))

Constructor.

Parameters
pObjectFor internal use only (default is NULL).

Member Function Documentation

static FBFCurve* CreateInterpolatorCurve ( FBInterpolatorCurveType  pCurveType)
static

Create and interpolator curve.

Parameters
pCurveTypeInterpolator curve type to create.
void EditBegin ( int  pKeyCount = -1)

Setup function to begin adding keys.

Parameters
pKeyCountKey to begin adding at(default is -1).
void EditClear ( )

Empty FCurve of all keys.

void EditEnd ( int  pKeyCount = -1)

End key adding sequence.

Parameters
pKeyCountKey to finish adding at (default is -1).
float Evaluate ( FBTime pTime)

Evaluate FCurve at pTime.

Parameters
pTimeTime at which FCurve is to be evaluated.
Returns
Value of FCurve at pTime.
virtual void FBDelete ( )
virtual

Virtual FBDelete function.

Reimplemented from FBComponent.

FBPropertyListFCurveKey GetKeys ( )
inline

Definition at line 435 of file fbdata.h.

435 { return Keys; };
FBPropertyListFCurveKey Keys
List: Keys.
Definition: fbdata.h:436
long GetPostExtrapolationCount ( )

Get count for post extrapolation.

FBExtrapolationMode GetPostExtrapolationMode ( )

Get modes for post extrapolation.

long GetPreExtrapolationCount ( )

Get count for pre extrapolation.

FBExtrapolationMode GetPreExtrapolationMode ( )

Get modes for pre extrapolation.

int KeyAdd ( FBTime pTime,
double  pValue,
FBInterpolation  pInterpolation = kFBInterpolationCubic,
FBTangentMode  pTangentMode = kFBTangentModeAuto 
)

Add a key at the specified time.

Parameters
pTimeTime at which to insert the key.
pValueValue of the key.
pInterpolationInterpolation type of the inserted key, default value is Cubic interpolation.
pTangentModeTangent calculation method of the inserted key, default value is Auto (Smooth).
Returns
The position of the new key in the list of FCurve keys.
Warning
Since there are no parameter to indicate the interpolation and tangent mode, the neighbor keys may be affected by the newly inserted key.
bool KeyDelete ( int  pStartIndex,
int  pStopIndex 
)

Delete keys within an index range.

Index range is inclusive. This function is much faster than multiple removes.

Parameters
pStartIndexIndex of first deleted key.
pStopIndexIndex of last deleted key.
Returns
true if the function curve contains keys, false otherwise.
Remarks
Result is undetermined if function curve has keys but an index is out of bounds.
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.

Parameters
pStartStart of time range.
pStopEnd of time range.
pInclusiveTime range include the keys at pStart and pStop if true.
Returns
true if the function curve contains keys, false otherwise.
void KeyInsert ( FBTime pTime,
FBInterpolation  pInterpolation = kFBInterpolationCubic,
FBTangentMode  pTangentMode = kFBTangentModeAuto 
)

Insert a key without affecting the curve shape.

Parameters
pTimeTime at which the key is to be inserted.
pInterpolationInterpolation type of the inserted key, default value is Cubic interpolation.
pTangentModeTangent calculation method of the inserted key, default value is Auto (Smooth).
bool KeyRemove ( int  pIndex)

Remove key at index.

Parameters
pIndexIndex of the key to remove.
Returns
If the removal was successful or not.
void 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.

Parameters
pSourceSource function curve.
pStartStart of time range.
pStopEnd of time range.
pUseExactGivenSpanWhen false, the time of the first and last key in the range will be used.
pKeyStartEndOnNoKeyWhen true, inserts a key at the beginning and at the end of the range if there is no key to insert.
void 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.

Deprecated:
Deprecate as of 2014 version for naming consistency, use KeyReplaceBy instead.
Parameters
pSourceSource function curve.
pStartStart of time range.
pStopEnd of time range.
pUseExactGivenSpanWhen false, the time of the first and last key in the range will be used.
pKeyStartEndOnNoKeyWhen true, inserts a key at the beginning and at the end of the range if there is no key to insert.
void SetKeys ( FBPropertyListFCurveKey  pKeys)
inline

Definition at line 436 of file fbdata.h.

436 { Keys = pKeys; };
FBPropertyListFCurveKey Keys
List: Keys.
Definition: fbdata.h:436
void SetPostExtrapolationCount ( int  pCount)

Set count for post extrapolation.

void SetPostExtrapolationMode ( FBExtrapolationMode  pExtrapolationMode)

Set modes for post extrapolation.

void SetPreExtrapolationCount ( int  pCount)

Set count for pre extrapolation.

void SetPreExtrapolationMode ( FBExtrapolationMode  pExtrapolationMode)

Set modes for pre extrapolation.

Member Data Documentation

List: Keys.

Definition at line 436 of file fbdata.h.


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