Class MixedRealitySceneSystem

The default implementation of the IMixedRealitySceneSystem Because so much of this service's functionality is editor-only, it has been split into a partial class. This part handles the runtime parts of the service.

Inheritance

Object

BaseService

BaseEventSystem

BaseCoreSystem

MixedRealitySceneSystem

Implements

IMixedRealitySceneSystem

IMixedRealityEventSystem

IMixedRealityService

IDisposable

IMixedRealityEventSource

IEqualityComparer

IMixedRealitySceneSystemEditor

Inherited Members

BaseCoreSystem.Registrar

BaseEventSystem.enableDanglingHandlerDiagnostics

BaseEventSystem.EventHandlersByType

BaseEventSystem.EventListeners

BaseEventSystem.HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)

BaseEventSystem.RegisterHandler<T>(IEventSystemHandler)

BaseEventSystem.UnregisterHandler<T>(IEventSystemHandler)

BaseEventSystem.Register(GameObject)

BaseEventSystem.Unregister(GameObject)

BaseService.DefaultPriority

BaseService.Priority

BaseService.ConfigurationProfile

BaseService.Reset()

BaseService.LateUpdate()

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.SceneSystem

Assembly: cs.temp.dll.dll

Syntax

public class MixedRealitySceneSystem : BaseCoreSystem, IMixedRealitySceneSystem, IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityEventSource, IEqualityComparer, IMixedRealitySceneSystemEditor

Constructors

MixedRealitySceneSystem(IMixedRealityServiceRegistrar, MixedRealitySceneSystemProfile)

Constructor.

Declaration

public MixedRealitySceneSystem(IMixedRealityServiceRegistrar registrar, MixedRealitySceneSystemProfile profile)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealitySceneSystemProfile	profile	The configuration profile for the service.

MixedRealitySceneSystem(IMixedRealityServiceRegistrar, MixedRealitySceneSystemProfile)

Constructor.

Declaration

public MixedRealitySceneSystem(IMixedRealityServiceRegistrar registrar, MixedRealitySceneSystemProfile profile)

Parameters

Type	Name	Description
IMixedRealityServiceRegistrar	registrar	The IMixedRealityServiceRegistrar instance that loaded the service.
MixedRealitySceneSystemProfile	profile	The configuration profile for the service.

MixedRealitySceneSystem(MixedRealitySceneSystemProfile)

Constructor.

Declaration

public MixedRealitySceneSystem(MixedRealitySceneSystemProfile profile)

Parameters

Type	Name	Description
MixedRealitySceneSystemProfile	profile	The configuration profile for the service.

MixedRealitySceneSystem(MixedRealitySceneSystemProfile)

Constructor.

Declaration

public MixedRealitySceneSystem(MixedRealitySceneSystemProfile profile)

Parameters

Type	Name	Description
MixedRealitySceneSystemProfile	profile	The configuration profile for the service.

Properties

ActiveLightingScene

Declaration

public string ActiveLightingScene { get; }

Property Value

Type	Description
String

ActiveLightingScene

Declaration

public string ActiveLightingScene { get; }

Property Value

Type	Description
String

ContentSceneNames

Declaration

public string[] ContentSceneNames { get; }

Property Value

Type	Description
String[]

ContentSceneNames

Declaration

public string[] ContentSceneNames { get; }

Property Value

Type	Description
String[]

LightingOperationInProgress

Declaration

public bool LightingOperationInProgress { get; }

Property Value

Type	Description
Boolean

LightingOperationInProgress

Declaration

public bool LightingOperationInProgress { get; }

Property Value

Type	Description
Boolean

LightingOperationProgress

Declaration

public float LightingOperationProgress { get; }

Property Value

Type	Description
Single

LightingOperationProgress

Declaration

public float LightingOperationProgress { get; }

Property Value

Type	Description
Single

Name

Declaration

public override string Name { get; protected set; }

Property Value

Type	Description
String

Overrides

BaseService.Name

Name

Declaration

public override string Name { get; protected set; }

Property Value

Type	Description
String

Overrides

BaseService.Name

NextContentExists

Declaration

public bool NextContentExists { get; }

Property Value

Type	Description
Boolean

NextContentExists

Declaration

public bool NextContentExists { get; }

Property Value

Type	Description
Boolean

OnContentLoaded

Declaration

public BaseEventSystem.Action<IEnumerable<string>> OnContentLoaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<IEnumerable<String>>

OnContentLoaded

Declaration

public BaseEventSystem.Action<IEnumerable<string>> OnContentLoaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<IEnumerable<String>>

OnContentUnloaded

Declaration

public BaseEventSystem.Action<IEnumerable<string>> OnContentUnloaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<IEnumerable<String>>

OnContentUnloaded

Declaration

public BaseEventSystem.Action<IEnumerable<string>> OnContentUnloaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<IEnumerable<String>>

OnLightingLoaded

Declaration

public BaseEventSystem.Action<string> OnLightingLoaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnLightingLoaded

Declaration

public BaseEventSystem.Action<string> OnLightingLoaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnLightingUnloaded

Declaration

public BaseEventSystem.Action<string> OnLightingUnloaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnLightingUnloaded

Declaration

public BaseEventSystem.Action<string> OnLightingUnloaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnSceneLoaded

Declaration

public BaseEventSystem.Action<string> OnSceneLoaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnSceneLoaded

Declaration

public BaseEventSystem.Action<string> OnSceneLoaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnSceneUnloaded

Declaration

public BaseEventSystem.Action<string> OnSceneUnloaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnSceneUnloaded

Declaration

public BaseEventSystem.Action<string> OnSceneUnloaded { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnWillLoadContent

Declaration

public BaseEventSystem.Action<IEnumerable<string>> OnWillLoadContent { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<IEnumerable<String>>

OnWillLoadContent

Declaration

public BaseEventSystem.Action<IEnumerable<string>> OnWillLoadContent { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<IEnumerable<String>>

OnWillLoadLighting

Declaration

public BaseEventSystem.Action<string> OnWillLoadLighting { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnWillLoadLighting

Declaration

public BaseEventSystem.Action<string> OnWillLoadLighting { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnWillLoadScene

Declaration

public BaseEventSystem.Action<string> OnWillLoadScene { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnWillLoadScene

Declaration

public BaseEventSystem.Action<string> OnWillLoadScene { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnWillUnloadContent

Declaration

public BaseEventSystem.Action<IEnumerable<string>> OnWillUnloadContent { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<IEnumerable<String>>

OnWillUnloadContent

Declaration

public BaseEventSystem.Action<IEnumerable<string>> OnWillUnloadContent { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<IEnumerable<String>>

OnWillUnloadLighting

Declaration

public BaseEventSystem.Action<string> OnWillUnloadLighting { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnWillUnloadLighting

Declaration

public BaseEventSystem.Action<string> OnWillUnloadLighting { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnWillUnloadScene

Declaration

public BaseEventSystem.Action<string> OnWillUnloadScene { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

OnWillUnloadScene

Declaration

public BaseEventSystem.Action<string> OnWillUnloadScene { get; set; }

Property Value

Type	Description
Microsoft.MixedReality.Toolkit.BaseEventSystem.Action<String>

PrevContentExists

Declaration

public bool PrevContentExists { get; }

Property Value

Type	Description
Boolean

PrevContentExists

Declaration

public bool PrevContentExists { get; }

Property Value

Type	Description
Boolean

SceneOperationInProgress

Declaration

public bool SceneOperationInProgress { get; }

Property Value

Type	Description
Boolean

SceneOperationInProgress

Declaration

public bool SceneOperationInProgress { get; }

Property Value

Type	Description
Boolean

SceneOperationProgress

Declaration

public float SceneOperationProgress { get; }

Property Value

Type	Description
Single

SceneOperationProgress

Declaration

public float SceneOperationProgress { get; }

Property Value

Type	Description
Single

SourceId

Declaration

public uint SourceId { get; }

Property Value

Type	Description
UInt32

SourceId

Declaration

public uint SourceId { get; }

Property Value

Type	Description
UInt32

SourceName

Declaration

public string SourceName { get; }

Property Value

Type	Description
String

SourceName

Declaration

public string SourceName { get; }

Property Value

Type	Description
String

WaitingToProceed

Declaration

public bool WaitingToProceed { get; }

Property Value

Type	Description
Boolean

WaitingToProceed

Declaration

public bool WaitingToProceed { get; }

Property Value

Type	Description
Boolean

Methods

Destroy()

Declaration

public override void Destroy()

Overrides

BaseEventSystem.Destroy()

Destroy()

Declaration

public override void Destroy()

Overrides

BaseEventSystem.Destroy()

Disable()

Declaration

public override void Disable()

Overrides

BaseService.Disable()

Disable()

Declaration

public override void Disable()

Overrides

BaseService.Disable()

Enable()

Declaration

public override void Enable()

Overrides

BaseService.Enable()

Enable()

Declaration

public override void Enable()

Overrides

BaseService.Enable()

GetScene(String)

Declaration

public Scene GetScene(string sceneName)

Parameters

Type	Name	Description
String	sceneName

Returns

Type	Description
Scene

GetScene(String)

Declaration

public Scene GetScene(string sceneName)

Parameters

Type	Name	Description
String	sceneName

Returns

Type	Description
Scene

GetScenes(IEnumerable<String>)

Declaration

public IEnumerable<Scene> GetScenes(IEnumerable<string> sceneNames)

Parameters

Type	Name	Description
IEnumerable<String>	sceneNames

Returns

Type	Description
IEnumerable<Scene>

GetScenes(IEnumerable<String>)

Declaration

public IEnumerable<Scene> GetScenes(IEnumerable<string> sceneNames)

Parameters

Type	Name	Description
IEnumerable<String>	sceneNames

Returns

Type	Description
IEnumerable<Scene>

Initialize()

Declaration

public override void Initialize()

Overrides

BaseService.Initialize()

Initialize()

Declaration

public override void Initialize()

Overrides

BaseService.Initialize()

IsContentLoaded(String)

Declaration

public bool IsContentLoaded(string sceneName)

Parameters

Type	Name	Description
String	sceneName

Returns

Type	Description
Boolean

IsContentLoaded(String)

Declaration

public bool IsContentLoaded(string sceneName)

Parameters

Type	Name	Description
String	sceneName

Returns

Type	Description
Boolean

LoadContent(IEnumerable<String>, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadContent(IEnumerable<string> scenesToLoad, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
IEnumerable<String>	scenesToLoad
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

LoadContent(IEnumerable<String>, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadContent(IEnumerable<string> scenesToLoad, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
IEnumerable<String>	scenesToLoad
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

LoadContent(String, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadContent(string sceneToLoad, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
String	sceneToLoad
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

LoadContent(String, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadContent(string sceneToLoad, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
String	sceneToLoad
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

LoadContentByTag(String, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadContentByTag(string tag, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
String	tag
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

LoadContentByTag(String, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadContentByTag(string tag, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
String	tag
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

LoadNextContent(Boolean, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadNextContent(bool wrap = false, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
Boolean	wrap
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

LoadNextContent(Boolean, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadNextContent(bool wrap = false, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
Boolean	wrap
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

LoadPrevContent(Boolean, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadPrevContent(bool wrap = false, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
Boolean	wrap
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

LoadPrevContent(Boolean, LoadSceneMode, SceneActivationToken)

Declaration

public Task LoadPrevContent(bool wrap = false, LoadSceneMode mode = null, SceneActivationToken activationToken = null)

Parameters

Type	Name	Description
Boolean	wrap
LoadSceneMode	mode
SceneActivationToken	activationToken

Returns

Type	Description
Task

SetLightingScene(String, LightingSceneTransitionType, Single)

Declaration

public void SetLightingScene(string newLightingSceneName, LightingSceneTransitionType transitionType = null, float transitionDuration = 1F)

Parameters

Type	Name	Description
String	newLightingSceneName
LightingSceneTransitionType	transitionType
Single	transitionDuration

SetLightingScene(String, LightingSceneTransitionType, Single)

Declaration

public void SetLightingScene(string newLightingSceneName, LightingSceneTransitionType transitionType = null, float transitionDuration = 1F)

Parameters

Type	Name	Description
String	newLightingSceneName
LightingSceneTransitionType	transitionType
Single	transitionDuration

UnloadContent(IEnumerable<String>)

Declaration

public Task UnloadContent(IEnumerable<string> scenesToUnload)

Parameters

Type	Name	Description
IEnumerable<String>	scenesToUnload

Returns

Type	Description
Task

UnloadContent(IEnumerable<String>)

Declaration

public Task UnloadContent(IEnumerable<string> scenesToUnload)

Parameters

Type	Name	Description
IEnumerable<String>	scenesToUnload

Returns

Type	Description
Task

UnloadContent(String)

Declaration

public Task UnloadContent(string sceneToUnload)

Parameters

Type	Name	Description
String	sceneToUnload

Returns

Type	Description
Task

UnloadContent(String)

Declaration

public Task UnloadContent(string sceneToUnload)

Parameters

Type	Name	Description
String	sceneToUnload

Returns

Type	Description
Task

UnloadContentByTag(String)

Declaration

public Task UnloadContentByTag(string tag)

Parameters

Type	Name	Description
String	tag

Returns

Type	Description
Task

UnloadContentByTag(String)

Declaration

public Task UnloadContentByTag(string tag)

Parameters

Type	Name	Description
String	tag

Returns

Type	Description
Task

Update()

Declaration

public override void Update()

Overrides

BaseService.Update()

Update()

Declaration

public override void Update()

Overrides

BaseService.Update()

Implements

IMixedRealitySceneSystem

IMixedRealityEventSystem

IMixedRealityService

IDisposable

IMixedRealityEventSource

IEqualityComparer

IMixedRealitySceneSystemEditor