#include <mobu-python-api.h>

Class Description

FCurve class.

Inheritance diagram for FBFCurve:

Public Member Functions
	__reduce__ ()

	__init__ (object arg1)
	Constructor. More...

	EditBegin (FBFCurve arg1, object arg2)
	Setup function to begin adding keys. More...

	EditClear (FBFCurve arg1)
	Empty FCurve of all keys. More...

	EditEnd (FBFCurve arg1, object arg2)
	End key adding sequence. More...

float	Evaluate (FBFCurve arg1, FBTime arg2)
	Evaluate FCurve at pTime. More...

int	KeyAdd (FBFCurve arg1, FBTime arg2, object arg3)
	Add a key at the specified time. More...

	KeyInsert (FBFCurve arg1, FBTime arg2, FBInterpolation arg3, FBTangentMode arg4)
	Insert a key without affecting the curve shape. More...

	KeyDelete (...)

bool	KeyDeleteByIndexRange (FBFCurve arg1, object arg2, object arg3)

bool	KeyDeleteByTimeRange (FBFCurve arg1, FBTime arg2, FBTime arg3, object arg4)

	KeyReplaceBy (FBFCurve arg1, FBFCurve arg2, FBTime arg3, FBTime arg4, object arg5, object arg6)
	Replace keys within a range in current function curve with keys found in a source function curve. More...

object	CreateInterpolatorCurve (FBFCurve arg1, FBInterpolatorCurveType arg2)
	Create and interpolator curve. More...

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

	SetPostExtrapolationMode (FBFCurve arg1, FBExtrapolationMode arg2)
	Set modes for post extrapolation. More...

int	GetPostExtrapolationCount (FBFCurve arg1)
	Get count for post extrapolation. More...

	SetPostExtrapolationCount (FBFCurve arg1, object arg2)
	Set count for post extrapolation. More...

FBExtrapolationMode	GetPreExtrapolationMode (FBFCurve arg1)
	Get modes for pre extrapolation. More...

	SetPreExtrapolationMode (FBFCurve arg1, FBExtrapolationMode arg2)
	Set modes for pre extrapolation. More...

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

	SetPreExtrapolationCount (FBFCurve arg1, object arg2)
	Set count for pre extrapolation. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

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

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Public Attributes
ORSDK2018::FBPropertyListFCurveKey	Keys
	List: Keys. More...

Public Attributes inherited from FBComponent
object	OwnerNamespace

ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...

ORSDK2018::FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__ ( object arg1 )

Constructor.

Python Docstring:

__init__( (object)arg1) -> None

C++ Signature:

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

Parameters

pObject For internal use only (default is NULL).

See the C++ reference

__reduce__ ( )

object CreateInterpolatorCurve	(	FBFCurve	arg1,
		FBInterpolatorCurveType	arg2
	)

Create and interpolator curve.

Python Docstring:

CreateInterpolatorCurve( (FBFCurve)arg1, (FBInterpolatorCurveType)arg2) -> object

C++ Signature:

ORSDK2018::FBFCurve * CreateInterpolatorCurve(FBInterpolatorCurveType pCurveType)

Parameters

pCurveType Interpolator curve type to create.

See the C++ reference

EditBegin	(	FBFCurve	arg1,
		object	arg2
	)

Setup function to begin adding keys.

Python Docstring:

EditBegin( (FBFCurve)arg1 [, (object)arg2]) -> None

C++ Signature:

void EditBegin(int pKeyCount = -1)

Parameters

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

See the C++ reference

EditClear ( FBFCurve arg1 )

Empty FCurve of all keys.

Python Docstring:

EditClear( (FBFCurve)arg1) -> None

C++ Signature:

void EditClear()

See the C++ reference

EditEnd	(	FBFCurve	arg1,
		object	arg2
	)

End key adding sequence.

Python Docstring:

EditEnd( (FBFCurve)arg1 [, (object)arg2]) -> None

C++ Signature:

void EditEnd(int pKeyCount = -1)

Parameters

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

See the C++ reference

float Evaluate	(	FBFCurve	arg1,
		FBTime	arg2
	)

Evaluate FCurve at pTime.

Python Docstring:

Evaluate( (FBFCurve)arg1, (FBTime)arg2) -> float

C++ Signature:

float Evaluate(ORSDK2018::FBTime & pTime)

Parameters

pTime Time at which FCurve is to be evaluated.

Returns: Value of FCurve at pTime.

See the C++ reference

int GetPostExtrapolationCount ( FBFCurve arg1 )

Get count for post extrapolation.

Python Docstring:

GetPostExtrapolationCount( (FBFCurve)arg1) -> int

C++ Signature:

long GetPostExtrapolationCount()

See the C++ reference

FBExtrapolationMode GetPostExtrapolationMode ( FBFCurve arg1 )

Get modes for post extrapolation.

Python Docstring:

GetPostExtrapolationMode( (FBFCurve)arg1) -> FBExtrapolationMode

C++ Signature:

FBExtrapolationMode GetPostExtrapolationMode()

See the C++ reference

int GetPreExtrapolationCount ( FBFCurve arg1 )

