Doloro GDK 22 .1.0 Beta
by Tauri Interactive
|
Standalone window that provides logic and API related to stores inspector UI.
Public Types | |
enum | LayoutModeOptions { Rect , FullWorkspace , FullScreen } |
Defines window rect selection behavior. More... | |
Public Member Functions | |
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... | |
virtual void | OnInput () |
Handler that will be called for elements in input priority order. use to modify data along with input instead of using OnElementGUI. More... | |
virtual void | OnElementGUI () |
Calling each draw frame. Use to update showing data. More... | |
Static Public Member Functions | |
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 | |
delegate bool | Validator (Storage storage) |
Signature of the handler using to storage validation process. More... | |
override void | Start () |
Occurs before object finishes initialization. More... | |
override void | OnDestroy () |
Dropping focus. Unregistering element from GUI hierarchy. More... | |
virtual void | OnAvailableItemsUIChanged () |
Occurs when AvailableItemsUI changed. | |
virtual void | OnReservedItemsUIChanged () |
Occurs when ReservedItemsUI changed. | |
virtual void | OnStorageRented (Storage obj) |
Occurs when new Storage entity rented after window has been opened and tries to connect it to UI. More... | |
virtual void | OnShopsDataConnectorChanged () |
Occurs when ShopsDataConnector changed. | |
virtual void | OnPlayerDataConnectorChanged () |
Occurs when PlayerStoragesDataConnector changed. | |
virtual bool | OnPlayerStorageAdd (Storage storage) |
Checks is the Features.StorageInfo attached to the Storage has the same Features.StorageInfo.OwnerID as player; More... | |
virtual bool | OnShopStorageAdd (Storage storage) |
Checks is the Storage instance has defined ShopFeature component. More... | |
Storage | GetSelected (StoragesCollectionDataConnector connector) |
Looking for content selected for data connector. More... | |
bool | TryToAdd (StoragesCollectionDataConnector connector, Validator validator, Storage storage, Storage.StorageDelegate OnRentOverHandler) |
Trying to add a Storage to the collection. More... | |
virtual void | OnVirtualHubSelectedEventListener (UnityEngine.Object sender, object[] sharedData) |
Occurs when attached hub receives shared selection event. 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 | OnWindowFocusLost () |
Occurs when window lost focus. 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 void | OnOpening () |
Handle all the data that should be loaded once during window start. 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 | |
VirtualUIHub | hub [get] |
Root virtual events hub attached to the inspector. | |
StoragesCollectionDataConnector | ShopsDataConnector [get, set] |
Data set controller that used to the shops related storages. | |
StoragesCollectionDataConnector | PlayerStoragesDataConnector [get, set] |
Data set controller that used to the player related storages. | |
ExchangeBufferGUIElement | AvailableItemsUI [get, set] |
Exchange buffers UI instance that using to show items available to TransactionService. | |
ExchangeBufferGUIElement | ReservedItemsUI [get, set] |
Exchange buffers UI instance that using to show items reserved with TransactionService. | |
Guid | playerId [get, set] |
Id of the player that using to detected Storages owned by player and which ones are placed at the location or owned by shops. | |
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< AGUIElement > | Children = 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< AGUIElement > | Focused |
Occurs when element is focused. | |
Action< AGUIElement > | FocusLost |
Occurs when element loosing focus. | |
Action< AGUIElement > | HoverStarted |
Occurs when pointer crossing element's rect bounds. | |
Action< AGUIElement > | Hovered |
Occurs each time when GUI is changed and pointer is over the element. | |
Action< AGUIElement > | HoverEnded |
Occurs when pointer leaving the element's rect. | |
Action< AGUIElement > | DragStarted |
Occurs when drag process is starting. | |
Action< AGUIElement > | Draged |
Occurs during element drag process. | |
Action< AGUIElement > | DragEnded |
Occurs when element drag is ended. | |
Action< AGUIElement > | PointerDown |
Occurs when element pressed with LMB. | |
Action< AGUIElement > | PointerUp |
Occurs when element LB has been released with the pointer above element. | |
Action< AGUIElement > | ContextMenuCalled |
Occurs when user calling context menu for element. | |
Action< AGUIElement > | Moved |
Occurs when element is moved. | |
Action< AGUIElement > | SizeChanged |
Occurs when element Size changed. | |
|
inherited |
|
protectedvirtualinherited |
Occurs during object instantiation.
Reimplemented from Doloro.UIEngine2.Window.
|
protectedinherited |
Handler that should clamp left top corner of elements inside certain bounds.
mode | Axis: 0 - horizontal, 1 - vertical. |
coordinates | Raw position by axis. |
elementSide | Element side size related to axis. |
wsCoord | Start point of workspace. |
wsSize | Size of the workspace side along with axis. |
|
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.
|
staticinherited |
Looking for parent GUI element.
element | Source element transform. |
|
staticinherited |
Looking for root element at the hierarchy branch.
hierarchyElement | Element of hierarchy. |
|
staticinherited |
Looking for parent Window for element.
element | Source element. |
|
protected |
Looking for content selected for data connector.
connector | Component that connects data with UI. |
null
if nothing selected.
|
inherited |
Hiding the window. The window continue to operate background tasks and can be restored by Open or AGUIElement.Focus call.
WindowClosedException | Trying 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.
|
virtualinherited |
Checks is the element is a child of another element.
element | Target element. |
Virtual logic that can be re-implemented to allow creation of virtual hierarchy.
|
packageinherited |
Checks is the element is child of another element in local hierarchy.
element | Element to check. |
true
in case if child. false
otherwise.
|
protectedvirtualinherited |
Calling system handlers and self destroying game object.
Reimplemented from Doloro.UIEngine2.Window.
|
protectedvirtualinherited |
Occurs when you calling context menu with focused element.
Reimplemented in Doloro.UIEngine2.Modules.ElementsCollection.GUIElementHighlighter, and Doloro.UIEngine2.Modules.Tabs.TabGUIElement.
|
protectedvirtual |
Dropping focus. Unregistering element from GUI hierarchy.
Reimplemented from Doloro.UIEngine2.AGUIElement.
|
protectedvirtualinherited |
Occurs each frame when you drags the element.
Use ElementOnAction to get drag target.
|
protectedvirtualinherited |
Occurs when dragging element from ElementOnAction is released.
Reimplemented in Doloro.UIEngine2.Controls.TooltipGUIController, and Doloro.UIEngine2.AFreespaceLayoutController.
|
virtualinherited |
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.
Avoid reading inputs here. Use OnInput instead.
Reimplemented in Doloro.UIEngine2.Modules.Context.ContextMenu, Doloro.UIEngine2.Modules.ElementsCollection.GridCollection, and Doloro.UIEngine2.Modules.ElementsCollection.GUIElementHighlighter.
|
protectedvirtualinherited |
Occurs when window focused.
Reimplemented from Doloro.UIEngine2.Window.
|
protectedvirtualinherited |
Occurs when window hidden.
Reimplemented from Doloro.UIEngine2.Window.
|
protectedvirtualinherited |
Occurs when pointer starts hovering above the window.
Reimplemented from Doloro.UIEngine2.AGUIElement.
|
protectedvirtualinherited |
Occurs when pointer leaves window's rect.
Reimplemented from Doloro.UIEngine2.AGUIElement.
|
virtualinherited |
Handler that will be called for elements in input priority order. use to modify data along with input instead of using OnElementGUI.
Don't forget call Event.Use in case if event consumed by element. Otherwise event will foes deeper into the focused elements hierarchy.
Reimplemented in Doloro.UIEngine2.Modules.Context.ContextMenu, and Doloro.UIEngine2.Modules.ElementsCollection.GridCollection.
|
protectedvirtualinherited |
Occurs when UI loosing focus.
Reimplemented in Doloro.UIEngine2.Modules.ElementsCollection.AGUIElementsCollection.
|
protectedvirtualinherited |
Should be called when element position is modified.
Reimplemented from Doloro.UIEngine2.AGUIElement.
|
protectedvirtualinherited |
Handle all the data that should be loaded once during window start.
Reimplemented in Doloro.InvetorySystem.UI.Windows.StoragesInspector, and Doloro.UIEngine2.Modules.Context.ContextMenu.
|
protectedvirtual |
Checks is the Features.StorageInfo attached to the Storage has the same Features.StorageInfo.OwnerID as player;
storage |
true
in case is storage owner id equals to playerId. false
otherwise or in case if Storage has not Features.StorageInfo component.
|
protectedvirtualinherited |
Occurs when LBM pressed above hovering element.
Reimplemented from Doloro.UIEngine2.AGUIElement.
|
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.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
Occurs each time when child GUI element is called.
WindowClosedException | Trying to focus window that has been closed. |
|
packageinherited |
Occurs each time when child GUI element is called.
WindowClosedException | Trying to focus window that has been closed. |
|
protectedvirtual |
|
protectedvirtualinherited |
Should be called when element size is modified.
Reimplemented in Doloro.UIEngine2.Modules.RuntimeWorkspace.RuntimeWorkspaceLayout.
|
protectedvirtual |
|
protectedvirtual |
Occurs when attached hub receives shared selection
event.
sender | Object shared event. |
sharedData | Data shared along with the object. |
|
protectedvirtualinherited |
Occurs when window lost focus.
Reimplemented from Doloro.UIEngine2.Window.
Reimplemented in Doloro.UIEngine2.Modules.Context.ContextMenu.
|
protectedvirtualinherited |
Occurs when the window has been moved to top of the windows stack.
Reimplemented from Doloro.UIEngine2.Window.
|
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.
|
inherited |
Opening the window with the bond to another window.
parent | Target parent window. |
The WindowsLayer related to the parent
window will be found via the WindowsLayer.ActiveRoot.WindowsLayer.GetLayer(Window, out bool).
|
inherited |
Opening the window with the bond to multi window layout.
parent | Parent windows layer. |
|
packageinherited |
Conveyor that handles pointer related events.
pointerPosition | Position of pointer at the screen. |
masks | Masks that should be checked for the element. |
|
protectedvirtual |
Occurs before object finishes initialization.
Reimplemented from Doloro.UIEngine2.WindowUIController.
|
protected |
|
virtualinherited |
Sends GUI Element parameters to Unity. Repaints window.
Reimplemented from Doloro.UIEngine2.AWorkspaceGUIElement.
|
protected |
Signature of the handler using to storage validation process.
storage | Storage to check. |
|
getinherited |
Collection of element children.
Immediately access but has arbitrary order.
|
getprotectedinherited |
Returns handler that should clamp left top corner of elements inside certain bounds.
|
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.
|
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.
|
staticgetinherited |
Reference to last dragged element.
Overriding only when new drag begun. Use IsMouseDragOn property to check is the process state.
|
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.
|
getinherited |
Checks current element activity state.
|
getinherited |
Checking is the window covered by any other window.
Result of AABB check for windows with WindowState equaled to WindowStateOptions.Active.
Always false if window hidden by itself.
WindowNotOpenedYetException | Window not registered at the system. Open if at first. |
WindowClosedException | Window has been closed and can't be handled with the system. |
|
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.
|
getsetinherited |
Defines current window draw mode.
WindowClosedException | Window has been closed. |
|
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.
|
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.
|
getsetinherited |
Position of the windows in world coordinates.
Implements Doloro.UIEngine2.IWindowRuntimeRegisterEntry.
|
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.
|
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.
|
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.
|
getsetinherited |
Entry in screen space coordinates.
Implemented in Doloro.UIEngine2.Window.WindowsLayer.
|
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.
|
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.
|
getinherited |
The state of the window.
Implements Doloro.UIEngine2.IWindowRuntimeRegisterEntry.
|
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.