#include <mobu-python-api.h>

Class Description

Central place to query profiling results and change profiling options.

Inheritance diagram for FBProfiler:

Public Member Functions
	__reduce__ ()

	__init__ (object arg1)
	Constructor. More...

int	GetEventSampleCount (FBProfiler arg1)
	Get number of time event samples collected during last sampling. More...

FBProfileTimeEvent	GetEventSample (FBProfiler arg1, object arg2)
	Only possible way to query collected FBProfileTimeEvent. More...

FBProfileTimeEvent	GetEndEventSample (FBProfiler arg1, object arg2)
	Get end time event for event at given index. More...

int	GetStatCount (FBProfiler arg1)
	Stats are holding last execution time/duration of action. More...

int	GetStatIndex (FBProfiler arg1, str arg2)
	Search for index of given stat name. More...

str	GetStatName (FBProfiler arg1, object arg2)
	Get information about what action is stat refering to. More...

str	GetStatComment (FBProfiler arg1, object arg2)
	Get aditional information about what action is stat refering to. More...

float	GetStatStart (FBProfiler arg1, object arg2)
	Get start time of action. More...

float	GetStatStop (FBProfiler arg1, object arg2)
	Get stop time of action. More...

float	GetStatDuration (FBProfiler arg1, object arg2)
	Get time that was spend on execution of action. More...

float	GetProfilingCost (FBProfiler arg1)
	Profiling collection can affect scene performace. 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
FBPropertyProfilingMode	ProfilingMode
	Read/Write Property: Profiling collection modes, including disabling all profiling. More...

FBPropertyInt	EvaluationDepth
	Read/Write Property: Specify the depth of evaluation profiling for data collection (maximum value is 10). More...

FBPropertyInt	BufferSize
	Read/Write Property: Buffer size for average and timing computation (maximum value 200). More...

FBPropertyBool	FrameReference
	Read/Write Property: Draw task cycles in relation to main thread cycle time - frame cycle (percentage display). More...

FBPropertyBool	ActiveSampling
	Read/Write Property: Activate the sampling for time events. 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:

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

Parameters

pObject For internal use only.

See the C++ reference

__reduce__ ( )

FBProfileTimeEvent GetEndEventSample	(	FBProfiler	arg1,
		object	arg2
	)

Get end time event for event at given index.

Python Docstring:

GetEndEventSample( (FBProfiler)arg1, (object)arg2) -> FBProfileTimeEvent

C++ Signature:

ORSDK2018::FBProfileTimeEvent * GetEndEventSample(int pIndex)

This function and FBProfileTimeEvent.IsSingleEvent are useful to identify duration of event action.

Parameters

pIndex Sample index.

Returns: Sample object if sample at given index is start sample.

See the C++ reference

FBProfileTimeEvent GetEventSample	(	FBProfiler	arg1,
		object	arg2
	)

Only possible way to query collected FBProfileTimeEvent.

Python Docstring:

GetEventSample( (FBProfiler)arg1, (object)arg2) -> FBProfileTimeEvent

C++ Signature:

ORSDK2018::FBProfileTimeEvent * GetEventSample(int pIndex)

Parameters

pIndex Sample index.

Returns: Sample object.

See the C++ reference

int GetEventSampleCount ( FBProfiler arg1 )

Get number of time event samples collected during last sampling.

Python Docstring:

GetEventSampleCount( (FBProfiler)arg1) -> int

C++ Signature:

int GetEventSampleCount()

Returns: Number of FBProfileTimeEvent samples gathered during sampling.

See the C++ reference

float GetProfilingCost ( FBProfiler arg1 )

Profiling collection can affect scene performace.

Python Docstring:

GetProfilingCost( (FBProfiler)arg1) -> float

C++ Signature:

double GetProfilingCost()

This function return how costly is profiling.

Returns: Cost of profiling the scene. (in mini seconds)

See the C++ reference

str GetStatComment	(	FBProfiler	arg1,
		object	arg2
	)

Get aditional information about what action is stat refering to.

Python Docstring:

GetStatComment( (FBProfiler)arg1, (object)arg2) -> str

C++ Signature:

const char * GetStatComment(int pIndex)

Parameters

pIndex Index of stat.

Returns: Stat comment.

See the C++ reference

int GetStatCount ( FBProfiler arg1 )

Stats are holding last execution time/duration of action.

Python Docstring:

GetStatCount( (FBProfiler)arg1) -> int

C++ Signature:

int GetStatCount()

They are used for actions that doesn't appear frequently, like file IO.

Returns: Stats count. They are created when stat occurs, so open or save action needs to be done first to get any information stored in stats.

See the C++ reference

float GetStatDuration	(	FBProfiler	arg1,
		object	arg2
	)

Get time that was spend on execution of action.

Python Docstring:

GetStatDuration( (FBProfiler)arg1, (object)arg2) -> float

C++ Signature:

double GetStatDuration(int pIndex)

Parameters

pIndex Index of stat.

Returns: Stat duration (in seconds).

See the C++ reference

int GetStatIndex	(	FBProfiler	arg1,
		str	arg2
	)

Search for index of given stat name.

Python Docstring:

GetStatIndex( (FBProfiler)arg1, (str)arg2) -> int

C++ Signature:

int GetStatIndex(const char * pName)

Parameters

pName Name of the sample that we are looking for.

Returns: Stat index if found, -1 if not in the list.

See the C++ reference

str GetStatName	(	FBProfiler	arg1,
		object	arg2
	)

Get information about what action is stat refering to.

Python Docstring:

GetStatName( (FBProfiler)arg1, (object)arg2) -> str

C++ Signature:

const char * GetStatName(int pIndex)

Parameters

pIndex Index of stat.

Returns: Stat name.

See the C++ reference

float GetStatStart	(	FBProfiler	arg1,
		object	arg2
	)

Get start time of action.

Python Docstring:

GetStatStart( (FBProfiler)arg1, (object)arg2) -> float

C++ Signature:

double GetStatStart(int pIndex)

Parameters

pIndex Index of stat.

Returns: Start time (in seconds).

See the C++ reference

float GetStatStop	(	FBProfiler	arg1,
		object	arg2
	)

Get stop time of action.

Python Docstring:

GetStatStop( (FBProfiler)arg1, (object)arg2) -> float

C++ Signature:

double GetStatStop(int pIndex)

Parameters

pIndex Index of stat.

Returns: Stop time (in seconds).

See the C++ reference

Member Data Documentation

FBPropertyBool ActiveSampling

Read/Write Property: Activate the sampling for time events.

Call before quering for FBProfileTimeEvent.

See the C++ reference

FBPropertyInt BufferSize

Read/Write Property: Buffer size for average and timing computation (maximum value 200).

See the C++ reference

FBPropertyInt EvaluationDepth

Read/Write Property: Specify the depth of evaluation profiling for data collection (maximum value is 10).

See the C++ reference

FBPropertyBool FrameReference

Read/Write Property: Draw task cycles in relation to main thread cycle time - frame cycle (percentage display).

See the C++ reference

FBPropertyProfilingMode ProfilingMode

Read/Write Property: Profiling collection modes, including disabling all profiling.

See the C++ reference

FBProfiler Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation