#include <mobu-python-api.h>

Class Description

Inheritance diagram for FBAnimationNode:

Public Member Functions
	__reduce__ ()

FBTime	ConvertGlobalToNodeTime (FBAnimationNode arg1, FBTime arg2)
	Convert global time to node time. More...

	__init__ (object arg1, str arg2)
	Constructor. More...

FBTime	ConvertNodeToGlobalTime (FBAnimationNode arg1, FBTime arg2)
	Convert node time to global time. More...

object	GetAnimationToRecord (FBAnimationNode arg1)
	Get animation node to record to. More...

object	GetAnimationToPlay (FBAnimationNode arg1)
	Get animation node to play from. More...

int	GetDataDoubleArrayCount (FBAnimationNode arg1)
	If the DataPtr is of numeric value type ... More...

int	GetSizeOfData (FBAnimationNode arg1)
	Get sizeof void Data Ptr. More...

bool	IsKey (FBAnimationNode arg1)
	Verifies if there is a key at the current. More...

	KeyAdd (...)

	KeyCandidate (FBAnimationNode arg1, FBTime arg2)
	Keys the current candidate values if no time is specified, at current time. More...

	KeyRemove (FBAnimationNode arg1)
	Remove key at current time. More...

	KeyRemoveAt (FBAnimationNode arg1, FBTime arg2)
	Remove key at the specified time. More...

bool	SetCandidate (FBAnimationNode arg1, list arg2, object arg3)
	Set the current candidate values for current time. More...

	SetBufferType (FBAnimationNode arg1, object arg2)
	Set buffer type for ANIMATIONNODE_TYPE_LOCAL_TRANSLATION, ANIMATIONNODE_TYPE_LOCAL_ROTATION and ANIMATIONNODE_TYPE_LOCAL_SCALE. More...

	ReadData (...)

list	ReadLastEvalData (FBAnimationNode arg1)

int	WriteData (FBAnimationNode arg1, list arg2, FBEvaluateInfo arg3)
	Write data to animation node. 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::FBPropertyString	Label
	Read Write Property: Label (UI Name). More...

FBPropertyFCurve	FCurve
	Read Write Property: FCurve for animation. More...

FBPropertyInt	KeyCount
	Read Only Property: Number of keys. More...

FBPropertyBool	Live
	Read Write Property: Is animation live? More...

ORSDK2018::FBPropertyListAnimationNode	Nodes
	List: List of animation nodes. More...

FBPropertyBool	RecordMode
	Read Write Property: Is the node in recording mode (device connectors)? More...

ORSDK2018::FBPropertyString	UserName
	Read Only Property: Name of animation node. More...

FBPropertyInterpolation	DefaultInterpolation
	Read Write Property: Default type of interpolation. More...

FBPropertyAnimationNodeConnectorType	ConnectorType
	Read Only Property: Animation node connector type. 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,
		str	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None

C++ Signature:

 FBAnimationNode(const char * pName = ((void *) 0), HIObject pObject = ((void *) 0))

Parameters

pName	Name of animation node (default is NULL).
pObject	For internal use only (default is NULL).

See the C++ reference

__reduce__ ( )

FBTime ConvertGlobalToNodeTime	(	FBAnimationNode	arg1,
		FBTime	arg2
	)

Convert global time to node time.

Python Docstring:

ConvertGlobalToNodeTime( (FBAnimationNode)arg1, (FBTime)arg2) -> FBTime

C++ Signature:

ORSDK2018::FBTime ConvertGlobalToNodeTime(ORSDK2018::FBTime & pKeyTime)

(NOTE: Only used in the context of a story clip)

Parameters

pKeyTime Time of the key to convert.

See the C++ reference

FBTime ConvertNodeToGlobalTime	(	FBAnimationNode	arg1,
		FBTime	arg2
	)

Convert node time to global time.

Python Docstring:

ConvertNodeToGlobalTime( (FBAnimationNode)arg1, (FBTime)arg2) -> FBTime

C++ Signature:

ORSDK2018::FBTime ConvertNodeToGlobalTime(ORSDK2018::FBTime & pKeyTime)

(NOTE: Only used in the context of a story clip)

Parameters

pKeyTime Time of the key to convert.

See the C++ reference

object GetAnimationToPlay ( FBAnimationNode arg1 )

Get animation node to play from.

Python Docstring:

GetAnimationToPlay( (FBAnimationNode)arg1) -> object

C++ Signature:

ORSDK2018::FBAnimationNode * GetAnimationToPlay()

Returns: Animation node to be played.

See the C++ reference

object GetAnimationToRecord ( FBAnimationNode arg1 )

Get animation node to record to.

Python Docstring:

GetAnimationToRecord( (FBAnimationNode)arg1) -> object

C++ Signature:

ORSDK2018::FBAnimationNode * GetAnimationToRecord()

Returns: Animation node to record to.

See the C++ reference

int GetDataDoubleArrayCount ( FBAnimationNode arg1 )

If the DataPtr is of numeric value type ...

Python Docstring:

GetDataDoubleArrayCount( (FBAnimationNode)arg1) -> int

C++ Signature:

int GetDataDoubleArrayCount()

get the size of the array ex: Light Intensity:1, Translation 3

Returns: Size of DataPtr array.

See the C++ reference

int GetSizeOfData ( FBAnimationNode arg1 )

Get sizeof void Data Ptr.

Python Docstring:

GetSizeOfData( (FBAnimationNode)arg1) -> int

C++ Signature:

int GetSizeOfData()

See the C++ reference

bool IsKey ( FBAnimationNode arg1 )

Verifies if there is a key at the current.

Python Docstring:

IsKey( (FBAnimationNode)arg1) -> bool

C++ Signature:

bool IsKey()

Returns: true if there is a key at the current time.

See the C++ reference

KeyAdd ( ... )

Python Docstring:

KeyAdd( (FBAnimationNode)arg1, (FBTime)arg2, (object)arg3 [, (FBInterpolation)arg4 [, (FBTangentMode)arg5]]) -> None

KeyAdd( (FBAnimationNode)arg1, (object)arg2 [, (FBInterpolation)arg3 [, (FBTangentMode)arg4]]) -> None

KeyAdd( (FBAnimationNode)arg1, (FBTime)arg2, (list)arg3 [, (FBInterpolation)arg4 [, (FBTangentMode)arg5]]) -> None

KeyAdd( (FBAnimationNode)arg1, (list)arg2 [, (FBInterpolation)arg3 [, (FBTangentMode)arg4]]) -> None

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

void KeyAdd(const ORSDK2018::FBTime & pTime, double * pData, FBInterpolation pInterpolation = kFBInterpolationCubic, FBTangentMode pTangentMode = kFBTangentModeAuto)
void KeyAdd(double * pData, FBInterpolation pInterpolation = kFBInterpolationCubic, FBTangentMode pTangentMode = kFBTangentModeAuto)

KeyCandidate	(	FBAnimationNode	arg1,
		FBTime	arg2
	)

Keys the current candidate values if no time is specified, at current time.

Python Docstring:

KeyCandidate( (FBAnimationNode)arg1 [, (FBTime)arg2]) -> None

C++ Signature:

void KeyCandidate(ORSDK2018::FBTime pTime = FBTime::Infinity)

Parameters

pTime Time at which to insert the key.

See the C++ reference

KeyRemove ( FBAnimationNode arg1 )

Remove key at current time.

Python Docstring:

KeyRemove( (FBAnimationNode)arg1) -> None

C++ Signature:

void KeyRemove()

See the C++ reference

KeyRemoveAt	(	FBAnimationNode	arg1,
		FBTime	arg2
	)

Remove key at the specified time.

Python Docstring:

KeyRemoveAt( (FBAnimationNode)arg1, (FBTime)arg2) -> None

C++ Signature:

void KeyRemoveAt(ORSDK2018::FBTime pTime)

Parameters

pTime Time for the key

See the C++ reference

ReadData ( ... )

Python Docstring:

ReadData( (FBAnimationNode)arg1 [, (FBEvaluateInfo)arg2 [, (object)arg3]]) -> list

ReadData( (FBAnimationNode)arg1, (FBTime)arg2 [, (object)arg3]) -> list

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

bool ReadData(double * Data, ORSDK2018::FBEvaluateInfo * pEvaluateInfo, bool pConvertGlobalToLocal = false)
bool ReadData(double * Data, ORSDK2018::FBTime pTime, bool pConvertGlobalToLocal = false)
bool ReadData(double * Data)

list ReadLastEvalData ( FBAnimationNode arg1 )

Python Docstring:

ReadLastEvalData( (FBAnimationNode)arg1) -> list

SetBufferType	(	FBAnimationNode	arg1,
		object	arg2
	)

Set buffer type for ANIMATIONNODE_TYPE_LOCAL_TRANSLATION, ANIMATIONNODE_TYPE_LOCAL_ROTATION and ANIMATIONNODE_TYPE_LOCAL_SCALE.

Python Docstring:

SetBufferType( (FBAnimationNode)arg1, (object)arg2) -> None

C++ Signature:

void SetBufferType(bool pGlobal)

Parameters

pGlobal Is buffer local or global.

See the C++ reference

bool SetCandidate	(	FBAnimationNode	arg1,
		list	arg2,
		object	arg3
	)

Set the current candidate values for current time.

Python Docstring:

SetCandidate( (FBAnimationNode)arg1, (list)arg2 [, (object)arg3]) -> bool

C++ Signature:

bool SetCandidate(double * Data, bool pCheckLocked = false)

Parameters

pCheckLocked Decides whether to check the locked status.

Returns: true if successful.

See the C++ reference

int WriteData	(	FBAnimationNode	arg1,
		list	arg2,
		FBEvaluateInfo	arg3
	)

Write data to animation node.

Python Docstring:

WriteData( (FBAnimationNode)arg1, (list)arg2 [, (FBEvaluateInfo)arg3]) -> int

C++ Signature:

bool WriteData(double * Data, ORSDK2018::FBEvaluateInfo * pEvaluateInfo)

Parameters

Data	Data to write to animation node.
pEvaluateInfo	Node evaluation information (access to system and local time).

Returns: true if successful.

See the C++ reference

Member Data Documentation

FBPropertyAnimationNodeConnectorType ConnectorType

Read Only Property: Animation node connector type.

See the C++ reference

FBPropertyInterpolation DefaultInterpolation

Read Write Property: Default type of interpolation.

See the C++ reference

FBPropertyFCurve FCurve

Read Write Property: FCurve for animation.

See the C++ reference

FBPropertyInt KeyCount

Read Only Property: Number of keys.

See the C++ reference

ORSDK2018::FBPropertyString Label

Read Write Property: Label (UI Name).

See the C++ reference

FBPropertyBool Live

Read Write Property: Is animation live?

See the C++ reference

ORSDK2018::FBPropertyListAnimationNode Nodes

List: List of animation nodes.

See the C++ reference

FBPropertyBool RecordMode

Read Write Property: Is the node in recording mode (device connectors)?

See the C++ reference

ORSDK2018::FBPropertyString UserName

Read Only Property: Name of animation node.

See the C++ reference

FBAnimationNode Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation