Class ViewControllerTransition<TViewController, TTransition, TTransitionContext, TTransitionAnimatorProvider, TTransitionProgressProvider, TTransitionAnimationDriver, TTransitionAnimationDefaultProgressProvider>

When a view controller transition is to be performed, UI Graph creates a transition object to describe the transition. This object is passed to methods that require it, such as PrepareForGraphTransition(GraphTransition<TViewController>), providing you with the relevant transition information.

You will never interface directly with an instance of this class. Instead you will be given a concrete subclass, CanvasControllerTransition or ElementsControllerTransition, depending upon the workflow you are using.

Inheritance

System.Object

ViewControllerTransition<TViewController, TTransition, TTransitionContext, TTransitionAnimatorProvider, TTransitionProgressProvider, TTransitionAnimationDriver, TTransitionAnimationDefaultProgressProvider>

CanvasControllerTransition

ElementsControllerTransition

Implements

IViewControllerTransitionAnimationDriverResponder

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Pelican7.UIGraph

Assembly: UI Graph API Documentation Project.dll

Syntax

public abstract class ViewControllerTransition<TViewController, TTransition, TTransitionContext, TTransitionAnimatorProvider, TTransitionProgressProvider, TTransitionAnimationDriver, TTransitionAnimationDefaultProgressProvider> : IViewControllerTransitionAnimationDriverResponder where TTransition : ViewControllerTransition<TViewController, TTransition, TTransitionContext, TTransitionAnimatorProvider, TTransitionProgressProvider, TTransitionAnimationDriver, TTransitionAnimationDefaultProgressProvider> where TTransitionContext : ITransitionContext where TTransitionAnimatorProvider : class, IViewControllerTransitionAnimatorProvider<TTransitionContext> where TTransitionProgressProvider : class, IViewControllerTransitionProgressProvider<TTransitionContext> where TTransitionAnimationDriver : ViewControllerTransitionAnimationDriver<TTransitionContext, TTransitionAnimationDefaultProgressProvider>, new()
    where TTransitionAnimationDefaultProgressProvider : class, IViewControllerTransitionProgressProvider<TTransitionContext>, new()

Type Parameters

Name	Description
TViewController
TTransition
TTransitionContext
TTransitionAnimatorProvider
TTransitionProgressProvider
TTransitionAnimationDriver
TTransitionAnimationDefaultProgressProvider

Fields

context

Declaration

protected TTransitionContext context

Field Value

Type	Description
TTransitionContext

OnTransitionBegan

Declaration

public ViewControllerTransition<TViewController, TTransition, TTransitionContext, TTransitionAnimatorProvider, TTransitionProgressProvider, TTransitionAnimationDriver, TTransitionAnimationDefaultProgressProvider>.ViewControllerTransitionBeganEvent OnTransitionBegan

Field Value

Type	Description
ViewControllerTransition.ViewControllerTransitionBeganEvent<>

OnTransitionDidFinish

Declaration

public ViewControllerTransition<TViewController, TTransition, TTransitionContext, TTransitionAnimatorProvider, TTransitionProgressProvider, TTransitionAnimationDriver, TTransitionAnimationDefaultProgressProvider>.ViewControllerTransitionFinishedEvent OnTransitionDidFinish

Field Value

Type	Description
ViewControllerTransition.ViewControllerTransitionFinishedEvent<>

OnTransitionProgressUpdated

Declaration

public ViewControllerTransition<TViewController, TTransition, TTransitionContext, TTransitionAnimatorProvider, TTransitionProgressProvider, TTransitionAnimationDriver, TTransitionAnimationDefaultProgressProvider>.ViewControllerTransitionProgressEvent OnTransitionProgressUpdated

Field Value

Type	Description
ViewControllerTransition.ViewControllerTransitionProgressEvent<>

OnTransitionWillFinish

Declaration

public ViewControllerTransition<TViewController, TTransition, TTransitionContext, TTransitionAnimatorProvider, TTransitionProgressProvider, TTransitionAnimationDriver, TTransitionAnimationDefaultProgressProvider>.ViewControllerTransitionFinishedEvent OnTransitionWillFinish

Field Value

Type	Description
ViewControllerTransition.ViewControllerTransitionFinishedEvent<>

Properties

Animator

The transition's animator, as provided by the owning view controller's transitionAnimatorProvider

Declaration

public IViewControllerTransitionAnimator<TTransitionContext> Animator { get; }

Property Value

Type	Description
IViewControllerTransitionAnimator<TTransitionContext>

Context

The transition's context. The context provides detailed information about the transition, such as the view controllers involved.

Declaration

public TTransitionContext Context { get; }

Property Value

Type	Description
TTransitionContext

InteractiveTransitionProgressProvider

Declaration

protected abstract TTransitionProgressProvider InteractiveTransitionProgressProvider { get; }

Property Value

Type	Description
TTransitionProgressProvider

TransitionAnimatorProvider

Declaration

protected abstract TTransitionAnimatorProvider TransitionAnimatorProvider { get; }

Property Value

Type	Description
TTransitionAnimatorProvider

Methods

ForceImmediateCancellation()

Declaration

public void ForceImmediateCancellation()

ForceImmediateCompletion()

Declaration

public void ForceImmediateCompletion()

Initialize(ViewControllerTransitionIdentifier, TViewController, TViewController, TViewController, Boolean, Boolean, Stack<TViewController>)

Declaration

public abstract void Initialize(ViewControllerTransitionIdentifier identifier, TViewController toViewController, TViewController fromViewController, TViewController ownerViewController, bool animated, bool interactive, Stack<TViewController> intermediaryViewControllers = null)

Parameters

Type	Name	Description
ViewControllerTransitionIdentifier	identifier
TViewController	toViewController
TViewController	fromViewController
TViewController	ownerViewController
System.Boolean	animated
System.Boolean	interactive
System.Collections.Generic.Stack<TViewController>	intermediaryViewControllers

Perform(UnityAction<TTransition>, UnityAction<TTransition, Boolean>, UnityAction<TTransition, Boolean>)

Declaration

public void Perform(UnityAction<TTransition> OnTransitionBegan = null, UnityAction<TTransition, bool> OnTransitionWillFinish = null, UnityAction<TTransition, bool> OnTransitionDidFinish = null)

Parameters

Type	Name	Description
UnityEngine.Events.UnityAction<TTransition>	OnTransitionBegan
UnityEngine.Events.UnityAction<TTransition, System.Boolean>	OnTransitionWillFinish
UnityEngine.Events.UnityAction<TTransition, System.Boolean>	OnTransitionDidFinish

Explicit Interface Implementations

IViewControllerTransitionAnimationDriverResponder.OnDriverCancelled()

Declaration

void IViewControllerTransitionAnimationDriverResponder.OnDriverCancelled()

IViewControllerTransitionAnimationDriverResponder.OnDriverCompleted()

Declaration

void IViewControllerTransitionAnimationDriverResponder.OnDriverCompleted()

IViewControllerTransitionAnimationDriverResponder.OnDriverProgressUpdated(Single)

Declaration

void IViewControllerTransitionAnimationDriverResponder.OnDriverProgressUpdated(float progress01)

Parameters

Type	Name	Description
System.Single	progress01

Implements

IViewControllerTransitionAnimationDriverResponder