FBFCurve Class Reference

FCurve class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBFCurve:

Public Member Functions
	FBFCurve ()
	Constructor.
FBFCurve	CreateInterpolatorCurve (FBInterpolatorCurveType pCurveType)
	Create and interpolator curve.
	EditBegin (int pKeyCount=-1)
	Setup function to begin adding keys.
	EditClear ()
	Empty FCurve of all keys.
	EditEnd (int pKeyCount=-1)
	End key adding sequence.
float	Evaluate (FBTime pTime)
	Evaluate FCurve at pTime.
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.
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.
FBInterpolation	KeyGetInterpolation (int pIndex)
	Get the key interpolation type at the specified index.
float	KeyGetLeftBezierTangent (int pIndex)
	Get the key left bezier tangent value at the specified index.
float	KeyGetLeftDerivative (int pIndex)
	Get the key left derivative value at the specified index.
float	KeyGetLeftTangentWeight (int pIndex)
	Get the key left tangent weight at the specified index.
bool	KeyGetMarkedForManipulation (int pIndex)
	Get the key manipulation state.
float	KeyGetRightBezierTangent (int pIndex)
	Get the key right bezier tangent value at the specified index.
float	KeyGetRightDerivative (int pIndex)
	Get the key right derivative value at the specified index.
float	KeyGetRightTangentWeight (int pIndex)
	Get the key right tangent weight at the specified index.
bool	KeyGetSelected (int pIndex)
	Get the key selected state.
float	KeyGetTCBBias (int pIndex)
	Get the key bias value at the specified index (TCB key).
float	KeyGetTCBContinuity (int pIndex)
	Get the key continuity value at the specified index (TCB key).
float	KeyGetTCBTension (int pIndex)
	Get the key tension value at the specified index (TCB key).
bool	KeyGetTangentBreak (int pIndex)
	Get the key tangent's break status at the specified index.
FBTangentClampMode	KeyGetTangentClampMode (int pIndex)
	Get the key tangent's clamp method at the specified index.
FBTangentConstantMode	KeyGetTangentConstantMode (int pIndex)
	Get the key tangent's constant mode at the specified index.
FBTangentCustomIndex	KeyGetTangentCustomIndex (int pIndex)
	Get the key tangent's custom index at the specified index.
FBTangentMode	KeyGetTangentMode (int pIndex)
	Get the key tangent mode at the specified index.
FBTangentWeightMode	KeyGetTangentWeightMode (int pIndex)
	Get the tangent weight mode for a key.
FBTime	KeyGetTime (int pIndex)
	Get the key time value at the specified index.
float	KeyGetValue (int pIndex)
	Get the key value at the specified index.
	KeyInsert (FBTime pTime, FBInterpolation pInterpolation=kFBInterpolationCubic, FBTangentMode pTangentMode=kFBTangentModeAuto)
	Insert a key without affecting the curve shape.
bool	KeyOffset (FBTime pOffsetTime, int pStartIndex, int pStopIndex)
	Offset keys within an index range by a given offset time.
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.
	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.
	KeySetInterpolation (int pIndex, FBInterpolation pValue)
	Set the key interpolation type at the specified index.
	KeySetLeftBezierTangent (int pIndex, float pValue)
	Set the key left bezier tangent value at the specified index.
	KeySetLeftDerivative (int pIndex, float pValue)
	Set the key left derivative value at the specified index.
	KeySetLeftTangentWeight (int pIndex, float pValue)
	Set the key left tangent weight at the specified index.
bool	KeySetMarkedForManipulation (int pIndex, bool pValue)
	Set the key manipulation state.
	KeySetRightBezierTangent (int pIndex, float pValue)
	Set the key right bezier tangent value at the specified index.
	KeySetRightDerivative (int pIndex, float pValue)
	Set the key right derivative value at the specified index.
	KeySetRightTangentWeight (int pIndex, float pValue)
	Set the key right tangent weight at the specified index.
