Urho3D::EventProfiler Class Reference

Hierarchical performance event profiler subsystem. More...

#include </var/dev/u3d/stable/Source/Urho3D/Core/EventProfiler.h>

Inheritance diagram for Urho3D::EventProfiler:

Collaboration diagram for Urho3D::EventProfiler:

Public Member Functions
	EventProfiler (Context *context)
	Construct.
void	BeginBlock (StringHash eventID)
	Begin timing a profiling block based on an event ID.
Public Member Functions inherited from Urho3D::Profiler
	Profiler (Context *context)
	Construct.
	~Profiler () override
	Destruct.
void	BeginBlock (const char *name)
	Begin timing a profiling block.
void	EndBlock ()
	End timing the current profiling block.
void	BeginFrame ()
	Begin the profiling frame. Called by HandleBeginFrame().
void	EndFrame ()
	End the profiling frame. Called by HandleEndFrame().
void	BeginInterval ()
	Begin a new interval.
const String &	PrintData (bool showUnused=false, bool showTotal=false, unsigned maxDepth=M_MAX_UNSIGNED) const
	Return profiling data as text output. This method is not thread-safe.
const ProfilerBlock *	GetCurrentBlock ()
	Return the current profiling block.
const ProfilerBlock *	GetRootBlock ()
	Return the root profiling block.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const String &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, Args... args)
	Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const String &	GetCategory () const
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
void	AddRef ()
void	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Static Public Member Functions
static void	SetActive (bool newActive)
	Activate the event profiler to collect information. This incurs slight performance hit on each SendEvent. By default inactive.
static bool	IsActive ()
	Return true if active.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (EventProfiler, Profiler)

Static Private Attributes
static bool	active = false
	Profiler active. Default false.

Additional Inherited Members
Protected Member Functions inherited from Urho3D::Profiler
void	PrintData (ProfilerBlock *block, String &output, unsigned depth, unsigned maxDepth, bool showUnused, bool showTotal) const
	Return profiling data as text output for a specified profiling block.
Protected Attributes inherited from Urho3D::Profiler
ProfilerBlock *	current_
	Current profiling block.
ProfilerBlock *	root_
	Root profiling block.
unsigned	intervalFrames_
	Frames in the current interval.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Hierarchical performance event profiler subsystem.

---

The documentation for this class was generated from the following files:

• /var/dev/u3d/stable/Source/Urho3D/Core/EventProfiler.h
• /var/dev/u3d/stable/Source/Urho3D/Core/EventProfiler.cpp