SceneTransitionService.DoSceneTransition Method

Definition

Overloads

DoSceneTransition(IEnumerable<Func<Task>>, IProgressIndicator)

Fades out, enables progress indicator, execute scene operations in order, disables progress indicator, fades back in

DoSceneTransition(Func<Task>, IProgressIndicator)

Fades out, enables progress indicator, execute scene operation, disables progress indicator, fades back in

DoSceneTransition(Func<Task>, Func<Task>, IProgressIndicator)

Fades out, enables progress indicator, executes scene op 1, executes scene op 2, disables progress indicator, fades back in

DoSceneTransition(IEnumerable<Func<Task>>, Single, Single, IProgressIndicator)

Fades out, enables progress indicator, execute scene operations in order, disables progress indicator, fades back in

DoSceneTransition(IEnumerable<Func<Task>>, IProgressIndicator)

Fades out, enables progress indicator, execute scene operations in order, disables progress indicator, fades back in

C#
public System.Threading.Tasks.Task DoSceneTransition (System.Collections.Generic.IEnumerable<Func<System.Threading.Tasks.Task>> sceneOperations, Microsoft.MixedReality.Toolkit.UI.IProgressIndicator progressIndicator = default);

Parameters

sceneOperations
IEnumerable<Func<Task>>

A set of tasks from the Scene System.

progressIndicator
IProgressIndicator

If null, default progress indicator prefab will be used (or none if default is disabled in profile)

Returns

Implements

Applies to

MRTK2 Unity 2018 2.7.0 and other versions
Product Versions
MRTK2 Unity 2018 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0
MRTK2 Unity 2019 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0
MRTK2 Unity 2020 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0

DoSceneTransition(Func<Task>, IProgressIndicator)

Fades out, enables progress indicator, execute scene operation, disables progress indicator, fades back in

C#
public System.Threading.Tasks.Task DoSceneTransition (Func<System.Threading.Tasks.Task> sceneOperation, Microsoft.MixedReality.Toolkit.UI.IProgressIndicator progressIndicator = default);

Parameters

sceneOperation
Func<Task>
progressIndicator
IProgressIndicator

If null, default progress indicator prefab will be used (or none if default is disabled in profile)

Returns

Implements

Applies to

MRTK2 Unity 2018 2.7.0 and other versions
Product Versions
MRTK2 Unity 2018 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0
MRTK2 Unity 2019 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0
MRTK2 Unity 2020 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0

DoSceneTransition(Func<Task>, Func<Task>, IProgressIndicator)

Fades out, enables progress indicator, executes scene op 1, executes scene op 2, disables progress indicator, fades back in

C#
public System.Threading.Tasks.Task DoSceneTransition (Func<System.Threading.Tasks.Task> sceneOp1, Func<System.Threading.Tasks.Task> sceneOp2, Microsoft.MixedReality.Toolkit.UI.IProgressIndicator progressIndicator = default);

Parameters

sceneOp1
Func<Task>
sceneOp2
Func<Task>
progressIndicator
IProgressIndicator

Returns

Implements

Applies to

MRTK2 Unity 2018 2.7.0 and other versions
Product Versions
MRTK2 Unity 2018 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0
MRTK2 Unity 2019 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0
MRTK2 Unity 2020 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0

DoSceneTransition(IEnumerable<Func<Task>>, Single, Single, IProgressIndicator)

Fades out, enables progress indicator, execute scene operations in order, disables progress indicator, fades back in

C#
public System.Threading.Tasks.Task DoSceneTransition (System.Collections.Generic.IEnumerable<Func<System.Threading.Tasks.Task>> sceneOperations, float fadeOutTime, float fadeInTime, Microsoft.MixedReality.Toolkit.UI.IProgressIndicator progressIndicator = default);

Parameters

sceneOperations
IEnumerable<Func<Task>>

A set of tasks from the Scene System.

fadeOutTime
Single

Overrides the default FadeOutTIme value.

fadeInTime
Single

Overrides the default FadeInTime value.

progressIndicator
IProgressIndicator

If null, default progress indicator prefab will be used (or none if default is disabled in profile)

Returns

Implements

Applies to

MRTK2 Unity 2018 2.7.0 and other versions
Product Versions
MRTK2 Unity 2018 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0
MRTK2 Unity 2019 2.5.0, 2.5.1, 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0
MRTK2 Unity 2020 2.5.2, 2.5.3, 2.5.4, 2.6.0, 2.7.0, 2.8.0