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

#include <Urho3D/Engine/Engine.h>

Inheritance diagram for Urho3D::Engine:

Public Member Functions
	Engine (Context *context)
	Construct.

	~Engine () override
	Destruct. Free all subsystems.

bool	Initialize (const StringVariantMap &applicationParameters, const StringVariantMap &commandLineParameters)
	Initialize engine using parameters given and show the application window. Return true if successful.

void	InitializeVirtualFileSystem (bool enableResourceRootFile)
	Initialize virtual filesystem. Implicitly called by Initialize.

void	RunFrame ()
	Run one frame.

void	OnCanvasResize (int width, int height, bool isFullScreen, float dpiScale)
	Web only. Process canvas resize event.

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)

void	SetMaxFps (int fps)

void	SetMaxInactiveFps (int fps)

void	SetTimeStepSmoothing (int frames)

void	SetPauseMinimized (bool enable)

void	SetAutoExit (bool enable)

void	SetNextTimeStep (float seconds)
	Override timestep of the next frame. Should be called in between RunFrame() calls.

void	SetParameter (const ea::string &name, const Variant &value)
	Set engine parameter. Not all parameter changes will have effect.

bool	HasParameter (const ea::string &name) const
	Return whether engine parameters contains a specific parameter.

const Variant &	GetParameter (const ea::string &name) const
	Return engine parameter or default value.

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.

const ea::string &	GetAppPreferencesDir () const
	Return preference directory name.

float	GetNextTimeStep () const
	Get timestep of the next frame. Updated by ApplyFrameLimit().

int	GetMinFps () const

int	GetMaxFps () const

int	GetMaxInactiveFps () const

int	GetTimeStepSmoothing () const

bool	GetPauseMinimized () const

bool	GetAutoExit () const

bool	IsInitialized () const

bool	IsExiting () const

bool	IsHeadless () const

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.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

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	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

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, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

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 ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

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.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Private Member Functions
	URHO3D_OBJECT (Engine, Object)

void	LoadConfigFiles ()
	Load and merge config files.

void	SaveConfigFile ()
	Save config file.

void	PopulateDefaultParameters ()
	Populate default parameter values.

void	HandleExitRequested (StringHash eventType, VariantMap &eventData)
	Set flag indicating that exit request has to be handled.

void	HandleEndFrame (StringHash eventType, VariantMap &eventData)
	Do housekeeping tasks at the end of frame. Actually handles exit requested event. Auto-exit if enabled.

void	DoExit ()
	Actually perform the exit actions.

ea::string	GetLogFileName (const ea::string &uri) const
	Return log file name in OS file system.

Private Attributes
SharedPtr< ConfigFile >	engineParameters_
	Engine parameters (default and current values).

ea::string	appPreferencesDir_
	App preference directory.

HiresTimer	frameTimer_
	Frame update timer.

ea::vector< 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.

long long	timeOut_
	Time out counter for testing.

bool	autoExit_
	Auto-exit flag.

bool	initialized_
	Initialized flag.

bool	exitRequired_ {}
	Whether the exit is required by operating system.

bool	exiting_
	Whether the exiting is in progress.

bool	headless_
	Headless mode flag.

bool	audioPaused_
	Audio paused flag.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Urho3D engine. Creates the other subsystems.

Member Function Documentation

◆ GetAutoExit()

bool Urho3D::Engine::GetAutoExit ( ) const

inline

Return whether to exit automatically on exit request.

◆ GetMaxFps()

int Urho3D::Engine::GetMaxFps ( ) const

inline

Return the maximum frames per second.

◆ GetMaxInactiveFps()

int Urho3D::Engine::GetMaxInactiveFps ( ) const

inline

Return the maximum frames per second when the application does not have input focus.

◆ GetMinFps()

int Urho3D::Engine::GetMinFps ( ) const

inline

Return the minimum frames per second.

◆ GetPauseMinimized()

bool Urho3D::Engine::GetPauseMinimized ( ) const

inline

Return whether to pause update events and audio when minimized.

◆ GetTimeStepSmoothing()

int Urho3D::Engine::GetTimeStepSmoothing ( ) const

inline

Return how many frames to average for timestep smoothing.

◆ IsExiting()

bool Urho3D::Engine::IsExiting ( ) const

inline

Return whether exit has been requested.

◆ IsHeadless()

bool Urho3D::Engine::IsHeadless ( ) const

inline

Return whether the engine has been created in headless mode.

◆ IsInitialized()

bool Urho3D::Engine::IsInitialized ( ) const

inline

Return whether engine has been initialized.

◆ SetAutoExit()

void Urho3D::Engine::SetAutoExit ( bool enable )

Set whether to exit automatically on exit request (window close button).

◆ SetMaxFps()

void Urho3D::Engine::SetMaxFps ( int fps )

Set maximum frames per second. The engine will sleep if FPS is higher than this.

◆ SetMaxInactiveFps()

void Urho3D::Engine::SetMaxInactiveFps ( int fps )

Set maximum frames per second when the application does not have input focus.

◆ SetMinFps()

void Urho3D::Engine::SetMinFps ( int fps )

Set minimum frames per second. If FPS goes lower than this, time will appear to slow down.

◆ SetPauseMinimized()

void Urho3D::Engine::SetPauseMinimized ( bool enable )

Set whether to pause update events and audio when minimized.

◆ SetTimeStepSmoothing()

void Urho3D::Engine::SetTimeStepSmoothing ( int frames )

Set how many frames to average for timestep smoothing. Default is 2. 1 disables smoothing.

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

Urho3D/Engine/Engine.h
Urho3D/Engine/Engine.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetAutoExit()

◆ GetMaxFps()

◆ GetMaxInactiveFps()

◆ GetMinFps()

◆ GetPauseMinimized()

◆ GetTimeStepSmoothing()

◆ IsExiting()

◆ IsHeadless()

◆ IsInitialized()

◆ SetAutoExit()

◆ SetMaxFps()

◆ SetMaxInactiveFps()

◆ SetMinFps()

◆ SetPauseMinimized()

◆ SetTimeStepSmoothing()