FBProfiler Class Reference

FBProfiler. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBProfiler:

Public Member Functions
	FBProfiler ()
	Constructor.
FBProfileTimeEvent	GetEndEventSample (int pIndex)
	Get end time event for event at given index.
FBProfileTimeEvent	GetEventSample (int pIndex)
	Only possible way to query collected FBProfileTimeEvent.
int	GetEventSampleCount ()
	Get number of time event samples collected during last sampling.
float	GetProfilingCost ()
	Profiling collection can affect scene performace.
str	GetStatComment (int pIndex)
	Get aditional information about what action is stat refering to.
int	GetStatCount ()
	Stats are holding last execution time/duration of action.
float	GetStatDuration (int pIndex)
	Get time that was spend on execution of action.
int	GetStatIndex (str pName)
	Search for index of given stat name.
str	GetStatName (int pIndex)
	Get information about what action is stat refering to.
float	GetStatStart (int pIndex)
	Get start time of action.
float	GetStatStop (int pIndex)
	Get stop time of action.
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
bool	ActiveSampling
	Read/Write Property: Activate the sampling for time events. Call before quering for FBProfileTimeEvent.
int	BufferSize
	Read/Write Property: Buffer size for average and timing computation (maximum value 200).
int	EvaluationDepth
	Read/Write Property: Specify the depth of evaluation profiling for data collection (maximum value is 10).
bool	FrameReference
	Read/Write Property: Draw task cycles in relation to main thread cycle time - frame cycle (percentage display).
FBProfilingMode	ProfilingMode
	Read/Write Property: Profiling collection modes, including disabling all profiling.
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

FBProfiler.

Central place to query profiling results and change profiling options.

See sample: CreateProfilingEventsLog.py.

Constructor & Destructor Documentation

FBProfiler()

FBProfiler

(

)

Constructor.

Member Function Documentation

GetEndEventSample()

FBProfileTimeEvent GetEndEventSample

(

int

pIndex

)

Get end time event for event at given index.

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.

GetEventSample()

FBProfileTimeEvent GetEventSample

(

int

pIndex

)

Only possible way to query collected FBProfileTimeEvent.

Parameters

pIndex

Sample index.

Returns

Sample object.

GetEventSampleCount()

int GetEventSampleCount

(

)

Get number of time event samples collected during last sampling.

Returns

Number of FBProfileTimeEvent samples gathered during sampling.

GetProfilingCost()

float GetProfilingCost

(

)

Profiling collection can affect scene performace.

This function return how costly is profiling.

Returns

Cost of profiling the scene. (in mini seconds)

GetStatComment()

str GetStatComment

(

int

pIndex

)

Get aditional information about what action is stat refering to.

Parameters

pIndex

Index of stat.

Returns

Stat comment.

GetStatCount()

int GetStatCount

(

)

Stats are holding last execution time/duration of action.

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.

GetStatDuration()

float GetStatDuration

(

int

pIndex

)

Get time that was spend on execution of action.

Parameters

pIndex

Index of stat.

Returns

Stat duration (in seconds).

GetStatIndex()

int GetStatIndex

(

str

pName

)

Search for index of given stat name.

Parameters

pName

Name of the sample that we are looking for.

Returns

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

GetStatName()

str GetStatName

(

int

pIndex

)

Get information about what action is stat refering to.

Parameters

pIndex

Index of stat.

Returns

Stat name.

GetStatStart()

float GetStatStart

(

int

pIndex

)

Get start time of action.

Parameters

pIndex

Index of stat.

Returns

Start time (in seconds).

GetStatStop()

float GetStatStop

(

int

pIndex

)

Get stop time of action.

Parameters

pIndex

Index of stat.

Returns

Stop time (in seconds).

Member Data Documentation

ActiveSampling

bool ActiveSampling

Read/Write Property: Activate the sampling for time events. Call before quering for FBProfileTimeEvent.

BufferSize

int BufferSize

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

EvaluationDepth

int EvaluationDepth

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

FrameReference

bool FrameReference

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

ProfilingMode

FBProfilingMode ProfilingMode

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