Urho3D::RmlUI Class Reference

UI subsystem. Manages the graphical user interface. More...

#include <Urho3D/RmlUI/RmlUI.h>

Inheritance diagram for Urho3D::RmlUI:

Public Member Functions
	RmlUI (Context *context, const char *name="master")
	Construct.
	~RmlUI () override
	Destruct.
Rml::ElementDocument *	LoadDocument (const ea::string &path)
void	SetDebuggerVisible (bool visible)
	Show or hide RmlUi debugger.
bool	LoadFont (const ea::string &resourceName, bool fallback=false)
void	ReloadFonts ()
	Reload fonts from resource cache.
Rml::Context *	GetRmlContext () const
	Returns RmlUi context object.
void	SetScale (float scale)
	Set UI scale aka dp to px ratio. 1.0 is default (pixel perfect).
float	GetScale () const
	Return UI scale.
void	SetRenderTarget (RenderSurface *target, const Color &clearColor=Color::TRANSPARENT_BLACK)
	Set render target where this instance will render into.
void	SetRenderTarget (Texture2D *target, const Color &clearColor=Color::TRANSPARENT_BLACK)
	Set render target where this instance will render into.
void	SetRenderTarget (std::nullptr_t target, const Color &clearColor=Color::TRANSPARENT_BLACK)
	Set render target where this instance will render into. A convenience overload to resolve ambiguity when clearing rendertarget.
void	SetRendering (bool enable)
	Enable or disable this UI subsystem. When disabled, no inputs will be processed and nothing will be rendered.
bool	IsRendering () const
	Return true if this subsystem is rendering. When disabled, it is still possible to manually render by calling Render() method.
bool	IsInputCaptured () const
	Return true if input is captured by UI.
bool	IsHovered () const
	Returns true if any window of this UI context is hovered by mouse.
void	Update (float timeStep)
	Update the UI logic. Called by HandlePostUpdate().
void	Render ()
	Render UI.
Rml::ElementDocument *	ReloadDocument (Rml::ElementDocument *document)
	Unload passed document and load it's rml again, return newly loaded document. This operation preserves document position and size.
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.

Public Attributes
Signal< void(IntVector2 &)>	mouseMoveEvent_
	Emitted when mouse input is detected. Should be used for translating mouse coordinates when UI is rendered on 3D objects. Takes 2D screen coordinates as input, they may be modified by subscribers.
Signal< void(Rml::ElementDocument *)>	documentClosedEvent_
	Emitted when a window document owned by this subsystem is closed.
Signal< void(const RmlCanvasResizedArgs &)>	canvasResizedEvent_
	Emitted when underlying UI canvas is resized.
Signal< void(const RmlDocumentReloadedArgs &)>	documentReloaded_
	Emitted when automatic resource reloading triggers reload of a document.

Private Member Functions
	URHO3D_OBJECT (RmlUI, Object)
IntVector2	GetDesiredCanvasSize () const
	Returns a size that this UI screen will cover.
bool	IsInputCapturedInternal () const
	Return true if input is captured by this instance of RmlUI.
void	OnDocumentUnload (Rml::ElementDocument *document)
	Signal that document belonging to this subsystem was closed.
void	HandleScreenMode (StringHash eventType, VariantMap &eventData)
	Handle screen mode event.
void	HandleMouseButtonDown (StringHash eventType, VariantMap &eventData)
	Handle mouse button down event.
void	HandleMouseButtonUp (StringHash eventType, VariantMap &eventData)
	Handle mouse button up event.
void	HandleMouseMove (StringHash eventType, VariantMap &eventData)
	Handle mouse move event.
void	HandleMouseWheel (StringHash eventType, VariantMap &eventData)
	Handle mouse wheel event.
void	HandleTouchBegin (StringHash eventType, VariantMap &eventData)
	Handle touch begin event.
void	HandleTouchEnd (StringHash eventType, VariantMap &eventData)
	Handle touch end event.
void	HandleTouchMove (StringHash eventType, VariantMap &eventData)
	Handle touch move event.
void	HandleKeyDown (StringHash eventType, VariantMap &eventData)
	Handle press event.
void	HandleKeyUp (StringHash eventType, VariantMap &eventData)
	Handle release event.
void	HandleTextInput (StringHash eventType, VariantMap &eventData)
	Handle text input event.
void	HandlePostUpdate (StringHash eventType, VariantMap &eventData)
	Handle logic post-update event.
void	HandleDropFile (StringHash eventType, VariantMap &eventData)
	Handle a file being drag-dropped into the application window.
void	HandleEndAllViewsRender (StringHash eventType, VariantMap &eventData)
	Handle rendering to a texture.
void	HandleResourceReloaded (StringHash eventType, VariantMap &eventData)
	Handle resource reloading.

Private Attributes
ea::string	name_
	UI context name.
Detail::RmlContext *	rmlContext_ = nullptr
	RmlUi context.
WeakPtr< RenderSurface >	renderSurface_
	Surface where UI will be rendered into.
Color	clearColor_ = Color::TRANSPARENT_BLACK
	Color used to clear render surface if not rendering into backbuffer.
bool	debuggerInitialized_ = false
	Flag indicating RmlUi debugger is already initialized.
bool	isRendering_ = true
	Whether current subsystem is rendering or not.
ea::vector< WeakPtr< RmlUI > >	siblingSubsystems_
	Other instances of RmlUI.

Friends
class	Detail::RmlPlugin

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

UI subsystem. Manages the graphical user interface.

Member Function Documentation

LoadDocument()

Rml::ElementDocument * Urho3D::RmlUI::LoadDocument

(

const ea::string &

path

)

Load a specified rml document. When resource reloader is active, returned pointer will be invalidated when associated resource change triggers reloading a document. In such cases it is important to subscribe to documentReloaded_ signal and update handle change of document pointer.

LoadFont()

bool Urho3D::RmlUI::LoadFont	(	const ea::string &	resourceName,
		bool	fallback = false
	)

Load a font resource for RmlUi to use. Set fallback parameter to true if font should be used as a fallback font for unsupported characters.

---

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

• Urho3D/RmlUI/RmlUI.h
• Urho3D/RmlUI/RmlUI.cpp