Interface ISceneTransitionService

Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Extensions.SceneTransitions
Assembly: cs.temp.dll.dll
Syntax
public interface ISceneTransitionService : IMixedRealityExtensionService, IMixedRealityService, IDisposable

Properties

FadeColor

The color to use when fading out.

Declaration
Color FadeColor { get; set; }
Property Value
Type Description
Color

FadeColor

The color to use when fading out.

Declaration
Color FadeColor { get; set; }
Property Value
Type Description
Color

FadeInTime

The default time in seconds for fade in to complete.

Declaration
float FadeInTime { get; set; }
Property Value
Type Description
Single

FadeInTime

The default time in seconds for fade in to complete.

Declaration
float FadeInTime { get; set; }
Property Value
Type Description
Single

FadeOutTime

The default time in seconds for fade out to complete.

Declaration
float FadeOutTime { get; set; }
Property Value
Type Description
Single

FadeOutTime

The default time in seconds for fade out to complete.

Declaration
float FadeOutTime { get; set; }
Property Value
Type Description
Single

FadeTargets

Which cameras to target when fading.

Declaration
CameraFaderTargets FadeTargets { get; set; }
Property Value
Type Description
CameraFaderTargets

FadeTargets

Which cameras to target when fading.

Declaration
CameraFaderTargets FadeTargets { get; set; }
Property Value
Type Description
CameraFaderTargets

OnTransitionCompleted

Called when transition ends. This is called at the end of a transition, not at the end of a scene load. For scene load events, we recommend using IMixedRealitySceneSystem.

Declaration
Action OnTransitionCompleted { get; set; }
Property Value
Type Description
Action

OnTransitionCompleted

Called when transition ends. This is called at the end of a transition, not at the end of a scene load. For scene load events, we recommend using IMixedRealitySceneSystem.

Declaration
Action OnTransitionCompleted { get; set; }
Property Value
Type Description
Action

OnTransitionStarted

Called when transition starts. This is called at the beginning of a transition, not at the beginning of a scene load. For scene load events, we recommend using IMixedRealitySceneSystem.

Declaration
Action OnTransitionStarted { get; set; }
Property Value
Type Description
Action

OnTransitionStarted

Called when transition starts. This is called at the beginning of a transition, not at the beginning of a scene load. For scene load events, we recommend using IMixedRealitySceneSystem.

Declaration
Action OnTransitionStarted { get; set; }
Property Value
Type Description
Action

TransitionInProgress

True when a scene transition is in progress.

Declaration
bool TransitionInProgress { get; }
Property Value
Type Description
Boolean

TransitionInProgress

True when a scene transition is in progress.

Declaration
bool TransitionInProgress { get; }
Property Value
Type Description
Boolean

TransitionProgress

From 0 to 1

Declaration
float TransitionProgress { get; }
Property Value
Type Description
Single

TransitionProgress

From 0 to 1

Declaration
float TransitionProgress { get; }
Property Value
Type Description
Single

UseFadeColor

Whether to use a fade color during transitions.

Declaration
bool UseFadeColor { get; set; }
Property Value
Type Description
Boolean

UseFadeColor

Whether to use a fade color during transitions.

Declaration
bool UseFadeColor { get; set; }
Property Value
Type Description
Boolean

Methods

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

Declaration
Task DoSceneTransition(Func<Task> sceneOp1, Func<Task> sceneOp2, IProgressIndicator progressIndicator = null)
Parameters
Type Name Description
Func<Task> sceneOp1
Func<Task> sceneOp2
IProgressIndicator progressIndicator
Returns
Type Description
Task

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

Declaration
Task DoSceneTransition(Func<Task> sceneOp1, Func<Task> sceneOp2, IProgressIndicator progressIndicator = null)
Parameters
Type Name Description
Func<Task> sceneOp1
Func<Task> sceneOp2
IProgressIndicator progressIndicator
Returns
Type Description
Task

DoSceneTransition(Func<Task>, IProgressIndicator)

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

Declaration
Task DoSceneTransition(Func<Task> sceneOperation, IProgressIndicator progressIndicator = null)
Parameters
Type Name Description
Func<Task> sceneOperation
IProgressIndicator progressIndicator

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

DoSceneTransition(Func<Task>, IProgressIndicator)

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

Declaration
Task DoSceneTransition(Func<Task> sceneOperation, IProgressIndicator progressIndicator = null)
Parameters
Type Name Description
Func<Task> sceneOperation
IProgressIndicator progressIndicator

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

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

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

Declaration
Task DoSceneTransition(IEnumerable<Func<Task>> sceneOperations, IProgressIndicator progressIndicator = null)
Parameters
Type Name Description
IEnumerable<Func<Task>> sceneOperations

A set of tasks from the Scene System.
IProgressIndicator progressIndicator

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

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

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

Declaration
Task DoSceneTransition(IEnumerable<Func<Task>> sceneOperations, IProgressIndicator progressIndicator = null)
Parameters
Type Name Description
IEnumerable<Func<Task>> sceneOperations

A set of tasks from the Scene System.
IProgressIndicator progressIndicator

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

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

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

Declaration
Task DoSceneTransition(IEnumerable<Func<Task>> sceneOperations, float fadeOutTime, float fadeInTime, IProgressIndicator progressIndicator = null)
Parameters
Type Name Description
IEnumerable<Func<Task>> sceneOperations

A set of tasks from the Scene System.
Single fadeOutTime

Overrides the default FadeOutTIme value.
Single fadeInTime

Overrides the default FadeInTime value.
IProgressIndicator progressIndicator

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

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

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

Declaration
Task DoSceneTransition(IEnumerable<Func<Task>> sceneOperations, float fadeOutTime, float fadeInTime, IProgressIndicator progressIndicator = null)
Parameters
Type Name Description
IEnumerable<Func<Task>> sceneOperations

A set of tasks from the Scene System.
Single fadeOutTime

Overrides the default FadeOutTIme value.
Single fadeInTime

Overrides the default FadeInTime value.
IProgressIndicator progressIndicator

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

FadeIn()

Fades target cameras in. Instant fade-out will occur if fade state is not opaque. Can be used independently of scene transitions provided no transition is taking place. Uses default FadeInTime.

Declaration
Task FadeIn()
Returns
Type Description
Task

FadeIn()

Fades target cameras in. Instant fade-out will occur if fade state is not opaque. Can be used independently of scene transitions provided no transition is taking place. Uses default FadeInTime.

Declaration
Task FadeIn()
Returns
Type Description
Task

FadeIn(Single)

Fades target cameras in. Instant fade-out will occur if fade state is not opaque. Can be used independently of scene transitions provided no transition is taking place.

Declaration
Task FadeIn(float fadeInTime)
Parameters
Type Name Description
Single fadeInTime
Returns
Type Description
Task

FadeIn(Single)

Fades target cameras in. Instant fade-out will occur if fade state is not opaque. Can be used independently of scene transitions provided no transition is taking place.

Declaration
Task FadeIn(float fadeInTime)
Parameters
Type Name Description
Single fadeInTime
Returns
Type Description
Task

FadeOut()

Fades target cameras out to color. Can be used independently of scene transitions provided no transition is taking place. Uses default FadeOutTime.

Declaration
Task FadeOut()
Returns
Type Description
Task

FadeOut()

Fades target cameras out to color. Can be used independently of scene transitions provided no transition is taking place. Uses default FadeOutTime.

Declaration
Task FadeOut()
Returns
Type Description
Task

FadeOut(Single)

Fades target cameras out to color. Can be used independently of scene transitions provided no transition is taking place.

Declaration
Task FadeOut(float fadeOutTime)
Parameters
Type Name Description
Single fadeOutTime
Returns
Type Description
Task

FadeOut(Single)

Fades target cameras out to color. Can be used independently of scene transitions provided no transition is taking place.

Declaration
Task FadeOut(float fadeOutTime)
Parameters
Type Name Description
Single fadeOutTime
Returns
Type Description
Task

HideProgressIndicator()

Hides the default progress indicator. Task completes when hide animation is done. Can be used independently of scene transitions provided no transition is taking place.

Declaration
Task HideProgressIndicator()
Returns
Type Description
Task

HideProgressIndicator()

Hides the default progress indicator. Task completes when hide animation is done. Can be used independently of scene transitions provided no transition is taking place.

Declaration
Task HideProgressIndicator()
Returns
Type Description
Task

SetCustomFadeTargetCameras(IEnumerable<Camera>)

If FadeTargets is set to custom, you will need to provide a custom set of cameras for fading using this function PRIOR to calling DoSceneTransition.

Declaration
void SetCustomFadeTargetCameras(IEnumerable<Camera> customFadeTargetCameras)
Parameters
Type Name Description
IEnumerable<Camera> customFadeTargetCameras

SetCustomFadeTargetCameras(IEnumerable<Camera>)

If FadeTargets is set to custom, you will need to provide a custom set of cameras for fading using this function PRIOR to calling DoSceneTransition.

Declaration
void SetCustomFadeTargetCameras(IEnumerable<Camera> customFadeTargetCameras)
Parameters
Type Name Description
IEnumerable<Camera> customFadeTargetCameras

SetProgressMessage(String)

Sets the message on displayed progress indicator. If no progress indicator exists, has no effect.

Declaration
void SetProgressMessage(string message)
Parameters
Type Name Description
String message

SetProgressMessage(String)

Sets the message on displayed progress indicator. If no progress indicator exists, has no effect.

Declaration
void SetProgressMessage(string message)
Parameters
Type Name Description
String message

SetProgressValue(Single)

Sets progress to value from 0-1. If no progress indicator exists, has no effect.

Declaration
void SetProgressValue(float progress)
Parameters
Type Name Description
Single progress

SetProgressValue(Single)

Sets progress to value from 0-1. If no progress indicator exists, has no effect.

Declaration
void SetProgressValue(float progress)
Parameters
Type Name Description
Single progress

ShowDefaultProgressIndicator()

Instantiates the default progress indicator and returns its main transform. Can be used independently of scene transitions provided no transition is taking place.

Declaration
Transform ShowDefaultProgressIndicator()
Returns
Type Description
Transform

ShowDefaultProgressIndicator()

Instantiates the default progress indicator and returns its main transform. Can be used independently of scene transitions provided no transition is taking place.

Declaration
Transform ShowDefaultProgressIndicator()
Returns
Type Description
Transform