Doloro GDK 22 .1.0 Beta
by Tauri Interactive
|
Control element that contains bunch of Windows opened into the certain WorkspaceLayout.
Public Types | |
enum | HAlignment { Left , Center , Right } |
enum | VAlignment { Top , Center , Bottom } |
Public Member Functions | |
int | IndexOf (AWorkspaceGUIElement tabInstance) |
Looking for TabGUIElement at the bar related to a certain tab instance. More... | |
override void | OnElementGUI () |
Call per each GUI event. More... | |
override void | Add (AGUIElement item) |
Adding new element to collection. Updating layout. More... | |
override void | RemoveAt (int index) |
Removing element by index and updating layout. More... | |
override void | Insert (int index, AGUIElement item) |
Inserting UI elements into the collection. More... | |
override void | OnInput () |
Provides navigation by the collection cells. More... | |
virtual void | Clear () |
Clearing all elements from back-end and front-end. | |
bool | Contains (AGUIElement item) |
Checks is the GUI element has been included into the collection. More... | |
void | CopyTo (AGUIElement[] array, int arrayIndex) |
Copying collection to another array. More... | |
IEnumerator< AGUIElement > | GetEnumerator () |
Returns enumerator for AGUIElement collection. More... | |
int | IndexOf (AGUIElement item) |
Returns index of element in collection. More... | |
virtual bool | Remove (AGUIElement item) |
Removing element by reference. More... | |
virtual void | Switch (int first, int second) |
Switches two elements between each other. 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 AGUIElement | FindParentGUIElement (Transform element) |
Looking for parent GUI element. More... | |
static AGUIElement | FindRoot (AGUIElement hierarchyElement) |
Looking for root element at the hierarchy branch. More... | |
Public Attributes | |
string | horizontalAxis = "Horizontal" |
Axis for horizontal input. | |
string | verticalAxis = "Vertical" |
Axis for vertical input. | |
GUIElementHighlighter | selectionGUI |
A GUIElementHighlighter instance that will be used to highlighting of selected item. | |
RectTransform | ContentHolder |
Game object that will be parent for elements. More... | |
Protected Member Functions | |
override void | Start () |
Validating layout. Loading ContentHolder child elements to collection. More... | |
override void | OnDestroy () |
Occurs before object destroy. More... | |
virtual void | OnTabDetached (WorkspaceLayout layout, AWorkspaceGUIElement element) |
Occurs when a element that had been attached to the related WorkspaceLayout has been detached. More... | |
virtual void | OnTabAttached (WorkspaceLayout layout, AWorkspaceGUIElement element) |
Occurs when new element attached to the following WorkspaceLayout. More... | |
override void | OnItemUnselected (AGUIElement item) |
Occurs when before child element losing focus. More... | |
override void | Awake () |
Occurs during object instantiation. More... | |
virtual void | OnScroll (Vector2 scroll) |
Updates layout when scroll view updated. More... | |
override Rect | GetRectForCell (int idx) |
Returning cell rect for by id. More... | |
virtual void | SetContentRectAlongWithCollection () |
Computing size of the AGUIElementsCollection.ContentHolder along with current collection. | |
virtual void | OnLayoutChanged () |
Occurs when list or window layout is changed. Recomputes child layouts. | |
override void | OnLostFocus () |
Dropping selectionGUI's GUIElementHighlighter.FocusedElement value to null . More... | |
virtual void | OnItemSelected (AGUIElement item) |
Occurs when child element is focused. More... | |
void | FindElementsAtTheScene (out int leftElementIdx, out int rightElementIdx) |
Looking for indexes of elements that clamping the collection displayed at the screen. 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 | 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... | |
Protected Attributes | |
List< AGUIElement > | collection = new List<AGUIElement>() |
Collection of bond UI elements. | |
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 | |
AWorkspaceProvider | WorkspaceProvider [get] |
Workspace provider attached to the tab. | |
WorkspaceLayout | layout [get] |
Layout of the attached WorkspaceProvider | |
TabGUIElement | resoruce [get] |
Tab GUI element resource using for tabs creation. | |
UnityEngine.UI.ScrollRect | BondScrollRect [get] |
Scroll rect bond to the handler. | |
ScrollDirectionOptions | Direction [get, set] |
Defines the direction of layout extension in case if current rect can't contains entire collection. | |
Vector2 | CellSize [get, set] |
Size of the cell unit. More... | |
Vector2 | CellSpacing [get, set] |
Defines space in pixels between cells. More... | |
HAlignment | HorizontalAlignment [get, set] |
Defines horizontal alignment of AGUIElementsCollection.ContentHolder's layout in case if it not fills entire layout space. More... | |
VAlignment | VerticalAlignment [get, set] |
Defines vertical alignment of AGUIElementsCollection.ContentHolder's layout in case if it not fills entire layout space. More... | |
Vector2 | ContentAdditiveSize [get, set] |
Pixels that will be added to the ContentHolder size above computed. More... | |
Vector2 | ScrollPosition [get, protected set] |
Current position of the scroll view. | |
override int | Rows [get] |
Rows required to drawing entire elements More... | |
override int | Columns [get] |
Columns required for drawing entire list. More... | |
override int | CellsPerWorkspace [get] |
Returns amount of cells that can be draws per workspace without scrolling. | |
AGUIElement | this[int index] [get, set] |
Returns element by index. More... | |
int | Count [get] |
Count of element into the collection. | |
bool | IsReadOnly [get] |
Always false. | |
bool | SuspendAutoLayoutUpdate = false [get, set] |
If true then avoids calling of the OnLayoutChanged handler. More... | |
virtual int | SystemProtectedContentChildren [get] |
How many children at the ContentHolder reserved as system protected. Such a child will be skipped by internal UI handlers. More... | |
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 | Position [get, set] |
Position of element at the screen. 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 | |
System.Action< AGUIElementsCollection > | CollectionModified |
Occurs when collection content somehow changed. | |
System.Action< AGUIElement > | ItemSelected |
Occurs when new element selected. | |
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. | |
|
virtualinherited |
Adding new element to collection. Updating layout.
item | New element. |
Reimplemented from Doloro.UIEngine2.Modules.ElementsCollection.AGUIElementsCollection.
|
protectedvirtualinherited |
Occurs during object instantiation.
Reimplemented from Doloro.UIEngine2.AGUIElement.
|
inherited |
Checks is the GUI element has been included into the collection.
item | Item to comparison. |
|
inherited |
Copying collection to another array.
array | Target array. |
arrayIndex | Start index at the array to start. |
|
protectedinherited |
Looking for indexes of elements that clamping the collection displayed at the screen.
leftElementIdx | |
rightElementIdx |
Use to detect elements those GUI should be hidden to prevent extra operations.
|
staticinherited |
Looking for parent GUI element.
element | Source element transform. |
|
staticinherited |
Looking for root element at the hierarchy branch.
hierarchyElement | Element of hierarchy. |
|
inherited |
Returns enumerator for AGUIElement collection.
|
protectedvirtualinherited |
Returning cell rect for by id.
idx | Index of possible element in the grid. |
Implements Doloro.UIEngine2.Modules.ElementsCollection.AGUIElementsCollection.
|
inherited |
Returns index of element in collection.
item |
int Doloro.UIEngine2.Modules.Tabs.TabsBar.IndexOf | ( | AWorkspaceGUIElement | tabInstance | ) |
Looking for TabGUIElement at the bar related to a certain tab instance.
tabInstance | Instance of an attached element. |
|
virtualinherited |
Inserting UI elements into the collection.
index | Index to insert. |
item | Element to insert. |
Reimplemented from Doloro.UIEngine2.Modules.ElementsCollection.AGUIElementsCollection.
|
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 |
Occurs before object destroy.
Reimplemented from Doloro.UIEngine2.Modules.ElementsCollection.GridCollection.
|
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 |
Call per each GUI event.
Reimplemented from Doloro.UIEngine2.AGUIElement.
|
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 |
Provides navigation by the collection cells.
Reimplemented from Doloro.UIEngine2.AGUIElement.
|
protectedvirtualinherited |
Occurs when child element is focused.
item | Focused element. |
|
protectedvirtual |
Occurs when before child element losing focus.
item | Element that has been selected till next logic step. |
Reimplemented from Doloro.UIEngine2.Modules.ElementsCollection.AGUIElementsCollection.
|
protectedvirtualinherited |
Dropping selectionGUI's GUIElementHighlighter.FocusedElement value to null
.
Reimplemented from Doloro.UIEngine2.AGUIElement.
|
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 |
Updates layout when scroll view updated.
scroll | Current scroll position |
|
protectedvirtualinherited |
Should be called when element size is modified.
Reimplemented in Doloro.UIEngine2.Modules.RuntimeWorkspace.RuntimeWorkspaceLayout.
|
protectedvirtual |
Occurs when new element attached to the following WorkspaceLayout.
layout | Modified layout. |
element | Attached element. |
|
protectedvirtual |
Occurs when a element that had been attached to the related WorkspaceLayout has been detached.
layout | Following layout. |
element | Element to detach. |
|
packageinherited |
Conveyor that handles pointer related events.
pointerPosition | Position of pointer at the screen. |
masks | Masks that should be checked for the element. |
|
virtualinherited |
Removing element by reference.
item | Source element. |
System.AccessViolationException | Trying to remove object protected by the core. |
|
virtualinherited |
Removing element by index and updating layout.
index | Element to remove. |
Reimplemented from Doloro.UIEngine2.Modules.ElementsCollection.AGUIElementsCollection.
|
protectedvirtual |
Validating layout. Loading ContentHolder child elements to collection.
Reimplemented from Doloro.UIEngine2.Modules.ElementsCollection.AGUIElementsCollection.
|
virtualinherited |
Switches two elements between each other.
first | Index of first element to switch. |
second | Index of second element to switch. |
|
inherited |
Game object that will be parent for elements.
Using this if null.
|
getsetinherited |
Size of the cell unit.
Zero or negative axis value means that side is starched to self BondScrollRect.viewport.rect
size.
|
getsetinherited |
Defines space in pixels between cells.
Can't be lesser the 0.
|
getinherited |
Collection of element children.
Immediately access but has arbitrary order.
|
getinherited |
Columns required for drawing entire list.
Can't be lesser then 1.
|
getsetinherited |
Pixels that will be added to the ContentHolder size above computed.
Use to add clip zone offset in case if you use cells with non center anchor point.
|
staticgetinherited |
Reference to last dragged element.
Overriding only when new drag begun. Use IsMouseDragOn property to check is the process state.
|
getsetinherited |
Defines horizontal alignment of AGUIElementsCollection.ContentHolder's layout in case if it not fills entire layout space.
Works only in case Direction is ScrollDirectionOptions.Vertical.
|
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.
|
getsetinherited |
Position of element at the screen.
Demands RectTransform if not overridden.
|
getinherited |
Rows required to drawing entire elements
Can't be lesser then 1.
|
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.
|
getsetprotectedinherited |
If true then avoids calling of the OnLayoutChanged handler.
Use if you need to make a bunch of collection changes to prevent extra operations.
|
getprotectedinherited |
How many children at the ContentHolder reserved as system protected. Such a child will be skipped by internal UI handlers.
This children could be used as you wish for internal purposes and don't represents the collection content.
selectionGUI placing at the 0 index of content children.
|
getsetinherited |
Returns element by index.
index | Index of element. |
|
getsetinherited |
Defines vertical alignment of AGUIElementsCollection.ContentHolder's layout in case if it not fills entire layout space.
Works only in case Direction is ScrollDirectionOptions.Horizontal.