bool	KeySetSelected (int pIndex, bool pValue)
	Set the key selected state.
	KeySetTCBBias (int pIndex, float pValue)
	Set the key bias value at the specified index (TCB key).
	KeySetTCBContinuity (int pIndex, float pValue)
	Set the key continuity value at the specified index (TCB key).
	KeySetTCBTension (int pIndex, float pValue)
	Set the key tension value at the specified index (TCB key).
	KeySetTangentBreak (int pIndex, bool pValue)
	Set the key tangent's break status at the specified index.
	KeySetTangentClampMode (int pIndex, FBTangentClampMode pValue)
	Set the key tangent's clamp method at the specified index.
	KeySetTangentConstantMode (int pIndex, FBTangentConstantMode pValue)
	Set the key tangent's constant mode at the specified index.
	KeySetTangentCustomIndex (int pIndex, FBTangentCustomIndex pValue)
	Set the key tangent's custom index at the specified index.
	KeySetTangentMode (int pIndex, FBTangentMode pValue)
	Set the key tangent mode at the specified index.
	KeySetTangentWeightMode (int pIndex, FBTangentWeightMode pValue)
	Change the tangent weight for a key.
	KeySetTime (int pIndex, FBTime pValue)
	Set the key time value at the specified index.
	KeySetValue (int pIndex, float pValue)
	Set the key value at the specified index.
bool	KeysAdd (FBArrayTemplate< FBTime > pTimes, FBArrayDouble pValues, FBArrayTemplate< FBInterpolation > pInterpolations=FBArrayTemplate< FBInterpolation >(), FBArrayTemplate< FBTangentMode > pTangentModes=FBArrayTemplate< FBTangentMode >())
	Add at once multiple keys at different specified times.
bool	KeysSetValues (FBArrayUInt pIndices, FBArrayDouble pValues, FBArrayTemplate< FBInterpolation > pInterpolations=FBArrayTemplate< FBInterpolation >(), FBArrayTemplate< FBTangentMode > pTangentModes=FBArrayTemplate< FBTangentMode >())
	Set at once multiple existing keys values.
	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.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
FBListFCurveKey	Keys
	List: Keys.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

FCurve class.

See samples: ClearKeysOnSelectedModels.py, FCurveEditor.py.

Constructor & Destructor Documentation

FBFCurve()

FBFCurve

(

)

Constructor.

Member Function Documentation

CreateInterpolatorCurve()

FBFCurve CreateInterpolatorCurve

(

FBInterpolatorCurveType

pCurveType

)

Create and interpolator curve.

Parameters

pCurveType

Interpolator curve type to create.

EditBegin()

EditBegin

(

int

pKeyCount = -1

)

Setup function to begin adding keys.

Parameters

pKeyCount

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

EditClear()

EditClear

(

)

Empty FCurve of all keys.

EditEnd()

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.

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

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

KeyGetInterpolation()

FBInterpolation KeyGetInterpolation

(

int

pIndex

)

Get the key interpolation type at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Type of interpolation.

KeyGetLeftBezierTangent()

float KeyGetLeftBezierTangent

(

int

pIndex

)

Get the key left bezier tangent value at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Left bezier tangent.

KeyGetLeftDerivative()

float KeyGetLeftDerivative

(

int

pIndex

)

Get the key left derivative value at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Left derivative value, in units/seconds.

KeyGetLeftTangentWeight()

float KeyGetLeftTangentWeight

(

int

pIndex

)

Get the key left tangent weight at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Left tangent weight.

KeyGetMarkedForManipulation()

bool KeyGetMarkedForManipulation

(

int

pIndex

)

Get the key manipulation state.

Parameters

pIndex

Index of the key to query.

Returns

True if the key is being manipulated, false otherwise.

KeyGetRightBezierTangent()

float KeyGetRightBezierTangent

(

int

pIndex

)

Get the key right bezier tangent value at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Right bezier tangent.

KeyGetRightDerivative()

float KeyGetRightDerivative

(

int

pIndex

)

Get the key right derivative value at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Right derivative value, in units/seconds.

KeyGetRightTangentWeight()

float KeyGetRightTangentWeight

(

int

pIndex

)

Get the key right tangent weight at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Right tangent weight.

KeyGetSelected()

bool KeyGetSelected

(

int

pIndex

)

Get the key selected state.

Parameters

pIndex

Index of the key to query.

Returns

True if the key is selected, false otherwise.

KeyGetTangentBreak()

bool KeyGetTangentBreak

(

int

pIndex

)

Get the key tangent's break status at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Tangent's break status.

KeyGetTangentClampMode()

FBTangentClampMode KeyGetTangentClampMode

(

int

pIndex

)

Get the key tangent's clamp method at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Tangent's clamp method.

KeyGetTangentConstantMode()

FBTangentConstantMode KeyGetTangentConstantMode

(

int

pIndex

)

Get the key tangent's constant mode at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Tangent's constant mode.

KeyGetTangentCustomIndex()

FBTangentCustomIndex KeyGetTangentCustomIndex

(

int

pIndex

)

Get the key tangent's custom index at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Tangent's custom index.

KeyGetTangentMode()

FBTangentMode KeyGetTangentMode

(

int

pIndex

)

Get the key tangent mode at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Tangent calculation method.

KeyGetTangentWeightMode()

FBTangentWeightMode KeyGetTangentWeightMode

(

int

pIndex

)

Get the tangent weight mode for a key.

Parameters

pIndex

Index of the key to query.

Returns

Current weight mode.

KeyGetTCBBias()

float KeyGetTCBBias

(

int

pIndex

)

Get the key bias value at the specified index (TCB key).

Parameters

pIndex

Index of the key to query.

Returns

Bias value.

KeyGetTCBContinuity()

float KeyGetTCBContinuity

(

int

pIndex

)

Get the key continuity value at the specified index (TCB key).

Parameters

pIndex

Index of the key to query.

Returns

Continuity value.

KeyGetTCBTension()

float KeyGetTCBTension

(

int

pIndex

)

Get the key tension value at the specified index (TCB key).

Parameters

pIndex

Index of the key to query.

Returns

Tension value.

KeyGetTime()

FBTime KeyGetTime

(

int

pIndex

)

Get the key time value at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Time of key.

KeyGetValue()

float KeyGetValue

(

int

pIndex

)

Get the key value at the specified index.

Parameters

pIndex

Index of the key to query.

Returns

Value of the key.

KeyInsert()

KeyInsert	(	FBTime	pTime,
		FBInterpolation	pInterpolation = kFBInterpolationCubic,
		FBTangentMode	pTangentMode = kFBTangentModeAuto
	)

Insert a key without affecting the curve shape.

Parameters

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

KeyOffset() [1/2]

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.

Parameters

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.

Returns

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

KeyOffset() [2/2]

bool KeyOffset	(	FBTime	pOffsetTime,
		int	pStartIndex,
		int	pStopIndex
	)

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.

Parameters

pOffsetTime	The offset time to apply on keys.
pStartIndex	Index of first key to be offset.
pStopIndex	Index of last key to be offset.

Returns

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

KeyReplaceBy()

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

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.

KeysAdd()

bool KeysAdd	(	FBArrayTemplate< FBTime >	pTimes,
		FBArrayDouble	pValues,
		FBArrayTemplate< FBInterpolation >	pInterpolations = FBArrayTemplate< FBInterpolation >(),
		FBArrayTemplate< FBTangentMode >	pTangentModes = FBArrayTemplate< FBTangentMode >()
	)

Add at once multiple keys at different specified times.

The array size of pTimes and pValues must match. If pInterpolations and pTangentModes parameters are specified, their array sizes must also match the array size of pTimes. The value of each index of each input array will be used together to form a key data to add.

Parameters

pTimes	Times at which to insert the keys.
pValues	Values of the keys.
pInterpolations	Interpolation types of the inserted keys, default value is Cubic interpolation for all the keys if this parameter is omitted.
pTangentModes	Tangent calculation methods of the inserted keys, default value is Auto (Smooth) for all the keys if this parameter is omitted.

Returns

True if the operation is successful, false otherwise.

Python

Each parameter of KeysAdd is a Python list. ex : KeysAdd( [time1, time2], [value1, value2] )

KeySetInterpolation()

KeySetInterpolation	(	int	pIndex,
		FBInterpolation	pValue
	)

Set the key interpolation type at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Type of interpolation.

KeySetLeftBezierTangent()

KeySetLeftBezierTangent	(	int	pIndex,
		float	pValue
	)

Set the key left bezier tangent value at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Left bezier tangent.

KeySetLeftDerivative()

KeySetLeftDerivative	(	int	pIndex,
		float	pValue
	)

Set the key left derivative value at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Left derivative value, in units/seconds.

KeySetLeftTangentWeight()

KeySetLeftTangentWeight	(	int	pIndex,
		float	pValue
	)

Set the key left tangent weight at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Left tangent weight.

KeySetMarkedForManipulation()

bool KeySetMarkedForManipulation	(	int	pIndex,
		bool	pValue
	)

Set the key manipulation state.

Parameters

pIndex	Index of the key to set.
pValue	New manipulation state.

Returns

True if the operation was successful, false otherwise.

KeySetRightBezierTangent()

KeySetRightBezierTangent	(	int	pIndex,
		float	pValue
	)

Set the key right bezier tangent value at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Right bezier tangent.

KeySetRightDerivative()

