Navigation manager that tracks all RmlNavigable in the RmlUIComponent. More...

#include <Urho3D/RmlUI/RmlNavigationManager.h>

Inheritance diagram for Urho3D::RmlNavigationManager:

Classes
struct	NavigationStackFrame

Public Member Functions
	RmlNavigationManager (RmlUIComponent *owner)

void	Reset (Rml::ElementDocument *document)
	Reset current navigation state to default.

void	Update ()
	Periodical update of navigation state.


const ea::string &	GetTopCursorGroup () const

RmlNavigable *	GetTopCursorNavigable () const

bool	IsGroupInStack (const ea::string &group) const

void	MoveCursor (const Vector2 &direction)

void	PushCursorGroup (const ea::string &group)

void	PopCursorGroup ()


void	SetInputEnabled (bool enabled)

bool	GetInputEnabled () const


void	AddNavigable (RmlNavigable *navigable)

void	RemoveNavigable (RmlNavigable *navigable)

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 void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

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

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.

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()>	OnGroupChanged

Private Member Functions
	URHO3D_OBJECT (RmlNavigationManager, Object)

void	RepairNavigation ()

void	UpdateMouseMove ()

bool	IsPressButton (Scancode scancode) const

bool	IsBackButton (Scancode scancode) const

bool	IsPressButton (ControllerButton button) const

bool	IsBackButton (ControllerButton button) const

void	HandleDirectionKeyEvent (StringHash eventType, VariantMap &eventData)

void	HandleKeyboardButtonEvent (StringHash eventType, VariantMap &eventData)

void	HandleJoystickButtonEvent (StringHash eventType, VariantMap &eventData)

void	HandleMouseButtonEvent (StringHash eventType, VariantMap &eventData)

void	SetCursorNavigable (RmlNavigable *navigable, NavigableEventMode eventMode)

void	ResetPressedNavigable ()

void	SetPressedNavigable (RmlNavigable *navigable, NavigableInputSource eventSource)

void	ScrollNavigableIntoView (RmlNavigable *navigable)

template<class T >
RmlNavigable *	FindBestNavigable (const T &penaltyFunction) const

Private Attributes
const WeakPtr< RmlUIComponent >	owner_

SharedPtr< DirectionalPadAdapter >	directionInput_

ea::unordered_map< Rml::Element *, Rml::ObserverPtr< RmlNavigable > >	navigables_

ea::vector< NavigationStackFrame >	navigationStack_

unsigned	numBadFrames_ {}

NavigableInputSource	pressEventSource_ {}

Rml::ObserverPtr< RmlNavigable >	pressedNavigable_


const unsigned	maxBadFrames_ {1}

bool	inputEnabled_ {}

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

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

Detailed Description

Navigation manager that tracks all RmlNavigable in the RmlUIComponent.

Member Function Documentation

◆ AddNavigable()

void Urho3D::RmlNavigationManager::AddNavigable ( RmlNavigable * navigable )

Internal API.

◆ GetTopCursorGroup()

const ea::string & Urho3D::RmlNavigationManager::GetTopCursorGroup ( ) const

Cursor operations.

◆ SetInputEnabled()

void Urho3D::RmlNavigationManager::SetInputEnabled ( bool enabled )

Properties.

Member Data Documentation

◆ maxBadFrames_

const unsigned Urho3D::RmlNavigationManager::maxBadFrames_ {1}

private

Properties

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

Urho3D/RmlUI/RmlNavigationManager.h
Urho3D/RmlUI/RmlNavigationManager.cpp

Classes

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes