Class SceneTransitionCanvasController

Use a scene transition canvas controller to perform a transition from one scene to another.

Upon presentation, a scene transition canvas controller moves the current UI window to a standalone scene and ensures it renders on top of any subsequently loaded UI windows. It then unloads the current scene, loads the scene specified in sceneNameToLoad, and dismisses the window from which it was presented.

The scene transition canvas controller should be derived from by an existing canvas controller. You are responsible for configuring the sceneNameToLoad, which can be done statically in the inspector or dynamically upon instantiation, such as in PrepareForGraphTransition(GraphTransition<TViewController>).

You may override the PrepareSceneForUnload(Scene) and PrepareLoadedScene(Scene) methods to perform any additional unloading/loading requirements.

Ensure that any scene name specified has been added to Unity's 'Scenes In Build' in the Build Settings.

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

Fields

animateWindowDismissal

Should the window in which the SceneTransitionCanvasController resides be animated upon dismissal?

Declaration
public bool animateWindowDismissal
Field Value
Type Description
System.Boolean

sceneNameToLoad

The name of the scene to load. Ensure that any scene name specified has been added to Unity's 'Scenes In Build' in the Build Settings.

Declaration
public string sceneNameToLoad
Field Value
Type Description
System.String

Methods

Initialize(String)

Initialize the SceneTransitionCanvasController with a sceneNameToLoad.

Declaration
public virtual void Initialize(string sceneNameToLoad)
Parameters
Type Name Description
System.String sceneNameToLoad

PrepareLoadedScene(Scene)

Derived classes can override this method to perform any custom loading logic. This method is called with the newly loaded scene, prior to it becoming the active scene and the window being dismissed.

Declaration
protected virtual IEnumerator PrepareLoadedScene(Scene scene)
Parameters
Type Name Description
UnityEngine.SceneManagement.Scene scene
Returns
Type Description
System.Collections.IEnumerator

A yield instruction.

PrepareSceneForUnload(Scene)

Derived classes can override this method to perform any custom unloading logic. This method is called with the scene to be unloaded, prior to it being unloaded.

Declaration
protected virtual IEnumerator PrepareSceneForUnload(Scene scene)
Parameters
Type Name Description
UnityEngine.SceneManagement.Scene scene
Returns
Type Description
System.Collections.IEnumerator

A yield instruction.

ViewDidAppear()

Declaration
protected override void ViewDidAppear()
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>.ViewDidAppear()

Implements