Inheritance diagram for Urho3D::SystemUI:

Public Member Functions
	SystemUI (Context *context, ImGuiConfigFlags flags=0)
	Construct.

	~SystemUI () override
	Destruct.

void	SetRelativeMouseMove (bool enabled, bool revertMousePositionOnDisable)

const Vector2	GetRelativeMouseMove () const
	Return relative mouse movement value.

ImFont *	AddFont (const ea::string &fontPath, const ImWchar *ranges=nullptr, float size=0, bool merge=false)

ImFont *	AddFont (const void data, unsigned dsize, const char name, const ImWchar *ranges=nullptr, float size=0, bool merge=false)

ImFont *	AddFontCompressed (const void data, unsigned dsize, const char name, const ImWchar *ranges=nullptr, float size=0, bool merge=false)

void	ApplyStyleDefault (bool darkStyle, float alpha)

void	ReferenceTexture (Texture2D *texture)
	Hold a reference to this texture until end of frame.

void	SetPassThroughEvents (bool enabled)
	When set to true, SystemUI will not consume SDL events and they will be passed to to Input and other subsystems.

bool	GetPassThroughEvents () const
	Return true if SystemUI is allowing events through even when SystemUI is handling them.

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.

Protected Member Functions
void	PlatformInitialize ()

void	PlatformShutdown ()

void	ReallocateFontTexture ()

void	ClearPerScreenFonts ()

SharedPtr< Texture2D >	AllocateFontTexture (ImFontAtlas *atlas) const

void	OnRawEvent (VariantMap &args)

void	OnScreenMode (VariantMap &args)

void	OnInputBegin ()

void	OnInputEnd ()

void	OnRenderEnd ()

void	OnMouseVisibilityChanged (StringHash, VariantMap &args)

Protected Attributes
ea::vector< SharedPtr< Texture2D > >	fontTextures_

ea::vector< float >	fontSizes_

ImGuiContext *	imContext_ {}

ea::vector< Diligent::RefCntAutoPtr< Diligent::ITextureView > >	referencedTextures_

bool	passThroughEvents_ = false
	When set to true, SystemUI will not consume SDL events and they will be passed to to Input and other subsystems.

bool	enableRelativeMouseMove_ {}

Vector2	relativeMouseMove_

bool	revertMousePositionOnDisable_ {}

ImVec2	revertMousePosition_

ea::unique_ptr< ImGuiDiligentRendererEx >	impl_

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

Private Member Functions
	URHO3D_OBJECT (SystemUI, Object)

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 {}

Member Function Documentation

◆ AddFont()

ImFont * Urho3D::SystemUI::AddFont	(	const ea::string &	fontPath,
		const ImWchar *	ranges = `nullptr`,
		float	size = `0`,
		bool	merge = `false`
	)

Add font to imgui subsystem.

Parameters

fontPath	a string pointing to TTF font resource.
size	a font size. If 0 then size of last font is used.
name	is any string, stored internally as font name.
ranges	optional ranges of font that should be used. Parameter is ImWchar[] of {start1, stop1, ..., startN, stopN, 0}.
merge	set to true if new font should be merged to last active font.

Returns: ImFont instance that may be used for setting current font when drawing GUI.

◆ ApplyStyleDefault()

void Urho3D::SystemUI::ApplyStyleDefault	(	bool	darkStyle,
		float	alpha
	)

Apply built-in system ui style.

Parameters

darkStyle	enables dark style, otherwise it is a light style.
alpha	value between 0.0f - 1.0f

◆ SetRelativeMouseMove()

void Urho3D::SystemUI::SetRelativeMouseMove	(	bool	enabled,
		bool	revertMousePositionOnDisable
	)

Enable or disable relative mouse movement. Should be called withing ImGUI window. Relative mouse movement is automatically disabled when all mouse buttons are released.

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

Urho3D/SystemUI/SystemUI.h
Urho3D/SystemUI/SystemUI.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Function Documentation

◆ AddFont()

◆ ApplyStyleDefault()

◆ SetRelativeMouseMove()