Class TabBarCanvasController

The TabBarCanvasController is a container view controller designed for switching between content screens with a tab bar interface. It manages a list of content view controllers and offers transitions, in addition to a tab bar interface, for switching between the currently selected/visible view controller.

By default, the TabBarCanvasController instantiates its tab bar items upon load depending upon its list of content view controllers. You may provide a custom tab bar item prefab to be used. Additionally, tab bar items can be predefined or instantiated manually from script.

The first time a content view controller is shown, it is instantiated and embedded within the viewControllersContainer transform. Content view controllers are not unloaded until the tab bar itself is unloaded.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.ScriptableObject
ViewController<CanvasController, CanvasView, CanvasWindow, CanvasViewResource, CanvasControllerTransition, CanvasControllerTransitionContext, CanvasControllerTransitionAnimatorProvider, ICanvasControllerTransitionProgressProvider, CanvasControllerTransitionAnimationDriver, CanvasControllerTransitionProgressProvider, CanvasControllerInvokeTransitionData, CanvasGraph>
CanvasController
TabBarCanvasController
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 TabBarCanvasController : CanvasController, IViewControllerAppearance, IAppearable, ITransitionContextViewController, IGraphableTransitionViewObjectContainer, IGraphableTransitionInvoker, IGraphableEmbedContainer, IGraphableFieldProvider, IGraphable

Fields

animateTransitionOnTabBarItemSelection

Animate the transition on tab bar item selection? If true, the transition when selecting a tab bar item will be animated.

Declaration
public bool animateTransitionOnTabBarItemSelection
Field Value
Type Description
System.Boolean

blockSelectionWhilstInTransition

Block selection whilst in transition? If true, attempting to change the selected index whilst already transitioning the selected index will be blocked. Note that this is only relevant when animating the selection.

Declaration
public bool blockSelectionWhilstInTransition
Field Value
Type Description
System.Boolean

itemProvider

Assign an item provider to provide tab bar items to the tab bar from script. If null, the necessary items are instantiated by the tab bar using its item template.

Declaration
public ITabBarCanvasControllerItemProvider itemProvider
Field Value
Type Description
ITabBarCanvasControllerItemProvider

SetSelectedIndexTransition

The transition identifier for the Tab Bar Canvas Controller's Set Selected Index transition.

Declaration
public static readonly ViewControllerTransitionIdentifier SetSelectedIndexTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

SetSelectedViewControllerTransition

The transition identifier for the Tab Bar Canvas Controller's Set Selected View Controller transition.

Declaration
public static readonly ViewControllerTransitionIdentifier SetSelectedViewControllerTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

SetViewControllersTransition

The transition identifier for the Tab Bar Canvas Controller's Set View Controllers transition.

Declaration
public static readonly ViewControllerTransitionIdentifier SetViewControllersTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

tabBar

The tab bar used for switching the tab bar controller's selected view controller.

Declaration
public CanvasTabBar tabBar
Field Value
Type Description
CanvasTabBar

viewControllersContainer

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

Declaration
protected RectTransform viewControllersContainer
Field Value
Type Description
UnityEngine.RectTransform

Properties

SelectedIndex

Retrieve the currently selected index.

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

SelectedViewController

Retrieve the currently selected view controller.

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

ViewControllers

Retrieve the list of view controllers currently displayed by the tab bar controller.

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

Methods

CanSelectIndex(Int32, out Error)

Can index currently be selected by the tab bar controller?

Declaration
public bool CanSelectIndex(int index, out Error error)
Parameters
Type Name Description
System.Int32 index
Error error
Returns
Type Description
System.Boolean

True if the index can be selected. False otherwise.

CanSelectViewController(CanvasController, out Error)

Can viewController currently be selected by the tab bar controller?

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

True if the view controller can be selected. False otherwise.

CanSetViewControllers(CanvasController[], out Error)

Can the tab bar controller's ViewControllers list currently be set to viewControllers?

Declaration
public bool CanSetViewControllers(CanvasController[] viewControllers, out Error error)
Parameters
Type Name Description
CanvasController[] viewControllers
Error error
Returns
Type Description
System.Boolean

True if the list of view controllers can be set. 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)

SetSelectedIndex(Int32, Boolean, Action)

Set the tab bar controller's selected index. This shows the view controller in the ViewControllers list at index index.

Declaration
public void SetSelectedIndex(int index, bool animated = false, Action completion = null)
Parameters
Type Name Description
System.Int32 index
System.Boolean animated
System.Action completion

SetSelectedViewController(CanvasController, Boolean, Action)

Set the tab bar controller's selected view controller. viewController must be a view controller in the ViewControllers list.

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

SetViewControllers(CanvasController[], Boolean, Action)

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

Declaration
public void SetViewControllers(CanvasController[] viewControllers, bool animated = false, Action completion = null)
Parameters
Type Name Description
CanvasController[] viewControllers
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