Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Doloro.UIEngine2.Modules.Context.ContextMenu Class Reference

Detailed Description

Controller that implements context menu related features.

Inheritance diagram for Doloro.UIEngine2.Modules.Context.ContextMenu:
Collaboration diagram for Doloro.UIEngine2.Modules.Context.ContextMenu:

Public Types

enum  LayoutModeOptions { Rect , FullWorkspace , FullScreen }
 Defines window rect selection behavior. More...
 

Public Member Functions

void Add (ContextMenuItemInfo descriptor)
 Adding item GUI to the context menu. More...
 
override void OnElementGUI ()
 Calling each draw frame. Use to update showing data. More...
 
override void OnInput ()
 Handles shortcuts. More...
 
override void UpdateLayout ()
 Sends GUI Element parameters to Unity. Repaints window. More...
 
void Open (Window parent)
 Opening the window with the bond to another window. More...
 
void Open (WindowsLayer parent)
 Opening the window with the bond to multi window layout. More...
 
void Open ()
 Registering the window into the system. More...
 
void Hide ()
 Hiding the window. The window continue to operate background tasks and can be restored by Open or AGUIElement.Focus call. More...
 
void Close ()
 Removing window related entries from backstage register. More...
 
void Repaint ()
 Repaints element along with its children.
 
void RescanForParent ()
 Looking for parent element.
 
void Focus ()
 Focusing element.
 
void Unfocus ()
 Turning off focus from element and all the elements above in the stack.
 
void CallClick ()
 Simulates click above the element.
 
void CallContextMenu ()
 Simulates calling context menu over the element.
 
virtual bool IsChildOf (AGUIElement element)
 Checks is the element is a child of another element. More...
 

Static Public Member Functions

static void Open (Rect rect, params ContextMenuItemInfo[] items)
 Opens ContextMenu window instantiated from the resource. More...
 
static Window GetParentWindow (AGUIElement element)
 Looking for parent Window for element. More...
 
static AGUIElement FindParentGUIElement (Transform element)
 Looking for parent GUI element. More...
 
static AGUIElement FindRoot (AGUIElement hierarchyElement)
 Looking for root element at the hierarchy branch. More...
 

Protected Member Functions

override void Start ()
 Occurs before object finishes initialization. More...
 
override void OnWindowFocusLost ()
 Occurs when window lost focus. More...
 
override void OnDestroy ()
 Calls base OnDestroy handler. Forces the window to close in case if has no been closed yet. More...
 
override void OnOpening ()
 Handle all the data that should be loaded once during window start. More...
 
override void Awake ()
 Occurs during object instantiation. More...
 
override void OnMoved ()
 Should be called when element position is modified. More...
 
override void OnClose ()
 Calling system handlers and self destroying game object. More...
 
override void OnHide ()
 Occurs when window hidden. More...
 
override void OnFocus ()
 Occurs when window focused. More...
 
override void OnWindowMovedOnTop ()
 Occurs when the window has been moved to top of the windows stack. More...
 
override void OnHoverBegin ()
 Occurs when pointer starts hovering above the window. More...
 
override void OnHoverEnd ()
 Occurs when pointer leaves window's rect. More...
 
override void OnPointerDown ()
 Occurs when LBM pressed above hovering element. More...
 
virtual void OnApplicationQuitting ()
 Occurs when application is finished and closes the window.
 
virtual void OnRootFocus ()
 Occurs each time when child GUI element is called. More...
 
virtual bool OnPreCloseCheck ()
 Occurs before window closed. More...
 
virtual void OnBackground ()
 Handler using to performing of window's behavior not related to GUI. Occurs along with the BackgroundTaskCallMode policy. Class each frame in case if allowed.
 
virtual void OnClampedSizeChanged ()
 Should be called in case if MinSize or MaxSize is modified.
 
delegate float ClampDelegate (int mode, float coordinates, float elementSide, float wsCoord, float wsSize)
 Handler that should clamp left top corner of elements inside certain bounds. More...
 
virtual void OnEnable ()
 Occurs when component enabled.
 
virtual void OnDisable ()
 Occurs when component disabled.
 
virtual void OnTransformChildrenChanged ()
 Occurs when children list has been changed.
 
virtual void OnTransformParentChanged ()
 Occurs when parent object has been changed.
 
virtual void OnSizeChanged ()
 Should be called when element size is modified. More...
 
virtual void OnLostFocus ()
 Occurs when UI loosing focus. More...
 
virtual void OnHover ()
 Occurs when the pointer is over the element.
 
virtual void OnDragBegin ()
 Occurs when pointer is start drag process.
 
virtual void OnDrag ()
 Occurs each frame when you drags the element. More...
 
virtual void OnDragEnd ()
 Occurs when dragging element from ElementOnAction is released. More...
 
virtual void OnPointerUp ()
 Occurs when LBM released above hovering element. More...
 
virtual void OnContextMenu ()
 Occurs when you calling context menu with focused element. More...
 

Package Functions

void OnRootFocusInternal ()
 Occurs each time when child GUI element is called. More...
 
void PointerLogicConveyor (Vector2 pointerPosition, Rect[] masks)
 Conveyor that handles pointer related events. More...
 
bool IsLocalHierarchyChildOf (AGUIElement element)
 Checks is the element is child of another element in local hierarchy. More...
 

Static Package Functions

static void OnNewEventBegin ()
 Occurs when new UI event started.
 

Properties

static ContextMenu Active [get]
 
static ContextMenu resource [get, set]
 Resource that using to instantiate context menu window in uniform way.
 
AGUIElementsCollection collection [get]
 Collection that handles items.
 
RectTransform WindowLayout [get]
 Object that contains all drawing UI including window itself. More...
 
RectTransform ContentHolder [get]
 Layout element where finishes system controls implementing window layout and starts user controls specific for certain GUI. More...
 
static Vector2 MinSafetySize [get]
 The minimal size allowed to be used as value of MinSize.
 
static Window FocusedWindow [get, set]
 Current focused window. Null if has no focused. More...
 
override LayoutModeOptions LayoutMode [get, set]
 Defines current window draw mode. More...
 
WindowStateOptions WindowState [get]
 The state of the window. More...
 
BackgroundTaskCallModeOptions BackgroundTaskCallMode = BackgroundTaskCallModeOptions.Always [get, set]
 Defines background tasks call mode.
 
bool IsWindowFocused [get]
 Is the window in focus.
 
bool IsCoveredByAnotherWindow [get]
 Checking is the window covered by any other window. More...
 
bool DynamicSizeIfClamped = false [get, set]
 If true then the window would be resized in case if hit the screen bound. More...
 
override ClampDelegate ClampHandler [get]
 
override Vector2 Position [get, set]
 Position of the windows in world coordinates. More...
 
override Vector2 Size [get, set]
 Current size of the window. More...
 
Vector2 RawSize [get]
 Raw size of the window without considering dynamic rescaling features.
 
Vector2 MinSize [get, set]
 Minimum size that allowed to window. More...
 
Vector2 MaxSize [get, set]
 Maximum size of the window. More...
 
override bool IsVisibleForEngine [get]
 True in case if Component is enabled, GameObject is active and window has WindowState == WindowStateOptions.Active.
 
override bool OnStackTopWhenFocused [get]
 Always move focused window at the stack top.
 
float SafeBorder = 10f [get, set]
 At least one of window corners must has the value offset against screen bounds to prevent placing the window out of borders. More...
 
bool ClampToScreenBorder [get, set]
 If true that checks that window can't move out of screen bounds.
 
virtual Rect Workspace [get, set]
 Workspace of the window. Defines the bounds determining as screen for window. More...
 
Vector2 RawPosition [get, protected set]
 Not clamped position of the element at the screen space. Not represents real position at the renderer.
 
bool IsMask [get, set]
 If true then will crop the pointer events out of bounds for children.
 
bool IsRaycastTarget [get, set]
 Defines is the element will handle mouse click events. More...
 
bool IsActive [get]
 
bool IsFocused [get]
 Checks is the element registered at the FocusStack
 
bool IsHovered [get]
 Is the element hovered at the moment.
 
bool IsRoot [get, set]
 Is the element is at the bottom of engine hierarchy.
 
AGUIElement FocusedChild [get]
 Returns focused child. Null if not exist.
 
ReadOnlyCollection< AGUIElementChildren = new ReadOnlyCollection<AGUIElement>(new AGUIElement[0]) [get]
 Collection of element children. More...
 
Rect LocalRect [get]
 Returns rect of the bond RectTransform component.
 
Rect ScreenSpaceRect [get, set]
 Returns elements's rect at screen space. More...
 
Rect ScreenSpaceRect [get, set]
 Entry in screen space coordinates. More...
 
Vector2 ScreenSpacePostion [get, set]
 Returns elements's position at screen space. More...
 
Rect RaycastRect [get]
 Screen space rect with applied RaycastPadding parameters.
 
Vector4 RaycastPadding [get, set]
 Defines offset of the ray casting box along with the physical size.
 
Window ParentWindow [get]
 Reference to the parent window. Null if element is free.
 
AGUIElement ParentGUIElement [get, protected set]
 Parent GUI element. Drops ParentWindow stored reference to null.
 
RectTransform BondRectTransform [get]
 Buffer that contains bond rect transform.
 
static AGUIElement ElementOnAction [get]
 Reference to last dragged element. More...
 
static bool IsMouseDragOn [get]
 True when some elements is now at the drag state.
 
virtual Vector2 LocalPosition [get, set]
 Position relative to the parent element.
 

Events

Action Opened
 Occurs when new window is opened.
 
Action Hidden
 Occurs when window hiding.
 
Action Closed
 Occurs when window closing.
 
Action ClampedSizeChanged
 Occurs when MinSize or MaxSize is modified.
 
Action LayoutModeChanged
 Occurs when LayoutMode changes the value.
 
Action< AGUIElementFocused
 Occurs when element is focused.
 
Action< AGUIElementFocusLost
 Occurs when element loosing focus.
 
Action< AGUIElementHoverStarted
 Occurs when pointer crossing element's rect bounds.
 
Action< AGUIElementHovered
 Occurs each time when GUI is changed and pointer is over the element.
 
Action< AGUIElementHoverEnded
 Occurs when pointer leaving the element's rect.
 
Action< AGUIElementDragStarted
 Occurs when drag process is starting.
 
Action< AGUIElementDraged
 Occurs during element drag process.
 
Action< AGUIElementDragEnded
 Occurs when element drag is ended.
 
Action< AGUIElementPointerDown
 Occurs when element pressed with LMB.
 
Action< AGUIElementPointerUp
 Occurs when element LB has been released with the pointer above element.
 
Action< AGUIElementContextMenuCalled
 Occurs when user calling context menu for element.
 
Action< AGUIElementMoved
 Occurs when element is moved.
 
Action< AGUIElementSizeChanged
 Occurs when element Size changed.
 

Member Enumeration Documentation

◆ LayoutModeOptions

Defines window rect selection behavior.

Enumerator
Rect 

The screen drawn in a bounds of some rect.

FullWorkspace 

Drawing the window in scale of entire workspace rect.

FullScreen 

Overlaying all the screen with UI.

Member Function Documentation

◆ Add()

void Doloro.UIEngine2.Modules.Context.ContextMenu.Add ( ContextMenuItemInfo  descriptor)

Adding item GUI to the context menu.

Parameters
descriptorItem descriptor to menu add.

◆ Awake()

override void Doloro.UIEngine2.WindowUIController.Awake ( )
protectedvirtualinherited

Occurs during object instantiation.

Reimplemented from Doloro.UIEngine2.Window.

◆ ClampDelegate()

delegate float Doloro.UIEngine2.AWorkspaceGUIElement.ClampDelegate ( int  mode,
float  coordinates,
float  elementSide,
float  wsCoord,
float  wsSize 
)
protectedinherited

Handler that should clamp left top corner of elements inside certain bounds.

Parameters
modeAxis: 0 - horizontal, 1 - vertical.
coordinatesRaw position by axis.
elementSideElement side size related to axis.
wsCoordStart point of workspace.
wsSizeSize of the workspace side along with axis.
Returns
Clamped coordinate of the top left corner.

◆ Close()

void Doloro.UIEngine2.Window.Close ( )
inherited

Removing window related entries from backstage register.

In default implementation the instance still remains but window features will no longer available.

Custom less-uniform implementations focused on certain ecosystem may destroy the object representation via OnClose callback.

Implements Doloro.UIEngine2.IWindowRuntimeRegisterEntry.

◆ FindParentGUIElement()

static AGUIElement Doloro.UIEngine2.AGUIElement.FindParentGUIElement ( Transform  element)
staticinherited

Looking for parent GUI element.

Parameters
elementSource element transform.
Returns
Parent AGUIElement is exist. Null if root.

◆ FindRoot()

static AGUIElement Doloro.UIEngine2.AGUIElement.FindRoot ( AGUIElement  hierarchyElement)
staticinherited

Looking for root element at the hierarchy branch.

Parameters
hierarchyElementElement of hierarchy.
Returns
Root element at the branch.

◆ GetParentWindow()

static Window Doloro.UIEngine2.Window.GetParentWindow ( AGUIElement  element)
staticinherited

Looking for parent Window for element.

Parameters
elementSource element.
Returns
Reference to the parent window. Null if has no.

◆ Hide()

void Doloro.UIEngine2.Window.Hide ( )
inherited

Hiding the window. The window continue to operate background tasks and can be restored by Open or AGUIElement.Focus call.

Exceptions
WindowClosedExceptionTrying to focus window that has been closed.

The window continue to operate background tasks and can be restored by Open or Focus call.

Implements Doloro.UIEngine2.IWindowRuntimeRegisterEntry.

◆ IsChildOf()

virtual bool Doloro.UIEngine2.AGUIElement.IsChildOf ( AGUIElement  element)
virtualinherited

Checks is the element is a child of another element.

Parameters
elementTarget element.
Returns

Virtual logic that can be re-implemented to allow creation of virtual hierarchy.

◆ IsLocalHierarchyChildOf()

bool Doloro.UIEngine2.AGUIElement.IsLocalHierarchyChildOf ( AGUIElement  element)
packageinherited

Checks is the element is child of another element in local hierarchy.

Parameters
elementElement to check.
Returns
true in case if child. false otherwise.

◆ OnClose()

override void Doloro.UIEngine2.WindowUIController.OnClose ( )
protectedvirtualinherited

Calling system handlers and self destroying game object.

Reimplemented from Doloro.UIEngine2.Window.

◆ OnContextMenu()

virtual void Doloro.UIEngine2.AGUIElement.OnContextMenu ( )
protectedvirtualinherited

Occurs when you calling context menu with focused element.

Reimplemented in Doloro.UIEngine2.Modules.ElementsCollection.GUIElementHighlighter, and Doloro.UIEngine2.Modules.Tabs.TabGUIElement.

◆ OnDestroy()

override void Doloro.UIEngine2.Modules.Context.ContextMenu.OnDestroy ( )
protectedvirtual

Calls base OnDestroy handler. Forces the window to close in case if has no been closed yet.

Reimplemented from Doloro.UIEngine2.Window.

◆ OnDrag()

virtual void Doloro.UIEngine2.AGUIElement.OnDrag ( )
protectedvirtualinherited

Occurs each frame when you drags the element.

Use ElementOnAction to get drag target.

◆ OnDragEnd()

virtual void Doloro.UIEngine2.AGUIElement.OnDragEnd ( )
protectedvirtualinherited

Occurs when dragging element from ElementOnAction is released.

Reimplemented in Doloro.UIEngine2.Controls.TooltipGUIController, and Doloro.UIEngine2.AFreespaceLayoutController.

◆ OnElementGUI()

override void Doloro.UIEngine2.Modules.Context.ContextMenu.OnElementGUI ( )
virtual

Calling each draw frame. Use to update showing data.

Calling each frame if element displayed. Before self draw call OnElementGUI for all elements in Children collection.

IMPORTANT

Avoid reading inputs here. Use OnInput instead.

Reimplemented from Doloro.UIEngine2.AGUIElement.

◆ OnFocus()

override void Doloro.UIEngine2.WindowUIController.OnFocus ( )
protectedvirtualinherited

Occurs when window focused.

Reimplemented from Doloro.UIEngine2.Window.

◆ OnHide()

override void Doloro.UIEngine2.WindowUIController.OnHide ( )
protectedvirtualinherited

Occurs when window hidden.

Reimplemented from Doloro.UIEngine2.Window.

◆ OnHoverBegin()

override void Doloro.UIEngine2.WindowUIController.OnHoverBegin ( )
protectedvirtualinherited

Occurs when pointer starts hovering above the window.

Reimplemented from Doloro.UIEngine2.AGUIElement.

◆ OnHoverEnd()

override void Doloro.UIEngine2.WindowUIController.OnHoverEnd ( )
protectedvirtualinherited

Occurs when pointer leaves window's rect.

Reimplemented from Doloro.UIEngine2.AGUIElement.

◆ OnInput()

override void Doloro.UIEngine2.Modules.Context.ContextMenu.OnInput ( )
virtual

Handles shortcuts.

Reimplemented from Doloro.UIEngine2.AGUIElement.

◆ OnLostFocus()

virtual void Doloro.UIEngine2.AGUIElement.OnLostFocus ( )
protectedvirtualinherited

Occurs when UI loosing focus.

Reimplemented in Doloro.UIEngine2.Modules.ElementsCollection.AGUIElementsCollection.

◆ OnMoved()

override void Doloro.UIEngine2.WindowUIController.OnMoved ( )
protectedvirtualinherited

Should be called when element position is modified.

Reimplemented from Doloro.UIEngine2.AGUIElement.

◆ OnOpening()

override void Doloro.UIEngine2.Modules.Context.ContextMenu.OnOpening ( )
protectedvirtual

Handle all the data that should be loaded once during window start.

Reimplemented from Doloro.UIEngine2.Window.

◆ OnPointerDown()

override void Doloro.UIEngine2.WindowUIController.OnPointerDown ( )
protectedvirtualinherited

Occurs when LBM pressed above hovering element.

Reimplemented from Doloro.UIEngine2.AGUIElement.

◆ OnPointerUp()

virtual void Doloro.UIEngine2.AGUIElement.OnPointerUp ( )
protectedvirtualinherited

Occurs when LBM released above hovering element.

Not occurs in case it there is had been drag event.

Reimplemented in Doloro.UIEngine2.AFreespaceLayoutController, Doloro.UIEngine2.WindowDragController, Doloro.UIEngine2.Modules.Context.ContextMenuItem, and Doloro.UIEngine2.Modules.ElementsCollection.GUIElementHighlighter.

◆ OnPreCloseCheck()

virtual bool Doloro.UIEngine2.Window.OnPreCloseCheck ( )
protectedvirtualinherited

Occurs before window closed.

Returns
Is the window can be closed? If false then close process will suspended.

Use to check is the window can be closed.

Case:

Check for unsaved content and spawn extra Save as window to prevent data losing.

◆ OnRootFocus()

virtual void Doloro.UIEngine2.Window.OnRootFocus ( )
protectedvirtualinherited

Occurs each time when child GUI element is called.

Exceptions
WindowClosedExceptionTrying to focus window that has been closed.

◆ OnRootFocusInternal()

void Doloro.UIEngine2.Window.OnRootFocusInternal ( )
packageinherited

Occurs each time when child GUI element is called.

Exceptions
WindowClosedExceptionTrying to focus window that has been closed.

◆ OnSizeChanged()

virtual void Doloro.UIEngine2.AGUIElement.OnSizeChanged ( )
protectedvirtualinherited

Should be called when element size is modified.

Reimplemented in Doloro.UIEngine2.Modules.RuntimeWorkspace.RuntimeWorkspaceLayout.

◆ OnWindowFocusLost()

override void Doloro.UIEngine2.Modules.Context.ContextMenu.OnWindowFocusLost ( )
protectedvirtual

Occurs when window lost focus.

Reimplemented from Doloro.UIEngine2.WindowUIController.

◆ OnWindowMovedOnTop()

override void Doloro.UIEngine2.WindowUIController.OnWindowMovedOnTop ( )
protectedvirtualinherited

Occurs when the window has been moved to top of the windows stack.

Reimplemented from Doloro.UIEngine2.Window.

◆ Open() [1/4]

void Doloro.UIEngine2.Window.Open ( )
inherited

Registering the window into the system.

Immediately calls AGUIElement.Focus after calling OnOpening handler and Opened event.

You can reopen a window with WindowStateOptions.Closed WindowState.

Implements Doloro.UIEngine2.IWindowRuntimeRegisterEntry.

◆ Open() [2/4]

static void Doloro.UIEngine2.Modules.Context.ContextMenu.Open ( Rect  rect,
params ContextMenuItemInfo[]  items 
)
static

Opens ContextMenu window instantiated from the resource.

Parameters
rectPosition of the context menu at screen space.
itemsContext menu content descriptors.

◆ Open() [3/4]

void Doloro.UIEngine2.Window.Open ( Window  parent)
inherited

Opening the window with the bond to another window.

Parameters
parentTarget parent window.

The WindowsLayer related to the parent window will be found via the WindowsLayer.ActiveRoot.WindowsLayer.GetLayer(Window, out bool).

◆ Open() [4/4]

void Doloro.UIEngine2.Window.Open ( WindowsLayer  parent)
inherited

Opening the window with the bond to multi window layout.

Parameters
parentParent windows layer.

◆ PointerLogicConveyor()

void Doloro.UIEngine2.AGUIElement.PointerLogicConveyor ( Vector2  pointerPosition,
Rect[]  masks 
)
packageinherited

Conveyor that handles pointer related events.

Parameters
pointerPositionPosition of pointer at the screen.
masksMasks that should be checked for the element.

◆ Start()

override void Doloro.UIEngine2.Modules.Context.ContextMenu.Start ( )
protectedvirtual

Occurs before object finishes initialization.

Reimplemented from Doloro.UIEngine2.WindowUIController.

◆ UpdateLayout()

override void Doloro.UIEngine2.WindowUIController.UpdateLayout ( )
virtualinherited

Sends GUI Element parameters to Unity. Repaints window.

Reimplemented from Doloro.UIEngine2.AWorkspaceGUIElement.

Property Documentation

◆ Children

ReadOnlyCollection<AGUIElement> Doloro.UIEngine2.AGUIElement.Children = new ReadOnlyCollection<AGUIElement>(new AGUIElement[0])
getinherited

Collection of element children.

Immediately access but has arbitrary order.

◆ ClampHandler

override ClampDelegate Doloro.UIEngine2.Window.ClampHandler
getprotectedinherited

Returns handler that should clamp left top corner of elements inside certain bounds.

◆ ContentHolder

RectTransform Doloro.UIEngine2.WindowUIController.ContentHolder
getinherited

Layout element where finishes system controls implementing window layout and starts user controls specific for certain GUI.

All the controls expected to be located as child of this game object. In case of null refers to WindowLayout property value.

◆ DynamicSizeIfClamped

bool Doloro.UIEngine2.Window.DynamicSizeIfClamped = false
getsetinherited

If true then the window would be resized in case if hit the screen bound.

Forces pivot to the [0,1] value.

It not affecting real size value. The window will try to reach original rect during move out of the border.

◆ ElementOnAction

AGUIElement Doloro.UIEngine2.AGUIElement.ElementOnAction
staticgetinherited

Reference to last dragged element.

Overriding only when new drag begun. Use IsMouseDragOn property to check is the process state.

◆ FocusedWindow

Window Doloro.UIEngine2.Window.FocusedWindow
staticgetsetinherited

Current focused window. Null if has no focused.

Set null to lose focus from any window. Unfocused windows not loosing internal focused elements stack, but not affective by inputs.

◆ IsActive

bool Doloro.UIEngine2.AGUIElement.IsActive
getinherited

Checks current element activity state.

◆ IsCoveredByAnotherWindow

bool Doloro.UIEngine2.Window.IsCoveredByAnotherWindow
getinherited

Checking is the window covered by any other window.

Returns

Result of AABB check for windows with WindowState equaled to WindowStateOptions.Active.

Always false if window hidden by itself.

Exceptions
WindowNotOpenedYetExceptionWindow not registered at the system. Open if at first.
WindowClosedExceptionWindow has been closed and can't be handled with the system.

◆ IsRaycastTarget

bool Doloro.UIEngine2.AGUIElement.IsRaycastTarget
getsetinherited

Defines is the element will handle mouse click events.

Not affects children. Still handles OnHover-like events. Not blocks manual call of CallClick and CallContextMenu API members.

◆ LayoutMode

override LayoutModeOptions Doloro.UIEngine2.Window.LayoutMode
getsetinherited

Defines current window draw mode.

Exceptions
WindowClosedExceptionWindow has been closed.

◆ MaxSize

Vector2 Doloro.UIEngine2.Window.MaxSize
getsetinherited

Maximum size of the window.

If any parameter is Zero or negative means [Screen.width, Screen.height] Positive parameters can't be lesser then MinSize.

Implements Doloro.UIEngine2.IClampedSizeLayout.

◆ MinSize

Vector2 Doloro.UIEngine2.Window.MinSize
getsetinherited

Minimum size that allowed to window.

Can't be less then MinSafetySize due to the safety issues. Can't be bigger then max size (clamping to the MaxSize).

Implements Doloro.UIEngine2.IClampedSizeLayout.

◆ Position

override Vector2 Doloro.UIEngine2.Window.Position
getsetinherited

Position of the windows in world coordinates.

Implements Doloro.UIEngine2.IWindowRuntimeRegisterEntry.

◆ SafeBorder

float Doloro.UIEngine2.AWorkspaceGUIElement.SafeBorder = 10f
getsetinherited

At least one of window corners must has the value offset against screen bounds to prevent placing the window out of borders.

10 pixels by default.

◆ ScreenSpacePostion

Vector2 Doloro.UIEngine2.AGUIElement.ScreenSpacePostion
getsetinherited

Returns elements's position at screen space.

Cords counting from top left corner. Useful for full screen operations, like comparing with mouse position or etc.

◆ ScreenSpaceRect [1/2]

Rect Doloro.UIEngine2.AGUIElement.ScreenSpaceRect
getsetinherited

Returns elements's rect at screen space.

Cords counting from top left corner. Useful for full screen operations, like comparing with mouse position or etc.

◆ ScreenSpaceRect [2/2]

Rect Doloro.UIEngine2.IWindowRuntimeRegisterEntry.ScreenSpaceRect
getsetinherited

Entry in screen space coordinates.

Implemented in Doloro.UIEngine2.Window.WindowsLayer.

◆ Size

override Vector2 Doloro.UIEngine2.Window.Size
getsetinherited

Current size of the window.

In case if LayoutMode is AWorkspaceGUIElement.LayoutModeOptions.FullWorkspace always returns AWorkspaceGUIElement.Workspace size.

In case if LayoutMode is AWorkspaceGUIElement.LayoutModeOptions.FullScreen always returns Screen size.

In any case of the LayoutMode set option still will accessible. The value will be relevant as soon as you leave maximized draw state and return to the AWorkspaceGUIElement.LayoutModeOptions.Rect mode.

All the following remarks suppose that the LayoutMode is AWorkspaceGUIElement.LayoutModeOptions.Rect:

In case if enabled options AWorkspaceGUIElement.ClampToScreenBorder and DynamicSizeIfClamped will try to downscale window in case of AWorkspaceGUIElement.Workspace bound hit. Such a size is temporal and not overrides raw one defied as real window size.

Implements Doloro.UIEngine2.IWindowRuntimeRegisterEntry.

◆ WindowLayout

RectTransform Doloro.UIEngine2.WindowUIController.WindowLayout
getinherited

Object that contains all drawing UI including window itself.

Use in case you have to manage entire GUI controls but left window backstage logic to continue its work.

◆ WindowState

WindowStateOptions Doloro.UIEngine2.Window.WindowState
getinherited

The state of the window.

Implements Doloro.UIEngine2.IWindowRuntimeRegisterEntry.

◆ Workspace

virtual Rect Doloro.UIEngine2.AWorkspaceGUIElement.Workspace
getsetinherited

Workspace of the window. Defines the bounds determining as screen for window.

Default: (0,0,Screen.Width,Screen.Height) LayoutModeOptions.FullScreen: (0,0,Screen.Width,Screen.Height)

In case if width or height lesser then 0 then will return Full screen value.


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