Engine²
Open-source game engine written in C++.
Loading...
Searching...
No Matches
Rmlui::Resource::UIContext Class Reference

#include <UIContext.hpp>

Inheritance diagram for Rmlui::Resource::UIContext:
Rmlui::Resource::AUIContext

Classes

struct  InputCallbackIds
struct  EventListenerEntry

Public Member Functions

 UIContext ()=default
 ~UIContext () override=default
 UIContext (const UIContext &)=delete
UIContext & operator= (const UIContext &)=delete
 UIContext (UIContext &&) noexcept=default
UIContext & operator= (UIContext &&) noexcept=default
void Update (Engine::Core &core) override
void Render (Engine::Core &core) override
void Destroy (Engine::Core &core) override
void UpdateMouseMoveEvent (Engine::Core &core) override
void SetFont (const std::string &fontPath) override
void LoadDocument (const std::string &docPath) override
bool LoadOverlayDocument (const std::string &docPath)
bool UnloadOverlayDocument (const std::string &docPath)
const std::string & GetTitle () const override
Rml::ElementDocument * GetDocument ()
Rml::ElementDocument * GetOverlayDocument (const std::string &docPath)
const Rml::ElementDocument * GetDocument () const
const Rml::ElementDocument * GetOverlayDocument (const std::string &docPath) const
void EnableDebugger (bool enable)
Rml::Element * GetElementById (const std::string &elementId)
bool RegisterEventListener (Rml::Element &element, const Rml::String &eventType, std::function< void(Rml::Event &)> callback, bool useCapture=false)
bool UnregisterEventListener (Rml::Element &element, const Rml::String &eventType)
void RequestLateUpdate ()
void SetInputCallbackIds (const InputCallbackIds &ids)
bool AreInputCallbacksRegistered () const
void SetInputCallbacksRegistered (bool registered)
bool ProcessKey (int key, int action, int mods) override
bool ProcessText (unsigned int codepoint) override
bool ProcessMouseMove (double x, double y, int mods) override
bool ProcessMouseButton (int button, int action, int mods) override
bool ProcessMouseWheel (double xoffset, double yoffset, int mods) override
Public Member Functions inherited from Rmlui::Resource::AUIContext
template<CSystemInterface TSystemInterface, CRenderInterface TRenderInterface>
void Init (Engine::Core &core)
virtual ~AUIContext ()=default
 AUIContext ()=default
 AUIContext (const AUIContext &)=delete
AUIContext & operator= (const AUIContext &)=delete
 AUIContext (AUIContext &&) noexcept=default
AUIContext & operator= (AUIContext &&) noexcept=default

Protected Member Functions

void _setup (Engine::Core &core) override
Protected Member Functions inherited from Rmlui::Resource::AUIContext
Rml::SystemInterface * GetSystemInterface ()
const Rml::SystemInterface * GetSystemInterface () const
Rmlui::Utils::IRenderer * GetRenderInterface ()
const Rmlui::Utils::IRenderer * GetRenderInterface () const

Private Member Functions

bool _isReady () const

Private Attributes

Rml::Context * _context = nullptr
Rml::ElementDocument * _document = nullptr
std::unordered_map< std::string, Rml::ElementDocument * > _overlayDocuments
std::string _titleCache
bool _debuggerInitialized = false
std::vector< EventListenerEntry > _eventListeners
InputCallbackIds _inputCallbackIds
bool _inputCallbacksRegistered = false
bool _lateUpdateRequested = false

Constructor & Destructor Documentation

◆ UIContext() [1/3]

Rmlui::Resource::UIContext::UIContext ( )
default

◆ ~UIContext()

Rmlui::Resource::UIContext::~UIContext ( )
overridedefault

◆ UIContext() [2/3]

Rmlui::Resource::UIContext::UIContext ( const UIContext & )
delete

◆ UIContext() [3/3]

Rmlui::Resource::UIContext::UIContext ( UIContext && )
defaultnoexcept

Member Function Documentation

◆ _isReady()

bool Rmlui::Resource::UIContext::_isReady ( ) const
private

◆ _setup()

void Rmlui::Resource::UIContext::_setup ( Engine::Core & core)
overrideprotectedvirtual

Implements Rmlui::Resource::AUIContext.

◆ AreInputCallbacksRegistered()

bool Rmlui::Resource::UIContext::AreInputCallbacksRegistered ( ) const

◆ Destroy()

void Rmlui::Resource::UIContext::Destroy ( Engine::Core & core)
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ EnableDebugger()

void Rmlui::Resource::UIContext::EnableDebugger ( bool enable)

