Urho3D::Engine Class Reference

Urho3D engine. Creates the other subsystems. More...

#include <Urho3D/Engine/Engine.h>

Inheritance diagram for Urho3D::Engine:

Collaboration diagram for Urho3D::Engine:

Public Member Functions
	Engine (Context *context)
	Construct.
virtual	~Engine ()
	Destruct. Free all subsystems.
bool	Initialize (const VariantMap &parameters)
	Initialize engine using parameters given and show the application window. Return true if successful.
bool	InitializeResourceCache (const VariantMap &parameters, bool removeOld=true)
	Reinitialize resource cache subsystem using parameters given. Implicitly called by Initialize. Return true if successful.
void	RunFrame ()
	Run one frame.
Console *	CreateConsole ()
	Create the console and return it. May return null if engine configuration does not allow creation (headless mode.)
DebugHud *	CreateDebugHud ()
	Create the debug hud.
void	SetMinFps (int fps)
	Set minimum frames per second. If FPS goes lower than this, time will appear to slow down.
void	SetMaxFps (int fps)
	Set maximum frames per second. The engine will sleep if FPS is higher than this.
void	SetMaxInactiveFps (int fps)
	Set maximum frames per second when the application does not have input focus.
void	SetTimeStepSmoothing (int frames)
	Set how many frames to average for timestep smoothing. Default is 2. 1 disables smoothing.
void	SetPauseMinimized (bool enable)
	Set whether to pause update events and audio when minimized.
void	SetAutoExit (bool enable)
	Set whether to exit automatically on exit request (window close button.)
void	SetNextTimeStep (float seconds)
	Override timestep of the next frame. Should be called in between RunFrame() calls.
void	Exit ()
	Close the graphics window and set the exit flag. No-op on iOS/tvOS, as an iOS/tvOS application can not legally exit.
void	DumpProfiler ()
	Dump profiling information to the log.
void	DumpResources (bool dumpFileName=false)
	Dump information of all resources to the log.
void	DumpMemory ()
	Dump information of all memory allocations to the log. Supported in MSVC debug mode only.
float	GetNextTimeStep () const
	Get timestep of the next frame. Updated by ApplyFrameLimit().
int	GetMinFps () const
	Return the minimum frames per second.
int	GetMaxFps () const
	Return the maximum frames per second.
int	GetMaxInactiveFps () const
	Return the maximum frames per second when the application does not have input focus.
int	GetTimeStepSmoothing () const
	Return how many frames to average for timestep smoothing.
bool	GetPauseMinimized () const
	Return whether to pause update events and audio when minimized.
bool	GetAutoExit () const
	Return whether to exit automatically on exit request.
bool	IsInitialized () const
	Return whether engine has been initialized.
bool	IsExiting () const
	Return whether exit has been requested.
bool	IsHeadless () const
	Return whether the engine has been created in headless mode.
void	Update ()
	Send frame update events.
void	Render ()
	Render after frame update.
void	ApplyFrameLimit ()
	Get the timestep for the next frame and sleep for frame limiting if necessary.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash.
virtual const String &	GetTypeName () const =0
	Return type name.
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.
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	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.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
	Return global variable based on key.
const VariantMap &	GetGlobalVars () const
	Return all global variables.
void	SetGlobalVar (StringHash key, const Variant &value)
	Set global variable with the respective key and 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
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
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.
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
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Static Public Member Functions
static VariantMap	ParseParameters (const Vector< String > &arguments)
	Parse the engine startup parameters map from command line arguments.
static bool	HasParameter (const VariantMap &parameters, const String &parameter)
	Return whether startup parameters contains a specific parameter.
static const Variant &	GetParameter (const VariantMap &parameters, const String &parameter, const Variant &defaultValue=Variant::EMPTY)
	Get an engine startup parameter, with default value if missing.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (Engine, Object)
void	HandleExitRequested (StringHash eventType, VariantMap &eventData)
	Handle exit requested event. Auto-exit if enabled.
void	DoExit ()
	Actually perform the exit actions.

Private Attributes
HiresTimer	frameTimer_
	Frame update timer.
PODVector< float >	lastTimeSteps_
	Previous timesteps for smoothing.
float	timeStep_
	Next frame timestep in seconds.
unsigned	timeStepSmoothing_
	How many frames to average for the smoothed timestep.
unsigned	minFps_
	Minimum frames per second.
unsigned	maxFps_
	Maximum frames per second.
unsigned	maxInactiveFps_
	Maximum frames per second when the application does not have input focus.
bool	pauseMinimized_
	Pause when minimized flag.
bool	autoExit_
	Auto-exit flag.
bool	initialized_
	Initialized flag.
bool	exiting_
	Exiting flag.
bool	headless_
	Headless mode flag.
bool	audioPaused_
	Audio paused flag.

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

Detailed Description

Urho3D engine. Creates the other subsystems.

---

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

• Source/Urho3D/Engine/Engine.h
• Source/Urho3D/Engine/Engine.cpp