Urho3D::Time Class Reference

Time and frame counter subsystem. More...

#include <Urho3D/Core/Timer.h>

Inheritance diagram for Urho3D::Time:

Collaboration diagram for Urho3D::Time:

Public Member Functions
	Time (Context *context)
	Construct.
	~Time () override
	Destruct. Reset the low-resolution timer period if set.
void	BeginFrame (float timeStep)
	Begin new frame, with (last) frame duration in seconds and send frame start event.
void	EndFrame ()
	End frame. Increment total time and send frame end event.
void	SetTimerPeriod (unsigned mSec)
	Set the low-resolution timer period in milliseconds. 0 resets to the default period.
unsigned	GetFrameNumber () const
float	GetTimeStep () const
unsigned	GetTimerPeriod () const
	Return current low-resolution timer period in milliseconds.
float	GetElapsedTime ()
float	GetFramesPerSecond () const
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 ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Static Public Member Functions
static unsigned	GetSystemTime ()
	Get system time as milliseconds.
static unsigned	GetTimeSinceEpoch ()
	Get system time as seconds since 1.1.1970.
static String	GetTimeStamp ()
	Get a date/time stamp as a string.
static void	Sleep (unsigned mSec)
	Sleep for a number of milliseconds.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (Time, Object)

Private Attributes
Timer	elapsedTime_
	Elapsed time since program start.
unsigned	frameNumber_
	Frame number.
float	timeStep_
	Timestep in seconds.
unsigned	timerPeriod_
	Low-resolution timer period.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Time and frame counter subsystem.

Member Function Documentation

GetElapsedTime()

float Urho3D::Time::GetElapsedTime

(

)

Return elapsed time from program start as seconds.

Here is the call graph for this function:

GetFrameNumber()

unsigned Urho3D::Time::GetFrameNumber ( ) const

inline

Return frame number, starting from 1 once BeginFrame() is called for the first time.

GetFramesPerSecond()

float Urho3D::Time::GetFramesPerSecond

(

)

const

Return current frames per second.

GetTimeStep()

float Urho3D::Time::GetTimeStep ( ) const

inline

Return current frame timestep as seconds.

---

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

• Source/Urho3D/Core/Timer.h
• Source/Urho3D/Core/Timer.cpp