#include <mobu-python-api.h>

Class Description

Base Device class. Cannot be instantiated from Python.

Inheritance diagram for FBDevice:

Public Member Functions
	__reduce__ ()

	AckOneSampleReceived (FBDevice arg1)
	Acknowlege that one sample was received (for statistical purposes). More...

	AckOneBadSampleReceived (FBDevice arg1)
	Acknowlege that one bad sample was received (for statistical purposes). More...

	AckOneSampleSent (FBDevice arg1)
	Acknowlege that one sample was sent (for statistical purposes). More...

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

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

	RecordingDoneAnimation (FBDevice arg1, FBAnimationNode arg2)
	When recording, finish animation. More...

	RecordingInitAnimation (FBDevice arg1, FBAnimationNode arg2)
	When recording, initialize animation. More...

object	ModelBindingCreate (FBDevice arg1)
	Create a new model binding. More...

	ModelBindingRootsList (FBDevice arg1, FBModelList arg2)
	Get the list of all the possible root models for binding. More...

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

Public Member Functions inherited from FBBox
	__reduce__ ()

bool	AnimationNodeDestroy (FBBox arg1, FBAnimationNode arg2)
	Destroy an animation node. More...

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

object	AnimationNodeInGet (FBBox arg1)
	Get the (IN/OUT) animation node for this box. More...

bool	AnimationNodeIsUserData (FBBox arg1, FBAnimationNode arg2)
	Is the animation node user data? More...

object	AnimationNodeOutGet (FBBox arg1)

int	GetOutConnectorCount (FBBox arg1)
	Get the number of animation node outputs for this box. More...

int	GetInConnectorCount (FBBox arg1)
	Get the number of animation node inputs for this box. More...

object	GetOutConnector (FBBox arg1, object arg2)
	Get the animation node output associated with the given index. More...

object	GetInConnector (FBBox arg1, object arg2)
	Get the animation node input associated with the given index. 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
FBPropertyInt	CommType
	Read Write Property: Type of communications. More...

ORSDK2018::FBPropertyString	HardwareVersionInfo
	Read Write Property: Device information: hardware version. More...

ORSDK2018::FBPropertyString	Information
	Read Write Property: Device information: information. More...

ORSDK2018::FBModelTemplate	ModelTemplate
	Component: Root of model template structure. More...

FBPropertyModel	ModelBindingRoot
	Component: Root of model currently binded model hierarchy. More...

FBPropertyBool	Online
	Read Write Property: Is online? More...

FBPropertyTime	RecordingStartTime
	Read Only Property: The time at which the recording started. More...

FBPropertyTime	RecordingStopTime
	Read Only Property: The time at which the recording stopped. More...

FBPropertyDeviceSamplingMode	SamplingMode
	Read Write Property: Mode to use to record device. More...

FBPropertyTime	SamplingPeriod
	Read Write Property: Set this to how many times a device is to be evaluated in one second. More...

ORSDK2018::FBPropertyString	Status
	Read Write Property: Device information: status. More...

Public Attributes inherited from FBBox
FBPropertyBool	Animatable
	Read Write Property: Is the box animatable. More...

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

FBPropertyBool	RecordMode
	Read Write Property: Is recording? More...

const char *	UniqueName
	internal Unique name. 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__ ( ... )

Constructor.

Python Docstring:

Raises an exception
This class cannot be instantiated from Python

C++ Signature:

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

Parameters

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

See the C++ reference

__reduce__ ( )

AckOneBadSampleReceived ( FBDevice arg1 )

Acknowlege that one bad sample was received (for statistical purposes).

Python Docstring:

AckOneBadSampleReceived( (FBDevice)arg1) -> None

C++ Signature:

void AckOneBadSampleReceived()

See the C++ reference

AckOneSampleReceived ( FBDevice arg1 )

Acknowlege that one sample was received (for statistical purposes).

Python Docstring:

AckOneSampleReceived( (FBDevice)arg1) -> None

C++ Signature:

