Doloro GDK 22 .1.0 Beta
by Tauri Interactive
|
GUI element that support workspace layout module.
Public Types | |
enum | LayoutModeOptions { Rect , FullWorkspace , FullScreen } |
Defines window rect selection behavior. More... | |
Public Member Functions | |
virtual void | UpdateLayout () |
Sends GUI Element parameters to Unity. Repaints window. 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 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 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... | |
override void | OnDestroy () |
Dropping focus. Unregistering element from GUI hierarchy. More... | |
virtual void | Awake () |
Loading core components. 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 | OnMoved () |
Should be called when element position is modified. More... | |
virtual void | OnSizeChanged () |
Should be called when element size is modified. More... | |
virtual void | OnFocus () |
Occurs when element requested on focus. More... | |
virtual void | OnLostFocus () |
Occurs when UI loosing focus. More... | |
virtual void | OnHoverBegin () |
Occurs when pointer starts hovering the element. More... | |
virtual void | OnHover () |
Occurs when the pointer is over the element. | |
virtual void | OnHoverEnd () |
Occurs when pointer ending hovering the element. More... | |
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 | OnPointerDown () |
Occurs when LBM pressed above hovering element. 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 | 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 | |
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 LayoutModeOptions | LayoutMode [get, set] |
Defines current element draw mode. | |
virtual Rect | Workspace [get, set] |
Workspace of the window. Defines the bounds determining as screen for window. More... | |
virtual ClampDelegate | ClampHandler [get] |
Returns handler that should clamp left top corner of elements inside certain bounds. | |
override Vector2 | Position [get, set] |
Position of element clamped with the workspace area. 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... | |
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 | Size [get, set] |
Size of element. More... | |
virtual Vector2 | LocalPosition [get, set] |
Position relative to the parent element. | |
virtual bool | OnStackTopWhenFocused [get] |
Defines if the element would be moved at the top of focus stack or will stay the same position when it focused. More... | |
virtual bool | IsVisibleForEngine [get] |
Defines is the element is visible for internal engine features. In case of false will be skipped during common callbacks. | |
Events | |
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. | |
|
protectedvirtualinherited |
Loading core components.
Reimplemented in Doloro.InvetorySystem.Modules.Shops.UI.Windows.TransactionOrderInspector, Doloro.InvetorySystem.UI.Windows.StoragesInspector, Doloro.UIEngine2.Window, Doloro.UIEngine2.AWorkspaceProvider, Doloro.UIEngine2.WindowUIController, Doloro.UIEngine2.Modules.ElementsCollection.GridCollection, Doloro.UIEngine2.Modules.RuntimeWorkspace.RuntimeWorkspaceLayout, Doloro.UIEngine2.Modules.RuntimeWorkspace.RuntimeWorkspaceSplitter, and Doloro.UIEngine2.Modules.Tabs.TabGUIElement.
|
protected |
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. |
|
staticinherited |
Looking for parent GUI element.
element | Source element transform. |
|
staticinherited |
Looking for root element at the hierarchy branch.
hierarchyElement | Element of hierarchy. |
|
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 |
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.
Reimplemented in Doloro.UIEngine2.Modules.Context.ContextMenu.
|
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 element requested on focus.
Reimplemented in Doloro.UIEngine2.Window, Doloro.UIEngine2.WindowUIController, and Doloro.UIEngine2.Modules.Tabs.TabGUIElement.
|
protectedvirtualinherited |
Occurs when pointer starts hovering the element.
Reimplemented in Doloro.UIEngine2.Controls.TooltipGUIController, and Doloro.UIEngine2.WindowUIController.
|
protectedvirtualinherited |
Occurs when pointer ending hovering the element.
Reimplemented in Doloro.UIEngine2.Controls.TooltipGUIController, and Doloro.UIEngine2.WindowUIController.
|
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 in Doloro.UIEngine2.WindowUIController, and Doloro.UIEngine2.Modules.RuntimeWorkspace.RuntimeWorkspaceLayout.
|
protectedvirtualinherited |
Occurs when LBM pressed above hovering element.
Reimplemented in Doloro.UIEngine2.AFreespaceLayoutController, Doloro.UIEngine2.AWindowLayoutController, Doloro.UIEngine2.WindowDragController, Doloro.UIEngine2.WindowResizeController, Doloro.UIEngine2.WindowUIController, and Doloro.UIEngine2.Modules.RuntimeWorkspace.RuntimeWorkspaceSplitter.
|
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 |
Should be called when element size is modified.
Reimplemented in Doloro.UIEngine2.Modules.RuntimeWorkspace.RuntimeWorkspaceLayout.
|
packageinherited |
Conveyor that handles pointer related events.
pointerPosition | Position of pointer at the screen. |
masks | Masks that should be checked for the element. |
|
virtual |
Sends GUI Element parameters to Unity. Repaints window.
Reimplemented in Doloro.UIEngine2.WindowUIController.
|
getinherited |
Collection of element children.
Immediately access but has arbitrary order.
|
staticgetinherited |
Reference to last dragged element.
Overriding only when new drag begun. Use IsMouseDragOn property to check is the process state.
|
getinherited |
Checks current element activity state.
|
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.
|
getprotectedinherited |
Defines if the element would be moved at the top of focus stack or will stay the same position when it focused.
By default elements not changing order by some system like Window module
Requires stack modifying to make it possible to update windows order.
Works only for elements with true
IsRoot property.
|
getset |
Position of element clamped with the workspace area.
Not allows to set invalid value.
|
getset |
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 |
Size of element.
Demands RectTransform if not overridden.
|
getset |
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.