Class SplitCanvasController

The SplitCanvasController is a container view controller designed for presenting two screens alongside one other. It manages two child view controllers – MainViewController and SecondaryViewController. It offers transitions for replacing the main and secondary view controllers, as well as showing and hiding the SecondaryViewController. The child view controllers fill their respective containers, mainViewControllerContainer and secondaryViewControllerContainer.

Replacing the main or secondary view controllers instantiates and embeds the provided view controller in the appropriate container, MainViewController and SecondaryViewController. Hiding the secondary view controller only hides it, it does not unload it.

The SplitCanvasController uses a SplitCanvasPositioning component to determine the position of its two content view controllers in each state – Secondary Visible and Secondary Hidden. Use the relevant transform objects to configure the placement of the main and secondary view controllers in each state. By default, the split controller uses a bespoke transition animation to animate the SecondaryViewController visibility transition, interpolating between the SplitCanvasPositioning component's two states.

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

Fields

allowTransitionsToBeInterrupted

Allow transitions to be interrupted? If true, invoking one of the split view controller's transitions whilst it is already in progress will cancel the current transition before starting a new transition. If false, invoking one of the split view controller's transitions whilst it is already in progress will be blocked.

Declaration
public bool allowTransitionsToBeInterrupted
Field Value
Type Description
System.Boolean

hideSecondaryOnSetMain

Hide the secondary view controller when main is set? If enabled, the secondary view controller will be hidden if visible when a SetMain transition is invoked.

Declaration
public bool hideSecondaryOnSetMain
Field Value
Type Description
System.Boolean

HideSecondaryViewControllerTransition

The transition identifier for the Split Canvas Controller's Hide Secondary transition.

Declaration
public static readonly ViewControllerTransitionIdentifier HideSecondaryViewControllerTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

mainViewControllerContainer

The container into which the split controller will place its MainViewController.

Declaration
public RectTransform mainViewControllerContainer
Field Value
Type Description
UnityEngine.RectTransform

secondaryViewControllerContainer

The container into which the split controller will place its SecondaryViewController.

Declaration
public RectTransform secondaryViewControllerContainer
Field Value
Type Description
UnityEngine.RectTransform

secondaryViewControllerIsVisibleOnLoad

Is the secondary view controller visible on load? If enabled the secondary view controller will be made visible on load, otherwise it will be hidden.

Declaration
public bool secondaryViewControllerIsVisibleOnLoad
Field Value
Type Description
System.Boolean

SetMainViewControllerTransition

The transition identifier for the Split Canvas Controller's Set Main transition.

Declaration
public static readonly ViewControllerTransitionIdentifier SetMainViewControllerTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

SetSecondaryViewControllerTransition

The transition identifier for the Split Canvas Controller's Set Secondary transition.

Declaration
public static readonly ViewControllerTransitionIdentifier SetSecondaryViewControllerTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

ShowSecondaryViewControllerTransition

The transition identifier for the Split Canvas Controller's Show Secondary transition.

Declaration
public static readonly ViewControllerTransitionIdentifier ShowSecondaryViewControllerTransition
Field Value
Type Description
ViewControllerTransitionIdentifier

splitPositioning

The split controller's split positioning component. This component is responsible for determining the layout of the main and secondary containers in each configuration - Secondary Visible and Secondary Hidden.

Declaration
public SplitCanvasPositioning splitPositioning
Field Value
Type Description
SplitCanvasPositioning

Properties

MainViewController

The split controller's main view controller.

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

SecondaryViewController

The split controller's secondary view controller.

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

SecondaryViewControllerIsVisible

Is the secondary view controller currently visible?

Declaration
public bool SecondaryViewControllerIsVisible { get; }
Property Value
Type Description
System.Boolean
See Also

Methods

CanSetMainViewController(CanvasController, out Error)

Can the split controller set its MainViewController to viewController?

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

True if the split controller can set its MainViewController to viewController. False otherwise.

CanSetSecondaryViewController(CanvasController, out Error)

Can the split controller set its SecondaryViewController to viewController?

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

True if the split controller can set its SecondaryViewController to viewController. False otherwise.

CanToggleSecondaryViewControllerVisibility(Boolean, out Error)

Can the split view controller toggle its SecondaryViewController visibility?

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

True if the split controller can toggle its SecondaryViewController visibility. 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()

HideSecondaryViewController(Boolean, Action)

Hide the split controller's secondary view controller.

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

HideSecondaryViewControllerInteractively(Action)

Hide the split controller's secondary view controller. Prior to calling this method, you should set the view controller's to an appropriate object. If no has been configured, the secondary view controller will be hidden without interactivity.

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

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)

SetMainViewController(CanvasController, Boolean, Action)

Set the split controller's main view controller. viewController will be added as a child view controller and its view placed in the mainViewControllerContainer. Use this method to configure the split controller's main view controller prior to presentation. Additionally, if the split controller's view has already been loaded when this method is called, a replacement transition will be performed, unloading the current main view controller and transitioning to the new one.

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

SetSecondaryViewController(CanvasController, Boolean, Action)

Set the split controller's secondary view controller. viewController will be added as a child view controller and its view placed in the secondaryViewControllerContainer. Use this method to configure the split controller's secondary view controller prior to presentation. Additionally, if the split controller's view has already been loaded when this method is called, a replacement transition will be performed, unloading the current secondary view controller and transitioning to the new one.

Declaration
public void SetSecondaryViewController(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)

ShowSecondaryViewController(Boolean, Action)

Show the split controller's secondary view controller.

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

ShowSecondaryViewControllerInteractively(Action)

Show the split controller's secondary view controller interactively. Prior to calling this method, you should set the view controller's to an appropriate object. If no has been configured, the secondary view controller will be shown without interactivity.

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

ToggleSecondaryViewControllerVisibility(Boolean)

A view callback for toggling the SecondaryViewController visibility. This method calls ToggleSecondaryViewControllerVisibility(Boolean, Action).

Declaration
public void ToggleSecondaryViewControllerVisibility(bool animated)
Parameters
Type Name Description
System.Boolean animated

ToggleSecondaryViewControllerVisibility(Boolean, Action)

Toggle the SecondaryViewController visibility. A convenience method for calling either ShowSecondaryViewController(Boolean, Action) or HideSecondaryViewController(Boolean, Action) depending upon that state of SecondaryViewControllerIsVisible.

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

ToggleSecondaryViewControllerVisibilityInteractively(Action)

Toggle the SecondaryViewController visibility. A convenience method for calling either ShowSecondaryViewControllerInteractively(Action) or HideSecondaryViewControllerInteractively(Action) depending upon that state of SecondaryViewControllerIsVisible.

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

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