void AckOneSampleReceived()

See the C++ reference

AckOneSampleSent ( FBDevice arg1 )

Acknowlege that one sample was sent (for statistical purposes).

Python Docstring:

AckOneSampleSent( (FBDevice)arg1) -> None

C++ Signature:

void AckOneSampleSent()

See the C++ reference

bool FBCreate ( FBDevice arg1 )

Open Reality Creation function.

Python Docstring:

FBCreate( (FBDevice)arg1) -> bool

C++ Signature:

bool FBCreate()

Returns: Outcome of creation (true/false).

See the C++ reference

FBDestroy ( FBDevice arg1 )

Open Reality destruction function.

Python Docstring:

FBDestroy( (FBDevice)arg1) -> None

C++ Signature:

void FBDestroy()

See the C++ reference

object ModelBindingCreate ( FBDevice arg1 )

Create a new model binding.

Python Docstring:

ModelBindingCreate( (FBDevice)arg1) -> object

C++ Signature:

ORSDK2018::FBModel * ModelBindingCreate()

Returns: The model root that has been created or NULL is an error occured.

See the C++ reference

ModelBindingRootsList	(	FBDevice	arg1,
		FBModelList	arg2
	)

Get the list of all the possible root models for binding.

Python Docstring:

ModelBindingRootsList( (FBDevice)arg1, (FBModelList)arg2) -> None

C++ Signature:

void ModelBindingRootsList(FBModelList & pList)

Return values

pList List to add found models to.

See the C++ reference

RecordingDoneAnimation	(	FBDevice	arg1,
		FBAnimationNode	arg2
	)

When recording, finish animation.

Python Docstring:

RecordingDoneAnimation( (FBDevice)arg1, (FBAnimationNode)arg2) -> None

C++ Signature:

void RecordingDoneAnimation(ORSDK2018::FBAnimationNode * pAnimationNode)

Parameters

pAnimationNode Animation node to write information to.

See the C++ reference

RecordingInitAnimation	(	FBDevice	arg1,
		FBAnimationNode	arg2
	)

When recording, initialize animation.

Python Docstring:

RecordingInitAnimation( (FBDevice)arg1, (FBAnimationNode)arg2) -> None

C++ Signature:

void RecordingInitAnimation(ORSDK2018::FBAnimationNode * pAnimationNode)

Parameters

pAnimationNode Animation node to read information from.

See the C++ reference

Member Data Documentation

FBPropertyInt CommType

Read Write Property: Type of communications.

See the C++ reference

ORSDK2018::FBPropertyString HardwareVersionInfo

Read Write Property: Device information: hardware version.

See the C++ reference

ORSDK2018::FBPropertyString Information

Read Write Property: Device information: information.

See the C++ reference

FBPropertyModel ModelBindingRoot

Component: Root of model currently binded model hierarchy.

See the C++ reference

ORSDK2018::FBModelTemplate ModelTemplate

Component: Root of model template structure.

See the C++ reference

FBPropertyBool Online

Read Write Property: Is online?

See the C++ reference

FBPropertyTime RecordingStartTime

Read Only Property: The time at which the recording started.

See the C++ reference

FBPropertyTime RecordingStopTime

Read Only Property: The time at which the recording stopped.

See the C++ reference

FBPropertyDeviceSamplingMode SamplingMode

Read Write Property: Mode to use to record device.

See the C++ reference

FBPropertyTime SamplingPeriod

Read Write Property: Set this to how many times a device is to be evaluated in one second.

There is no theoretical maximum value but practically you should consider scene complexity, system resources, network speed, etc. If set to 0: the device is evaluated on the sync signal. When the sync occurs; the device is scheduled to be evaluated. If you do not set, the sampling period is based on the internal variable from the [Sync] section of the .Application.txt file (NTSC, PAL, CINEMA).

See the C++ reference

ORSDK2018::FBPropertyString Status

Read Write Property: Device information: status.

See the C++ reference

FBDevice Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation