Class StackCanvasController

The StackCanvasController is a container view controller designed for stacking screens on top of each other. It manages a stack of child view controllers and offers transitions for pushing and popping view controllers on and off its stack. Each child view controller fills the viewControllersContainer transform and is placed in stack order, making the top-most view controller on the stack visible.

The StackCanvasController offers transitions for pushing and popping view controllers on and off its stack. Pushing a view controller onto the stack instantiates its view, embeds it within the stack controller's viewControllersContainer, and if necessary animates it on-screen. Inversely, popping a view controller off the stack animates it off-screen if necessary, and subsequently destroys it.

Pushing a view controller onto a full-screen StackCanvasController would have the same architectural user-experience as presenting that view controller (albeit possibly with a different transition animation). Where the StackCanvasController becomes particularly useful is in presenting view controllers that are not full-screen. This allows you to create presentation stacks within a view.

See NavigationCanvasController for a specific type of StackCanvasController designed to provide a user-interface for hierarchical navigation.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.ScriptableObject
ViewController<CanvasController, CanvasView, CanvasWindow, CanvasViewResource, CanvasControllerTransition, CanvasControllerTransitionContext, CanvasControllerTransitionAnimatorProvider, ICanvasControllerTransitionProgressProvider, CanvasControllerTransitionAnimationDriver, CanvasControllerTransitionProgressProvider, CanvasControllerInvokeTransitionData, CanvasGraph>
CanvasController
StackCanvasController
NavigationCanvasController
Inherited Members
UnityEngine.ScriptableObject.SetDirty()
UnityEngine.ScriptableObject.CreateInstance(System.String)
UnityEngine.ScriptableObject.CreateInstance(System.Type)
UnityEngine.ScriptableObject.CreateInstance<T>()
UnityEngine.Object.GetInstanceID()
UnityEngine.Object.GetHashCode()
UnityEngine.Object.Equals(System.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Instantiate<T>(T)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
UnityEngine.Object.Destroy(UnityEngine.Object)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
UnityEngine.Object.FindObjectsOfType(System.Type)
UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
UnityEngine.Object.DestroyObject(UnityEngine.Object)
UnityEngine.Object.FindSceneObjectsOfType(System.Type)
UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
UnityEngine.Object.FindObjectsOfType<T>()
UnityEngine.Object.FindObjectOfType<T>()
UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
UnityEngine.Object.FindObjectOfType(System.Type)
UnityEngine.Object.ToString()
UnityEngine.Object.name
UnityEngine.Object.hideFlags
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Pelican7.UIGraph
Assembly: UI Graph API Documentation Project.dll
Syntax
public class StackCanvasController : CanvasController, IViewControllerAppearance, IAppearable, ITransitionContextViewController, IGraphableTransitionViewObjectContainer, IGraphableTransitionInvoker, IGraphableEmbedContainer, IGraphableFieldProvider, IGraphable

Fields

allowsRootViewControllerToBePopped

Allow the root view controller to be popped?

Declaration
public bool allowsRootViewControllerToBePopped
Field Value
Type Description
System.Boolean

PopAllTransition

The transition identifier for the Stack Canvas Controller's Pop All transition.

Declaration
public static readonly ViewControllerTransitionIdentifier PopAllTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

PopToRootTransition

The transition identifier for the Stack Canvas Controller's Pop To Root transition.

Declaration
public static readonly ViewControllerTransitionIdentifier PopToRootTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

PopToTransition

The transition identifier for the Stack Canvas Controller's Pop To transition.

Declaration
public static readonly ViewControllerTransitionIdentifier PopToTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

PopTransition

The transition identifier for the Stack Canvas Controller's Pop transition.

Declaration
public static readonly ViewControllerTransitionIdentifier PopTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

PushTransition

The transition identifier for the Stack Canvas Controller's Push transition.

Declaration
public static readonly ViewControllerTransitionIdentifier PushTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

SetRootTransition

The transition identifier for the Stack Canvas Controller's Set Root transition.

Declaration
public static readonly ViewControllerTransitionIdentifier SetRootTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

viewControllers

Declaration
protected Stack<CanvasController> viewControllers
Field Value
Type Description
System.Collections.Generic.Stack<CanvasController>

viewControllersContainer

The container into which the stack controller places its child view controllers.

Declaration
public RectTransform viewControllersContainer
Field Value
Type Description
UnityEngine.RectTransform

Properties

LowestAllowedStackCount

Retrieve the lowest allowed stack count. This value is dependent upon allowsRootViewControllerToBePopped.

Declaration
public int LowestAllowedStackCount { get; }
Property Value
Type Description
System.Int32

PopAllTransitionIdentifier

Declaration
protected virtual ViewControllerTransitionIdentifier PopAllTransitionIdentifier { get; }
Property Value
Type Description
ViewControllerTransitionIdentifier

PopToRootTransitionIdentifier

Declaration
protected virtual ViewControllerTransitionIdentifier PopToRootTransitionIdentifier { get; }
Property Value
Type Description
ViewControllerTransitionIdentifier

PopToTransitionIdentifier

Declaration
protected virtual ViewControllerTransitionIdentifier PopToTransitionIdentifier { get; }
Property Value
Type Description
ViewControllerTransitionIdentifier

PopTransitionIdentifier

Declaration
protected virtual ViewControllerTransitionIdentifier PopTransitionIdentifier { get; }
Property Value
Type Description
ViewControllerTransitionIdentifier

PushTransitionIdentifier

Declaration
protected virtual ViewControllerTransitionIdentifier PushTransitionIdentifier { get; }
Property Value
Type Description
ViewControllerTransitionIdentifier

RootViewController

Retrieve the stack controller's root view controller.

Declaration
public CanvasController RootViewController { get; }
Property Value
Type Description
CanvasController

SetRootTransitionIdentifier

Declaration
protected virtual ViewControllerTransitionIdentifier SetRootTransitionIdentifier { get; }
Property Value
Type Description
ViewControllerTransitionIdentifier

TopViewController

Retrieve the stack controller's top view controller. This is the view controller at the top of the stack.

Declaration
public CanvasController TopViewController { get; }
Property Value
Type Description
CanvasController

ViewControllers

Retrieve the stack controller's stack of view controllers as a list.

Declaration
public CanvasController[] ViewControllers { get; }
Property Value
Type Description
CanvasController[]

Methods

CanPopToViewController(CanvasController, out Error)

Can the stack controller pop to viewController?

Declaration
public bool CanPopToViewController(CanvasController viewController, out Error error)
Parameters
Type Name Description
CanvasController viewController
Error error
Returns
Type Description
System.Boolean

True if the stack controller can pop to viewController. False otherwise.

CanPopViewController(out Error)

Can the stack controller pop a view controller?

Declaration
public bool CanPopViewController(out Error error)
Parameters
Type Name Description
Error error
Returns
Type Description
System.Boolean

True if a view controller can be popped. False otherwise.

CanPushViewController(CanvasController, out Error)

Can viewController be pushed by the stack controller?

Declaration
public bool CanPushViewController(CanvasController viewController, out Error error)
Parameters
Type Name Description
CanvasController viewController
Error error
Returns
Type Description
System.Boolean

True if viewController can be pushed. False otherwise.

CanSetRootViewController(CanvasController, out Error)

Can the stack controller set its RootViewController to viewController?

Declaration
public bool CanSetRootViewController(CanvasController viewController, out Error error)
Parameters
Type Name Description
CanvasController viewController
Error error
Returns
Type Description
System.Boolean

True if the stack controller set its RootViewController to viewController. False otherwise.

GraphableTransitionIdentifiers()

Declaration
protected override List<GraphableTransitionIdentifier> GraphableTransitionIdentifiers()
Returns
Type Description
System.Collections.Generic.List<GraphableTransitionIdentifier>
Overrides
Pelican7.UIGraph.ViewController<Pelican7.UIGraph.CanvasController, Pelican7.UIGraph.CanvasView, Pelican7.UIGraph.CanvasWindow, Pelican7.UIGraph.CanvasViewResource, Pelican7.UIGraph.CanvasControllerTransition, Pelican7.UIGraph.CanvasControllerTransitionContext, Pelican7.UIGraph.CanvasControllerTransitionAnimatorProvider, Pelican7.UIGraph.ICanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerTransitionAnimationDriver, Pelican7.UIGraph.CanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerInvokeTransitionData, Pelican7.UIGraph.CanvasGraph>.GraphableTransitionIdentifiers()

ImplementsTransition(ViewControllerTransitionIdentifier)

Declaration
protected override bool ImplementsTransition(ViewControllerTransitionIdentifier transitionIdentifier)
Parameters
Type Name Description
ViewControllerTransitionIdentifier transitionIdentifier
Returns
Type Description
System.Boolean
Overrides
Pelican7.UIGraph.ViewController<Pelican7.UIGraph.CanvasController, Pelican7.UIGraph.CanvasView, Pelican7.UIGraph.CanvasWindow, Pelican7.UIGraph.CanvasViewResource, Pelican7.UIGraph.CanvasControllerTransition, Pelican7.UIGraph.CanvasControllerTransitionContext, Pelican7.UIGraph.CanvasControllerTransitionAnimatorProvider, Pelican7.UIGraph.ICanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerTransitionAnimationDriver, Pelican7.UIGraph.CanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerInvokeTransitionData, Pelican7.UIGraph.CanvasGraph>.ImplementsTransition(Pelican7.UIGraph.ViewControllerTransitionIdentifier)

PerformInvokedTransition(ViewControllerTransitionIdentifier, CanvasControllerInvokeTransitionData, Action)

Declaration
protected override void PerformInvokedTransition(ViewControllerTransitionIdentifier transitionIdentifier, CanvasControllerInvokeTransitionData transitionData, Action completion)
Parameters
Type Name Description
ViewControllerTransitionIdentifier transitionIdentifier
CanvasControllerInvokeTransitionData transitionData
System.Action completion
Overrides
Pelican7.UIGraph.ViewController<Pelican7.UIGraph.CanvasController, Pelican7.UIGraph.CanvasView, Pelican7.UIGraph.CanvasWindow, Pelican7.UIGraph.CanvasViewResource, Pelican7.UIGraph.CanvasControllerTransition, Pelican7.UIGraph.CanvasControllerTransitionContext, Pelican7.UIGraph.CanvasControllerTransitionAnimatorProvider, Pelican7.UIGraph.ICanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerTransitionAnimationDriver, Pelican7.UIGraph.CanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerInvokeTransitionData, Pelican7.UIGraph.CanvasGraph>.PerformInvokedTransition(Pelican7.UIGraph.ViewControllerTransitionIdentifier, Pelican7.UIGraph.CanvasControllerInvokeTransitionData, System.Action)

Pop(Boolean, Action)

Pop the top view controller off the stack. The top view controller will be transitioned off-screen and subsequently destroyed.

Declaration
public void Pop(bool animated = true, Action completion = null)
Parameters
Type Name Description
System.Boolean animated
System.Action completion

PopAll(Boolean, Action)

Pop all view controllers off the stack. The top view controller will be transitioned off-screen and subsequently destroyed. Any intermediary view controllers will be hidden prior to transition and subsequently destroyed on completion. This method requires allowsRootViewControllerToBePopped to be true.

Declaration
public void PopAll(bool animated = true, Action completion = null)
Parameters
Type Name Description
System.Boolean animated
System.Action completion

PopAllInteractively(Action)

Pop all view controllers off the stack interactively. The top view controller will be transitioned off-screen and subsequently destroyed. Any intermediary view controllers will be hidden prior to transition and subsequently destroyed on completion. This method requires allowsRootViewControllerToBePopped to be true. Prior to calling this method, you should set the view controller's to an appropriate object. If no has been configured, the view controller(s) will be popped without interactivity.

Declaration
public void PopAllInteractively(Action completion = null)
Parameters
Type Name Description
System.Action completion

PopInteractively(Action)

Pop the top view controller off the stack interactively. The top view controller will be transitioned off-screen interactively and subsequently destroyed. Prior to calling this method, you should set the view controller's to an appropriate object. If no has been configured, the top view controller will be popped without interactivity.

Declaration
public void PopInteractively(Action completion = null)
Parameters
Type Name Description
System.Action completion

PopTo(CanvasController, Boolean, Action)

Pop to a specific viewController in the stack. The top view controller will be transitioned off-screen and subsequently destroyed. Any intermediary view controllers will be hidden prior to transition and subsequently destroyed on completion.

Declaration
public void PopTo(CanvasController viewController, bool animated = true, Action completion = null)
Parameters
Type Name Description
CanvasController viewController
System.Boolean animated
System.Action completion

PopToInteractively(CanvasController, Action)

Pop to a specific viewController in the stack interactively. The top view controller will be transitioned off-screen and subsequently destroyed. Any intermediary view controllers will be hidden prior to transition and subsequently destroyed on completion. Prior to calling this method, you should set the view controller's to an appropriate object. If no has been configured, the view controller(s) will be popped without interactivity.

Declaration
public void PopToInteractively(CanvasController viewController, Action completion = null)
Parameters
Type Name Description
CanvasController viewController
System.Action completion

PopToRoot(Boolean, Action)

Pop to the root view controller. The top view controller will be transitioned off-screen and subsequently destroyed. Any intermediary view controllers will be hidden prior to transition and subsequently destroyed on completion.

Declaration
public void PopToRoot(bool animated = true, Action completion = null)
Parameters
Type Name Description
System.Boolean animated
System.Action completion

PopToRootInteractively(Action)

Pop to the root view controller interactively. The top view controller will be transitioned off-screen and subsequently destroyed. Any intermediary view controllers will be hidden prior to transition and subsequently destroyed on completion. Prior to calling this method, you should set the view controller's to an appropriate object. If no has been configured, the view controller(s) will be popped without interactivity.

Declaration
public void PopToRootInteractively(Action completion = null)
Parameters
Type Name Description
System.Action completion

Push(CanvasController, Boolean, Action)

Push viewController onto the stack. The specified view controller will be added as a child view controller and its view will be added to the viewControllersContainer before being transitioned on-screen.

Declaration
public void Push(CanvasController viewController, bool animated = true, Action completion = null)
Parameters
Type Name Description
CanvasController viewController
System.Boolean animated
System.Action completion

PushInteractively(CanvasController, Action)

Push viewController onto the stack interactively. The specified view controller will be added as a child view controller and its view will be added to the viewControllersContainer before being transitioned on-screen interactively. Prior to calling this method, you should set the view controller's to an appropriate object. If no has been configured, this view controller will be pushed without interactivity.

Declaration
public void PushInteractively(CanvasController viewController, Action completion = null)
Parameters
Type Name Description
CanvasController viewController
System.Action completion

SetRoot(CanvasController, Boolean, Action)

Set the root view controller. Use this method to configure the stack controller's root view controller prior to presentation. Additionally, if the stack controller's view has already been loaded when this method is called, a replacement transition will be performed, unloading the existing stack of view controllers and transitioning to the new root view controller.

Declaration
public void SetRoot(CanvasController viewController, bool animated = false, Action completion = null)
Parameters
Type Name Description
CanvasController viewController
System.Boolean animated
System.Action completion

ShouldPerformGraphTransition(GraphTransition<CanvasController>, out Error)

Declaration
protected override bool ShouldPerformGraphTransition(GraphTransition<CanvasController> graphTransition, out Error error)
Parameters
Type Name Description
GraphTransition<CanvasController> graphTransition
Error error
Returns
Type Description
System.Boolean
Overrides
Pelican7.UIGraph.ViewController<Pelican7.UIGraph.CanvasController, Pelican7.UIGraph.CanvasView, Pelican7.UIGraph.CanvasWindow, Pelican7.UIGraph.CanvasViewResource, Pelican7.UIGraph.CanvasControllerTransition, Pelican7.UIGraph.CanvasControllerTransitionContext, Pelican7.UIGraph.CanvasControllerTransitionAnimatorProvider, Pelican7.UIGraph.ICanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerTransitionAnimationDriver, Pelican7.UIGraph.CanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerInvokeTransitionData, Pelican7.UIGraph.CanvasGraph>.ShouldPerformGraphTransition(Pelican7.UIGraph.GraphTransition<Pelican7.UIGraph.CanvasController>, Pelican7.UIGraph.Error)

ViewDidLoad()

Declaration
protected override void ViewDidLoad()
Overrides
Pelican7.UIGraph.ViewController<Pelican7.UIGraph.CanvasController, Pelican7.UIGraph.CanvasView, Pelican7.UIGraph.CanvasWindow, Pelican7.UIGraph.CanvasViewResource, Pelican7.UIGraph.CanvasControllerTransition, Pelican7.UIGraph.CanvasControllerTransitionContext, Pelican7.UIGraph.CanvasControllerTransitionAnimatorProvider, Pelican7.UIGraph.ICanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerTransitionAnimationDriver, Pelican7.UIGraph.CanvasControllerTransitionProgressProvider, Pelican7.UIGraph.CanvasControllerInvokeTransitionData, Pelican7.UIGraph.CanvasGraph>.ViewDidLoad()

Explicit Interface Implementations

IGraphableFieldProvider.GraphableFields

Declaration
GraphableField[] IGraphableFieldProvider.GraphableFields { get; }
Returns
Type Description
GraphableField[]

IGraphableFieldProvider.SetGraphableFieldValue(String, IGraphable[])

Declaration
void IGraphableFieldProvider.SetGraphableFieldValue(string fieldName, IGraphable[] graphables)
Parameters
Type Name Description
System.String fieldName
IGraphable[] graphables

Implements

See Also