Detailed Description

Agent that receives events forwarded with the VirtualUIHub.

Inheritance diagram for Doloro.UIEngine2.Modules.VirtualHub.UIHubListener:

[legend]

Collaboration diagram for Doloro.UIEngine2.Modules.VirtualHub.UIHubListener:

Public Member Functions
bool	SetOnHoverBegin (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.HoverStarted events shared with hub. More...

bool	ReleaseOnHoverBegin (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.HoverStarted events shared with hub. More...

bool	SetOnHover (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.Hovered events shared with hub. More...

bool	ReleaseOnHover (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.Hovered events shared with hub. More...

bool	SetOnHoverEnd (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.HoverEnded events shared with hub. More...

bool	ReleaseOnHoverEnd (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.HoverEnded events shared with hub. More...

bool	SetOnPointerUp (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.PointerUp events shared with hub. More...

bool	ReleaseOnPointerUp (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.PointerUp events shared with hub. More...

bool	SetOnPointerDown (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.PointerDown events shared with hub. More...

bool	ReleaseOnPointerDown (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.PointerDown events shared with hub. More...

bool	SetOnContextMenu (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.ContextMenuCalled events shared with hub. More...

bool	ReleaseOnContextMenu (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.ContextMenuCalled events shared with hub. More...

bool	SetOnDragBegin (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.DragStarted events shared with hub. More...

bool	ReleaseOnDragBegin (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.DragStarted events shared with hub. More...

bool	SetOnDrag (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.Draged events shared with hub. More...

bool	ReleaseOnDrag (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.Draged events shared with hub. More...

bool	SetOnDragEnd (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.DragEnded events shared with hub. More...

bool	ReleaseOnDragEnd (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.DragEnded events shared with hub. More...

bool	SetOnSizeChanged (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.SizeChanged events shared with hub. More...

bool	ReleaseOnSizeChanged (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.SizeChanged events shared with hub. More...

bool	SetOnMoved (VirtualUIHub.SharedEvent handler)
	Subscribes handler on AGUIElement.Moved events shared with hub. More...

bool	ReleaseOnMoved (VirtualUIHub.SharedEvent handler)
	Releases handler from AGUIElement.Moved events shared with hub. More...

bool	SetEventHandler (string eventCode, VirtualUIHub.SharedEvent handler)
	Setts a handler to hub's sharing event. More...

bool	ReleaseEventHanler (string eventCode, VirtualUIHub.SharedEvent handler)
	Releases a handler from hub's sharing event. More...

void	ReleaseAllEventHandlers ()
	Releasing all subscribed handlers from current hub.

Protected Member Functions
override void	OnHubPreChange ()
	Drops event handlers related to changed AHubAgent.hub with the ReleaseAllEventHandlers in case if requested by settings. More...

virtual void	OnDestroy ()
	Drops event handlers related to changed AHubAgent.hub with the ReleaseAllEventHandlers in case if requested by settings.

virtual void	Awake ()

virtual void	OnHubPostChange ()
	Occurs after hub property had been changed. More...

Properties
bool	DropHandlerWithHub = true `[get, set]`
	If `true` then will drops all subscriptions on events related to the AHubAgent.hub as soon as its value changed. More...

bool	ReleaseIfDestroyed = true `[get, set]`
	If `true` then will drops all subscriptions on events related to the AHubAgent.hub as soon as component has been destroyed. More...

AGUIElement	element `[get]`
	Element connected to the agent.

virtual VirtualUIHub	hub `[get, set]`
	Reference to parental hub.

Member Function Documentation

◆ OnHubPostChange()

virtual void Doloro.UIEngine2.Modules.VirtualHub.AHubAgent.OnHubPostChange ( )

protectedvirtualinherited

Occurs after hub property had been changed.

hub value could be null.

◆ OnHubPreChange()

override void Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.OnHubPreChange ( )

protectedvirtual

Drops event handlers related to changed AHubAgent.hub with the ReleaseAllEventHandlers in case if requested by settings.

Reimplemented from Doloro.UIEngine2.Modules.VirtualHub.AHubAgent.

◆ ReleaseEventHanler()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseEventHanler	(	string	eventCode,
		VirtualUIHub.SharedEvent	handler
	)

Releases a handler from hub's sharing event.

Parameters

eventCode	Code of event sharing by hub to handle. Case insensitive.
handler	Event handler that should be released from pool.

Returns: Is the handler found among registered.

◆ ReleaseOnContextMenu()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnContextMenu ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.ContextMenuCalled events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnDrag()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnDrag ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.Draged events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnDragBegin()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnDragBegin ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.DragStarted events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnDragEnd()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnDragEnd ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.DragEnded events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnHover()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnHover ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.Hovered events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnHoverBegin()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnHoverBegin ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.HoverStarted events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnHoverEnd()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnHoverEnd ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.HoverEnded events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnMoved()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnMoved ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.Moved events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnPointerDown()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnPointerDown ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.PointerDown events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnPointerUp()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnPointerUp ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.PointerUp events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ ReleaseOnSizeChanged()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseOnSizeChanged ( VirtualUIHub.SharedEvent handler )

Releases handler from AGUIElement.SizeChanged events shared with hub.

Parameters

handler Handler to release.

Returns: Is the handler found among registered.

◆ SetEventHandler()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetEventHandler	(	string	eventCode,
		VirtualUIHub.SharedEvent	handler
	)

Setts a handler to hub's sharing event.

Parameters

eventCode	Code of event sharing by hub to handle. Case insensitive.
handler	Event handler that will be called by hub.

Returns: Is the handler has been registered.

◆ SetOnContextMenu()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnContextMenu ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.ContextMenuCalled events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnDrag()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnDrag ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.Draged events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnDragBegin()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnDragBegin ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.DragStarted events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnDragEnd()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnDragEnd ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.DragEnded events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnHover()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnHover ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.Hovered events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnHoverBegin()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnHoverBegin ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.HoverStarted events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnHoverEnd()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnHoverEnd ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.HoverEnded events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnMoved()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnMoved ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.Moved events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnPointerDown()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnPointerDown ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.PointerDown events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnPointerUp()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnPointerUp ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.PointerUp events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

◆ SetOnSizeChanged()

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.SetOnSizeChanged ( VirtualUIHub.SharedEvent handler )

Subscribes handler on AGUIElement.SizeChanged events shared with hub.

Parameters

handler Handler to call.

Returns: Is the handler has been registered.

Property Documentation

◆ DropHandlerWithHub

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.DropHandlerWithHub = true

getset

If true then will drops all subscriptions on events related to the AHubAgent.hub as soon as its value changed.

true by default.

◆ ReleaseIfDestroyed

bool Doloro.UIEngine2.Modules.VirtualHub.UIHubListener.ReleaseIfDestroyed = true

getset

If true then will drops all subscriptions on events related to the AHubAgent.hub as soon as component has been destroyed.

true by default.

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

D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-UI-2/Runtime/Modules/Virtual Hub/Components/UIHubListener.cs

Detailed Description

Public Member Functions

Protected Member Functions

Properties

Member Function Documentation

◆ OnHubPostChange()

◆ OnHubPreChange()

◆ ReleaseEventHanler()

◆ ReleaseOnContextMenu()

◆ ReleaseOnDrag()

◆ ReleaseOnDragBegin()

◆ ReleaseOnDragEnd()

◆ ReleaseOnHover()

◆ ReleaseOnHoverBegin()

◆ ReleaseOnHoverEnd()

◆ ReleaseOnMoved()

◆ ReleaseOnPointerDown()

◆ ReleaseOnPointerUp()

◆ ReleaseOnSizeChanged()

◆ SetEventHandler()

◆ SetOnContextMenu()

◆ SetOnDrag()

◆ SetOnDragBegin()

◆ SetOnDragEnd()

◆ SetOnHover()

◆ SetOnHoverBegin()

◆ SetOnHoverEnd()

◆ SetOnMoved()

◆ SetOnPointerDown()

◆ SetOnPointerUp()

◆ SetOnSizeChanged()

Property Documentation

◆ DropHandlerWithHub

◆ ReleaseIfDestroyed