FCurve class. More...

#include <fbdata.h>

Inheritance diagram for FBFCurve:

[legend]

Public Member Functions
	FBFCurve (HIObject pObject=NULL)
	Constructor. More...

virtual void	FBDelete () override
	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...

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...

FBExtrapolationMode	GetPostExtrapolationMode ()
	Get modes for post extrapolation. More...

void	SetPostExtrapolationMode (FBExtrapolationMode pExtrapolationMode)
	Set modes for post extrapolation. More...

int	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...

int	GetPreExtrapolationCount ()
	Get count for pre extrapolation. More...

void	SetPreExtrapolationCount (int pCount)
	Set count for pre extrapolation. More...

FBPropertyListFCurveKey	GetKeys ()

void	SetKeys (FBPropertyListFCurveKey pKeys)

float	KeyGetValue (int pIndex)
	Get the key value at the specified index. More...

void	KeySetValue (int pIndex, float pValue)
	Set the key value at the specified index. More...

float	KeyGetLeftDerivative (int pIndex)
	Get the key left derivative value at the specified index. More...

void	KeySetLeftDerivative (int pIndex, float pValue)
	Set the key left derivative value at the specified index. More...

float	KeyGetRightDerivative (int pIndex)
	Get the key right derivative value at the specified index. More...

void	KeySetRightDerivative (int pIndex, float pValue)
	Set the key right derivative value at the specified index. More...

float	KeyGetLeftTangentWeight (int pIndex)
	Get the key left tangent weight at the specified index. More...

void	KeySetLeftTangentWeight (int pIndex, float pValue)
	Set the key left tangent weight at the specified index. More...

float	KeyGetRightTangentWeight (int pIndex)
	Get the key right tangent weight at the specified index. More...

void	KeySetRightTangentWeight (int pIndex, float pValue)
	Set the key right tangent weight at the specified index. More...

float	KeyGetLeftBezierTangent (int pIndex)
	Get the key left bezier tangent value at the specified index. More...

void	KeySetLeftBezierTangent (int pIndex, float pValue)
	Set the key left bezier tangent value at the specified index. More...

float	KeyGetRightBezierTangent (int pIndex)
	Get the key right bezier tangent value at the specified index. More...

void	KeySetRightBezierTangent (int pIndex, float pValue)
	Set the key right bezier tangent value at the specified index. More...

float	KeyGetTCBTension (int pIndex)
	Get the key tension value at the specified index (TCB key). More...

void	KeySetTCBTension (int pIndex, float pValue)
	Set the key tension value at the specified index (TCB key). More...

float	KeyGetTCBContinuity (int pIndex)
	Get the key continuity value at the specified index (TCB key). More...

void	KeySetTCBContinuity (int pIndex, float pValue)
	Set the key continuity value at the specified index (TCB key). More...

float	KeyGetTCBBias (int pIndex)
	Get the key bias value at the specified index (TCB key). More...

void	KeySetTCBBias (int pIndex, float pValue)
	Set the key bias value at the specified index (TCB key). More...

FBTime	KeyGetTime (int pIndex)
	Get the key time value at the specified index. More...

void	KeySetTime (int pIndex, FBTime pValue)
	Set the key time value at the specified index. More...

FBInterpolation	KeyGetInterpolation (int pIndex)
	Get the key interpolation type at the specified index. More...

void	KeySetInterpolation (int pIndex, FBInterpolation pValue)
	Set the key interpolation type at the specified index. More...

FBTangentMode	KeyGetTangentMode (int pIndex)
	Get the key tangent mode at the specified index. More...

void	KeySetTangentMode (int pIndex, FBTangentMode pValue)
	Set the key tangent mode at the specified index. More...

FBTangentClampMode	KeyGetTangentClampMode (int pIndex)
	Get the key tangent's clamp method at the specified index. More...

void	KeySetTangentClampMode (int pIndex, FBTangentClampMode pValue)
	Set the key tangent's clamp method at the specified index. More...

bool	KeyGetTangentBreak (int pIndex)
	Get the key tangent's break status at the specified index. More...

void	KeySetTangentBreak (int pIndex, bool pValue)
	Set the key tangent's break status at the specified index. More...

FBTangentConstantMode	KeyGetTangentConstantMode (int pIndex)
	Get the key tangent's constant mode at the specified index. More...

void	KeySetTangentConstantMode (int pIndex, FBTangentConstantMode pValue)
	Set 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...

void	KeySetTangentCustomIndex (int pIndex, FBTangentCustomIndex pValue)
	Set the key tangent's custom index at the specified index. More...

FBTangentWeightMode	KeyGetTangentWeightMode (int pIndex)
	Get the tangent weight mode for a key. More...

void	KeySetTangentWeightMode (int pIndex, FBTangentWeightMode pValue)
	Change the tangent weight for a key. More...

bool	KeyGetSelected (int pIndex)
	Get the key selected state. More...

bool	KeySetSelected (int pIndex, bool pValue)
	Set the key selected state. More...

bool	KeyGetMarkedForManipulation (int pIndex)
	Get the key manipulation state. More...

bool	KeySetMarkedForManipulation (int pIndex, bool pValue)
	Set the key manipulation state. More...

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) override
	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...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	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=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	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...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Static Public Member Functions
static FBFCurve *	CreateInterpolatorCurve (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...

FBPlug *	GetSrc (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...

FBPlug *	GetDst (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...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (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=NULL, void *pDataOld=NULL, 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=NULL, void *pDataOld=NULL, 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=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	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...

Detailed Description

FCurve class.

Definition at line 340 of file fbdata.h.

Constructor & Destructor Documentation

◆ FBFCurve()

FBFCurve ( HIObject pObject = NULL )

Constructor.

Parameters

pObject For internal use only (default is NULL).

Member Function Documentation

◆ CreateInterpolatorCurve()

static FBFCurve* CreateInterpolatorCurve ( FBInterpolatorCurveType pCurveType )

static

Create and interpolator curve.

Parameters

pCurveType Interpolator curve type to create.

◆ EditBegin()

void EditBegin ( int pKeyCount = -1 )

Setup function to begin adding keys.

Parameters

pKeyCount Key to begin adding at(default is -1).

◆ EditClear()

void EditClear ( )

Empty FCurve of all keys.

◆ EditEnd()

void EditEnd ( int pKeyCount = -1 )

End key adding sequence.

Parameters

pKeyCount Key to finish adding at (default is -1).

◆ Evaluate()

float Evaluate ( FBTime & pTime )

Evaluate FCurve at pTime.

Parameters

pTime Time at which FCurve is to be evaluated.

Returns: Value of FCurve at pTime.

◆ FBDelete()

virtual void FBDelete ( )

overridevirtual

Virtual FBDelete function.

Reimplemented from FBComponent.

◆ GetPostExtrapolationCount()

int GetPostExtrapolationCount ( )

Get count for post extrapolation.

◆ GetPostExtrapolationMode()

FBExtrapolationMode GetPostExtrapolationMode ( )

Get modes for post extrapolation.

◆ GetPreExtrapolationCount()

int GetPreExtrapolationCount ( )

Get count for pre extrapolation.

◆ GetPreExtrapolationMode()

FBExtrapolationMode GetPreExtrapolationMode ( )

Get modes for pre extrapolation.

◆ KeyAdd()

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

Add a key at the specified time.

Parameters

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).

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.

◆ KeyDelete() [1/2]

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

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.

Returns: True if the delete operation is successful, false otherwise (e.g. the FCurve is locked, no keys found within the time range, etc.).

◆ KeyDelete() [2/2]

bool KeyDelete	(	int	pStartIndex,
		int	pStopIndex
	)

Delete keys within an index range.

This function is much faster than multiple removes.

Parameters

pStartIndex	Index of first deleted key.
pStopIndex	Index of last deleted key.

Returns: True if the delete operation is successful, false otherwise (e.g. the FCurve is locked, the index range is invalid, etc.).