KeySetRightDerivative	(	int	pIndex,
		float	pValue
	)

Set the key right derivative value at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Right derivative value, in units/seconds.

KeySetRightTangentWeight()

KeySetRightTangentWeight	(	int	pIndex,
		float	pValue
	)

Set the key right tangent weight at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Right tangent weight.

KeySetSelected()

bool KeySetSelected	(	int	pIndex,
		bool	pValue
	)

Set the key selected state.

Parameters

pIndex	Index of the key to set.
pValue	New selection state.

Returns

True if the operation was successful, false otherwise.

KeySetTangentBreak()

KeySetTangentBreak	(	int	pIndex,
		bool	pValue
	)

Set the key tangent's break status at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Tangent's break status.

KeySetTangentClampMode()

KeySetTangentClampMode	(	int	pIndex,
		FBTangentClampMode	pValue
	)

Set the key tangent's clamp method at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Tangent's clamp method.

KeySetTangentConstantMode()

KeySetTangentConstantMode	(	int	pIndex,
		FBTangentConstantMode	pValue
	)

Set the key tangent's constant mode at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Tangent's constant mode.

KeySetTangentCustomIndex()

KeySetTangentCustomIndex	(	int	pIndex,
		FBTangentCustomIndex	pValue
	)

Set the key tangent's custom index at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Tangent's custom index.

KeySetTangentMode()

KeySetTangentMode	(	int	pIndex,
		FBTangentMode	pValue
	)

Set the key tangent mode at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Tangent calculation method.

KeySetTangentWeightMode()

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.

Parameters

pIndex	Index of the key to set.
pValue	Set the pValue according to the desired mode, kFBTangentWeightModeNone to disable it.

KeySetTCBBias()

KeySetTCBBias	(	int	pIndex,
		float	pValue
	)

Set the key bias value at the specified index (TCB key).

Parameters

pIndex	Index of the key to set.
pValue	Bias value.

KeySetTCBContinuity()

KeySetTCBContinuity	(	int	pIndex,
		float	pValue
	)

Set the key continuity value at the specified index (TCB key).

Parameters

pIndex	Index of the key to set.
pValue	Continuity value.

KeySetTCBTension()

KeySetTCBTension	(	int	pIndex,
		float	pValue
	)

Set the key tension value at the specified index (TCB key).

Parameters

pIndex	Index of the key to set.
pValue	Tension value.

KeySetTime()

KeySetTime	(	int	pIndex,
		FBTime	pValue
	)

Set the key time value at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Time of key.

KeySetValue()

KeySetValue	(	int	pIndex,
		float	pValue
	)

Set the key value at the specified index.

Parameters

pIndex	Index of the key to set.
pValue	Value of the key.

KeysSetValues()

bool KeysSetValues	(	FBArrayUInt	pIndices,
		FBArrayDouble	pValues,
		FBArrayTemplate< FBInterpolation >	pInterpolations = FBArrayTemplate< FBInterpolation >(),
		FBArrayTemplate< FBTangentMode >	pTangentModes = FBArrayTemplate< FBTangentMode >()
	)

Set at once multiple existing keys values.

The array size of pIndices and pValues must match. If pInterpolations and pTangentModes parameters are specified, their array sizes must also match the array size of pIndices. The value of each index of each input array (except for pIndices) will be used together to modify the key data of the key specified by the key index of pIndices.

Parameters

pIndices	Indices of existing keys to modify.
pValues	New values of the keys to modify.
pInterpolations	New interpolation types of the keys to modify if specified, otherwise the interpolation types are untouched.
pTangentModes	New tangent calculation methods of the keys to modify if specified, otherwise the tangent calculation methods are untouched.

Returns

True if the operation is successful (at least one key is modified), false otherwise.

Python

Each parameter of KeysSetValues is a Python list. ex : KeysSetValues( [index1, index2], [value1, value2] )

SetPostExtrapolationCount()

SetPostExtrapolationCount

(

int

pCount

)

Set count for post extrapolation.

SetPostExtrapolationMode()

SetPostExtrapolationMode

(

FBExtrapolationMode

pExtrapolationMode

)

Set modes for post extrapolation.

SetPreExtrapolationCount()

SetPreExtrapolationCount

(

int

pCount

)

Set count for pre extrapolation.

SetPreExtrapolationMode()

SetPreExtrapolationMode

(

FBExtrapolationMode

pExtrapolationMode

)

Set modes for pre extrapolation.

Member Data Documentation

Keys

FBListFCurveKey Keys

List: Keys.