Class UIStack
A stack data structure for management and presentation of UI Panels
Inheritance
Namespace: Atlas
Assembly: Atlas.Runtime.dll
Syntax
public sealed class UIStack
Constructors
| Improve this Doc View SourceUIStack()
Constructor
Declaration
public UIStack()
Properties
| Improve this Doc View SourceCount
Number of panels currently in the stack
Declaration
public int Count { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Methods
| Improve this Doc View SourceClear()
Removes all panels from the stack. OnPop(Boolean) will not be called.
Declaration
public void Clear()
Contains(IUIPanel)
Determines whether or not the given panel is contained within the stack
Declaration
public bool Contains(IUIPanel panel)
Parameters
Type | Name | Description |
---|---|---|
IUIPanel | panel | The panel to check |
Returns
Type | Description |
---|---|
System.Boolean | True if the panel is in the stack, false otherwise |
Peek()
Returns the top IUIPanel
Declaration
public IUIPanel Peek()
Returns
Type | Description |
---|---|
IUIPanel | The top panel |
Pop()
Removes the top panel from the stack, with full transitions
Declaration
public IUIPanel Pop()
Returns
Type | Description |
---|---|
IUIPanel | The popped panel |
Pop(UIStack.Transition)
Removes the top panel from the stack, with the given transition(s)
Declaration
public IUIPanel Pop(UIStack.Transition transition)
Parameters
Type | Name | Description |
---|---|---|
UIStack.Transition | transition | Type of transition(s) to play |
Returns
Type | Description |
---|---|
IUIPanel | The popped panel |
Push(IUIPanel)
Pushes the given panel onto the top of the stack, hiding all current panels, with full transitions
Declaration
public void Push(IUIPanel panel)
Parameters
Type | Name | Description |
---|---|---|
IUIPanel | panel | The panel to push |
Push(IUIPanel, UIStack.Transition)
Pushes the given panel onto the top of the stack, hiding all current panels using the given transitions
Declaration
public void Push(IUIPanel panel, UIStack.Transition transition)
Parameters
Type | Name | Description |
---|---|---|
IUIPanel | panel | The panel to push |
UIStack.Transition | transition | Type of transition(s) to play |