Get count for pre extrapolation.

Python Docstring:

GetPreExtrapolationCount( (FBFCurve)arg1) -> int

C++ Signature:

long GetPreExtrapolationCount()

See the C++ reference

FBExtrapolationMode GetPreExtrapolationMode ( FBFCurve arg1 )

Get modes for pre extrapolation.

Python Docstring:

GetPreExtrapolationMode( (FBFCurve)arg1) -> FBExtrapolationMode

C++ Signature:

FBExtrapolationMode GetPreExtrapolationMode()

See the C++ reference

int KeyAdd	(	FBFCurve	arg1,
		FBTime	arg2,
		object	arg3
	)

Add a key at the specified time.

Python Docstring:

KeyAdd( (FBFCurve)arg1, (FBTime)arg2, (object)arg3) -> int

C++ Signature:

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

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.

See the C++ reference

KeyDelete ( ... )

Python Docstring:

KeyDelete( (FBFCurve)arg1, (object)arg2, (object)arg3) -> bool

KeyDelete( (FBFCurve)arg1, (FBTime)arg2, (FBTime)arg3 [, (object)arg4]) -> bool

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool KeyDelete(int pStartIndex, int pStopIndex)
bool KeyDelete(ORSDK2018::FBTime pStart = FBTime::MinusInfinity, ORSDK2018::FBTime pStop = FBTime::Infinity, bool pInclusive = false)

bool KeyDeleteByIndexRange	(	FBFCurve	arg1,
		object	arg2,
		object	arg3
	)

Python Docstring:

KeyDeleteByIndexRange( (FBFCurve)arg1, (object)arg2, (object)arg3) -> bool

bool KeyDeleteByTimeRange	(	FBFCurve	arg1,
		FBTime	arg2,
		FBTime	arg3,
		object	arg4
	)

Python Docstring:

KeyDeleteByTimeRange( (FBFCurve)arg1, (FBTime)arg2, (FBTime)arg3 [, (object)arg4]) -> bool

KeyInsert	(	FBFCurve	arg1,
		FBTime	arg2,
		FBInterpolation	arg3,
		FBTangentMode	arg4
	)

Insert a key without affecting the curve shape.

Python Docstring:

KeyInsert( (FBFCurve)arg1, (FBTime)arg2 [, (FBInterpolation)arg3 [, (FBTangentMode)arg4]]) -> None

C++ Signature:

void KeyInsert(ORSDK2018::FBTime & pTime, FBInterpolation pInterpolation = kFBInterpolationCubic, FBTangentMode pTangentMode = kFBTangentModeAuto)

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

See the C++ reference

KeyReplaceBy	(	FBFCurve	arg1,
		FBFCurve	arg2,
		FBTime	arg3,
		FBTime	arg4,
		object	arg5,
		object	arg6
	)

Replace keys within a range in current function curve with keys found in a source function curve.

Python Docstring:

KeyReplaceBy( (FBFCurve)arg1, (FBFCurve)arg2 [, (FBTime)arg3 [, (FBTime)arg4 [, (object)arg5 [, (object)arg6]]]]) -> None

C++ Signature:

void KeyReplaceBy(ORSDK2018::FBFCurve & pSource, ORSDK2018::FBTime pStart = FBTime::MinusInfinity, ORSDK2018::FBTime pStop = FBTime::Infinity, bool pUseExactGivenSpan = false, bool pKeyStartEndOnNoKey = true)

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.

See the C++ reference

SetPostExtrapolationCount	(	FBFCurve	arg1,
		object	arg2
	)

Set count for post extrapolation.

Python Docstring:

SetPostExtrapolationCount( (FBFCurve)arg1, (object)arg2) -> None

C++ Signature:

void SetPostExtrapolationCount(int pCount)

See the C++ reference

SetPostExtrapolationMode	(	FBFCurve	arg1,
		FBExtrapolationMode	arg2
	)

Set modes for post extrapolation.

Python Docstring:

SetPostExtrapolationMode( (FBFCurve)arg1, (FBExtrapolationMode)arg2) -> None

C++ Signature:

void SetPostExtrapolationMode(FBExtrapolationMode pExtrapolationMode)

See the C++ reference

SetPreExtrapolationCount	(	FBFCurve	arg1,
		object	arg2
	)

Set count for pre extrapolation.

Python Docstring:

SetPreExtrapolationCount( (FBFCurve)arg1, (object)arg2) -> None

C++ Signature:

void SetPreExtrapolationCount(int pCount)

See the C++ reference

SetPreExtrapolationMode	(	FBFCurve	arg1,
		FBExtrapolationMode	arg2
	)

Set modes for pre extrapolation.

Python Docstring:

SetPreExtrapolationMode( (FBFCurve)arg1, (FBExtrapolationMode)arg2) -> None

C++ Signature:

void SetPreExtrapolationMode(FBExtrapolationMode pExtrapolationMode)

See the C++ reference

Member Data Documentation

ORSDK2018::FBPropertyListFCurveKey Keys

List: Keys.

See the C++ reference

FBFCurve Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation