Class SceneTransitionService

Inheritance

Object

BaseService

BaseExtensionService

SceneTransitionService

Implements

ISceneTransitionService

IMixedRealityExtensionService

IMixedRealityService

IDisposable

Inherited Members

BaseExtensionService.Registrar

BaseService.DefaultPriority

BaseService.Name

BaseService.Priority

BaseService.ConfigurationProfile

BaseService.Reset()

BaseService.Update()

BaseService.LateUpdate()

BaseService.Disable()

BaseService.disposed

BaseService.Dispose()

BaseService.Dispose(Boolean)

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Microsoft.MixedReality.Toolkit.Extensions.SceneTransitions

Assembly: cs.temp.dll.dll

Syntax

public class SceneTransitionService : BaseExtensionService, ISceneTransitionService, IMixedRealityExtensionService, IMixedRealityService, IDisposable

Constructors

SceneTransitionService(IMixedRealityServiceRegistrar, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

public SceneTransitionService(IMixedRealityServiceRegistrar registrar, string name, uint priority, BaseMixedRealityProfile profile)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the service.
String	name	Friendly name of the service.
UInt32	priority	Service priority. Used to determine order of instantiation.
BaseMixedRealityProfile	profile	The service's configuration profile.

SceneTransitionService(IMixedRealityServiceRegistrar, String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

public SceneTransitionService(IMixedRealityServiceRegistrar registrar, string name, uint priority, BaseMixedRealityProfile profile)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the service.
String	name	Friendly name of the service.
UInt32	priority	Service priority. Used to determine order of instantiation.
BaseMixedRealityProfile	profile	The service's configuration profile.

SceneTransitionService(String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

public SceneTransitionService(string name, uint priority, BaseMixedRealityProfile profile)

Parameters

Type	Name	Description
String	name	Friendly name of the service.
UInt32	priority	Service priority. Used to determine order of instantiation.
BaseMixedRealityProfile	profile	The service's configuration profile.

SceneTransitionService(String, UInt32, BaseMixedRealityProfile)

Constructor.

Declaration

public SceneTransitionService(string name, uint priority, BaseMixedRealityProfile profile)

Parameters

Type	Name	Description
String	name	Friendly name of the service.
UInt32	priority	Service priority. Used to determine order of instantiation.
BaseMixedRealityProfile	profile	The service's configuration profile.

Properties

FadeColor

Declaration

public Color FadeColor { get; set; }

Property Value

Type	Description
Color

FadeColor

Declaration

public Color FadeColor { get; set; }

Property Value

Type	Description
Color

FadeInTime

Declaration

public float FadeInTime { get; set; }

Property Value

Type	Description
Single

FadeInTime

Declaration

public float FadeInTime { get; set; }

Property Value

Type	Description
Single

FadeOutTime

Declaration

public float FadeOutTime { get; set; }

Property Value

Type	Description
Single

FadeOutTime

Declaration

public float FadeOutTime { get; set; }

Property Value

Type	Description
Single

FadeTargets

Declaration

public CameraFaderTargets FadeTargets { get; set; }

Property Value

Type	Description
CameraFaderTargets

FadeTargets

Declaration

public CameraFaderTargets FadeTargets { get; set; }

Property Value

Type	Description
CameraFaderTargets

OnTransitionCompleted

Declaration

public Action OnTransitionCompleted { get; set; }

Property Value

Type	Description
Action

OnTransitionCompleted

Declaration

public Action OnTransitionCompleted { get; set; }

Property Value

Type	Description
Action

OnTransitionStarted

Declaration

public Action OnTransitionStarted { get; set; }

Property Value

Type	Description
Action

OnTransitionStarted

Declaration

public Action OnTransitionStarted { get; set; }

Property Value

Type	Description
Action

TransitionInProgress

Declaration

public bool TransitionInProgress { get; set; }

Property Value

Type	Description
Boolean

TransitionInProgress

Declaration

public bool TransitionInProgress { get; set; }

Property Value

Type	Description
Boolean

TransitionProgress

Declaration

public float TransitionProgress { get; set; }

Property Value

Type	Description
Single

TransitionProgress

Declaration

public float TransitionProgress { get; set; }

Property Value

Type	Description
Single

UseFadeColor

Declaration

public bool UseFadeColor { get; set; }

Property Value

Type	Description
Boolean

UseFadeColor

Declaration

public bool UseFadeColor { get; set; }

Property Value

Type	Description
Boolean

Methods

Destroy()

Declaration

public override void Destroy()

Overrides

BaseService.Destroy()

Destroy()

Declaration

public override void Destroy()

Overrides

BaseService.Destroy()

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

Declaration

public 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)

Declaration

public 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)

Declaration

public Task DoSceneTransition(Func<Task> sceneOperation, IProgressIndicator progressIndicator = null)

Parameters

Type	Name	Description
Func<Task>	sceneOperation
IProgressIndicator	progressIndicator

Returns

Type	Description
Task

DoSceneTransition(Func<Task>, IProgressIndicator)

Declaration

public Task DoSceneTransition(Func<Task> sceneOperation, IProgressIndicator progressIndicator = null)

Parameters

Type	Name	Description
Func<Task>	sceneOperation
IProgressIndicator	progressIndicator

Returns

Type	Description
Task

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

Declaration

public Task DoSceneTransition(IEnumerable<Func<Task>> sceneOperations, IProgressIndicator progressIndicator = null)

Parameters

Type	Name	Description
IEnumerable<Func<Task>>	sceneOperations
IProgressIndicator	progressIndicator

Returns

Type	Description
Task

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

Declaration

public Task DoSceneTransition(IEnumerable<Func<Task>> sceneOperations, IProgressIndicator progressIndicator = null)

Parameters

Type	Name	Description
IEnumerable<Func<Task>>	sceneOperations
IProgressIndicator	progressIndicator

Returns

Type	Description
Task

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

Declaration

public Task DoSceneTransition(IEnumerable<Func<Task>> sceneOperations, float fadeOutTime, float fadeInTime, IProgressIndicator progressIndicator = null)

Parameters

Type	Name	Description
IEnumerable<Func<Task>>	sceneOperations
Single	fadeOutTime
Single	fadeInTime
IProgressIndicator	progressIndicator

Returns

Type	Description
Task

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

Declaration

public Task DoSceneTransition(IEnumerable<Func<Task>> sceneOperations, float fadeOutTime, float fadeInTime, IProgressIndicator progressIndicator = null)

Parameters

Type	Name	Description
IEnumerable<Func<Task>>	sceneOperations
Single	fadeOutTime
Single	fadeInTime
IProgressIndicator	progressIndicator

Returns

Type	Description
Task

Enable()

Declaration

public override void Enable()

Overrides

BaseService.Enable()

Enable()

Declaration

public override void Enable()

Overrides

BaseService.Enable()

FadeIn()

Declaration

public Task FadeIn()

Returns

Type	Description
Task

FadeIn()

Declaration

public Task FadeIn()

Returns

Type	Description
Task

FadeIn(Single)

Declaration

public Task FadeIn(float fadeInTime)

Parameters

Type	Name	Description
Single	fadeInTime

Returns

Type	Description
Task

FadeIn(Single)

Declaration

public Task FadeIn(float fadeInTime)

Parameters

Type	Name	Description
Single	fadeInTime

Returns

Type	Description
Task

FadeOut()

Declaration

public Task FadeOut()

Returns

Type	Description
Task

FadeOut()

Declaration

public Task FadeOut()

Returns

Type	Description
Task

FadeOut(Single)

Declaration

public Task FadeOut(float fadeOutTime)

Parameters

Type	Name	Description
Single	fadeOutTime

Returns

Type	Description
Task

FadeOut(Single)

Declaration

public Task FadeOut(float fadeOutTime)

Parameters

Type	Name	Description
Single	fadeOutTime

Returns

Type	Description
Task

HideProgressIndicator()

Declaration

public Task HideProgressIndicator()

Returns

Type	Description
Task

HideProgressIndicator()

Declaration

public Task HideProgressIndicator()

Returns

Type	Description
Task

Initialize()

Declaration

public override void Initialize()

Overrides

BaseService.Initialize()

Initialize()

Declaration

public override void Initialize()

Overrides

BaseService.Initialize()

SetCustomFadeTargetCameras(IEnumerable<Camera>)

Declaration

public void SetCustomFadeTargetCameras(IEnumerable<Camera> customFadeTargetCameras)

Parameters

Type	Name	Description
IEnumerable<Camera>	customFadeTargetCameras

SetCustomFadeTargetCameras(IEnumerable<Camera>)

Declaration

public void SetCustomFadeTargetCameras(IEnumerable<Camera> customFadeTargetCameras)

Parameters

Type	Name	Description
IEnumerable<Camera>	customFadeTargetCameras

SetProgressMessage(String)

Declaration

public void SetProgressMessage(string message)

Parameters

Type	Name	Description
String	message

SetProgressMessage(String)

Declaration

public void SetProgressMessage(string message)

Parameters

Type	Name	Description
String	message

SetProgressValue(Single)

Declaration

public void SetProgressValue(float progress)

Parameters

Type	Name	Description
Single	progress

SetProgressValue(Single)

Declaration

public void SetProgressValue(float progress)

Parameters

Type	Name	Description
Single	progress

ShowDefaultProgressIndicator()

Declaration

public Transform ShowDefaultProgressIndicator()

Returns

Type	Description
Transform

ShowDefaultProgressIndicator()

Declaration

public Transform ShowDefaultProgressIndicator()

Returns

Type	Description
Transform

Implements

ISceneTransitionService

IMixedRealityExtensionService

IMixedRealityService

IDisposable