Class TransitionSequenceAnimation<TViewController, TContext>

The abstract base type for animations to be used with the Transition Sequence Animator.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.ScriptableObject
TransitionSequenceAnimation<TViewController, TContext>
CanvasControllerTransitionSequenceAnimation
ElementsControllerTransitionSequenceAnimation
Implements
ISequencable<TContext>
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 abstract class TransitionSequenceAnimation<TViewController, TContext> : ScriptableObject, ISequencable<TContext>
Type Parameters
Name Description
TViewController
TContext

Fields

curve

The animation's curve.

Declaration
public AnimationCurve curve
Field Value
Type Description
UnityEngine.AnimationCurve

initializeWithZeroProgress

Initialize with zero progress? If enabled, the animation will be initialized with zero progress when the transition sequence begins, regardless of where the animation lies within the sequence. This can therefore be used to apply the animation with zero progress prior to the animation being reached in the sequence.

Declaration
public bool initializeWithZeroProgress
Field Value
Type Description
System.Boolean

transitionDirection

The animation's direction.

Declaration
public TransitionSequenceAnimation<TViewController, TContext>.Direction transitionDirection
Field Value
Type Description
TransitionSequenceAnimation.Direction<>

viewControllerIdentifier

The animation's view controller identifier. The TargetViewController will be configured with this view controller in InitializeWithContext(TContext).

Declaration
public TransitionSequenceAnimation<TViewController, TContext>.ViewControllerIdentifier viewControllerIdentifier
Field Value
Type Description
TransitionSequenceAnimation.ViewControllerIdentifier<>

Properties

EasedProgress01

The animation's eased progress. This is calculated using the curve field.

Declaration
protected float EasedProgress01 { get; }
Property Value
Type Description
System.Single

TargetViewController

The animation's target view controller. This is automatically populated with the view controller identified by viewControllerIdentifier.

Declaration
protected TViewController TargetViewController { get; }
Property Value
Type Description
TViewController

Methods

InitializeAnimationWithContext(TContext)

Override this method to perform any initialization your animation requires.

Declaration
public virtual void InitializeAnimationWithContext(TContext context)
Parameters
Type Name Description
TContext context

InitializeWithContext(TContext)

Declaration
public void InitializeWithContext(TContext context)
Parameters
Type Name Description
TContext context

OnTransitionFinished(Boolean)

Override this method to perform any clean up your animation requires, if necessary.

Declaration
public virtual void OnTransitionFinished(bool completed)
Parameters
Type Name Description
System.Boolean completed

TargetViewControllerForContext(TContext)

Declaration
protected abstract TViewController TargetViewControllerForContext(TContext context)
Parameters
Type Name Description
TContext context
Returns
Type Description
TViewController

UpdateProgress(Single)

Override this method to perform your animation with the supplied progress01.

Declaration
public virtual void UpdateProgress(float progress01)
Parameters
Type Name Description
System.Single progress01

Implements