FBProfileTimeEvent Class Reference
 
 
 
FBProfileTimeEvent Class Reference

#include <mobu-python-api.h>


Class Description

FBProfileTimeEvent. Time event information is collected during sampling (activated with a property in FBProfiler ActiveSampling). Events that can be collected are: render, evaluation, model evaluation, model deformation, synchronization of evaluation and rendering, playback commands, etc. Sampling will stop when the buffers maximum size is reached (maximum is 10MB). Currently users are not able to register any new events from ORSDK/python

Public Member Functions

def  __reduce__ ()
def  GetTime ()
def  GetColor ()
def  GetTypeName ()
def  GetComment ()
def  GetThreadID ()
def  IsSingleEvent ()
def  __init__ ()

Member Function Documentation

def __reduce__ ( )
def GetTime ( )

Python Docstring:

GetTime( (FBProfileTimeEvent)arg1) -> FBTime 

C++ Signature:

FBTime GetTime() 

Get the time when the event occurred.

def GetColor ( )

Python Docstring:

GetColor( (FBProfileTimeEvent)arg1) -> FBColor 

C++ Signature:

const float * GetColor() 

Get the color assigned to the event.

def GetTypeName ( )

Python Docstring:

GetTypeName( (FBProfileTimeEvent)arg1) -> str 

C++ Signature:

const char * GetTypeName() 

Get the event registered type name.

def GetComment ( )

Python Docstring:

GetComment( (FBProfileTimeEvent)arg1) -> str 

C++ Signature:

const char * GetComment() 

Get the comment for the event. Comments are not editable.

def GetThreadID ( )

Python Docstring:

GetThreadID( (FBProfileTimeEvent)arg1) -> int 

C++ Signature:

int GetThreadID() 

Get the thread ID used in the event execution.

def IsSingleEvent ( )

Python Docstring:

IsSingleEvent( (FBProfileTimeEvent)arg1) -> bool 

C++ Signature:

bool IsSingleEvent() 

Three types of events exits: single, start and end. Some actions that takes more time to execute or when other events can occur inbetween are collected with start time event at begin and end time event at finish.

def __init__ ( )

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

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

 FBProfileTimeEvent()
 FBProfileTimeEvent(const FBProfileTimeEvent & )