◆ GetDocument() [1/2]

Rml::ElementDocument * Rmlui::Resource::UIContext::GetDocument ( )

◆ GetDocument() [2/2]

const Rml::ElementDocument * Rmlui::Resource::UIContext::GetDocument ( ) const

◆ GetElementById()

Rml::Element * Rmlui::Resource::UIContext::GetElementById ( const std::string & elementId)

◆ GetOverlayDocument() [1/2]

Rml::ElementDocument * Rmlui::Resource::UIContext::GetOverlayDocument ( const std::string & docPath)

◆ GetOverlayDocument() [2/2]

const Rml::ElementDocument * Rmlui::Resource::UIContext::GetOverlayDocument ( const std::string & docPath) const

◆ GetTitle()

const std::string & Rmlui::Resource::UIContext::GetTitle ( ) const
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ LoadDocument()

void Rmlui::Resource::UIContext::LoadDocument ( const std::string & docPath)
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ LoadOverlayDocument()

bool Rmlui::Resource::UIContext::LoadOverlayDocument ( const std::string & docPath)

◆ operator=() [1/2]

UIContext & Rmlui::Resource::UIContext::operator= ( const UIContext & )
delete

◆ operator=() [2/2]

UIContext & Rmlui::Resource::UIContext::operator= ( UIContext && )
defaultnoexcept

◆ ProcessKey()

bool Rmlui::Resource::UIContext::ProcessKey ( int key,
int action,
int mods )
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ ProcessMouseButton()

bool Rmlui::Resource::UIContext::ProcessMouseButton ( int button,
int action,
int mods )
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ ProcessMouseMove()

bool Rmlui::Resource::UIContext::ProcessMouseMove ( double x,
double y,
int mods )
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ ProcessMouseWheel()

bool Rmlui::Resource::UIContext::ProcessMouseWheel ( double xoffset,
double yoffset,
int mods )
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ ProcessText()

bool Rmlui::Resource::UIContext::ProcessText ( unsigned int codepoint)
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ RegisterEventListener()

bool Rmlui::Resource::UIContext::RegisterEventListener ( Rml::Element & element,
const Rml::String & eventType,
std::function< void(Rml::Event &)> callback,
bool useCapture = false )

◆ Render()

void Rmlui::Resource::UIContext::Render ( Engine::Core & core)
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ RequestLateUpdate()

void Rmlui::Resource::UIContext::RequestLateUpdate ( )

◆ SetFont()

void Rmlui::Resource::UIContext::SetFont ( const std::string & fontPath)
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ SetInputCallbackIds()

void Rmlui::Resource::UIContext::SetInputCallbackIds ( const InputCallbackIds & ids)

◆ SetInputCallbacksRegistered()

void Rmlui::Resource::UIContext::SetInputCallbacksRegistered ( bool registered)

◆ UnloadOverlayDocument()

bool Rmlui::Resource::UIContext::UnloadOverlayDocument ( const std::string & docPath)

◆ UnregisterEventListener()

bool Rmlui::Resource::UIContext::UnregisterEventListener ( Rml::Element & element,
const Rml::String & eventType )

◆ Update()

void Rmlui::Resource::UIContext::Update ( Engine::Core & core)
overridevirtual

Implements Rmlui::Resource::AUIContext.

◆ UpdateMouseMoveEvent()

void Rmlui::Resource::UIContext::UpdateMouseMoveEvent ( Engine::Core & core)
overridevirtual

Implements Rmlui::Resource::AUIContext.

Member Data Documentation

◆ _context

Rml::Context* Rmlui::Resource::UIContext::_context = nullptr
private

◆ _debuggerInitialized

bool Rmlui::Resource::UIContext::_debuggerInitialized = false
private

◆ _document

Rml::ElementDocument* Rmlui::Resource::UIContext::_document = nullptr
private

◆ _eventListeners

std::vector<EventListenerEntry> Rmlui::Resource::UIContext::_eventListeners
private

◆ _inputCallbackIds

InputCallbackIds Rmlui::Resource::UIContext::_inputCallbackIds
private

◆ _inputCallbacksRegistered

bool Rmlui::Resource::UIContext::_inputCallbacksRegistered = false
private

◆ _lateUpdateRequested

bool Rmlui::Resource::UIContext::_lateUpdateRequested = false
private

◆ _overlayDocuments

std::unordered_map<std::string, Rml::ElementDocument *> Rmlui::Resource::UIContext::_overlayDocuments
private

◆ _titleCache

std::string Rmlui::Resource::UIContext::_titleCache
private
The documentation for this class was generated from the following files: