MixedRealityCameraSystem Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.CameraSystem

Assembly:: Microsoft.MixedReality.Toolkit.Services.CameraSystem.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The Camera system controls the settings of the main camera.

public ref class MixedRealityCameraSystem : Microsoft::MixedReality::Toolkit::BaseDataProviderAccessCoreSystem, IDisposable, Microsoft::MixedReality::Toolkit::CameraSystem::IMixedRealityCameraSystem, System::Collections::IEqualityComparer

[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/configuration/mixed-reality-configuration-guide#camera")]
public class MixedRealityCameraSystem : Microsoft.MixedReality.Toolkit.BaseDataProviderAccessCoreSystem, IDisposable, Microsoft.MixedReality.Toolkit.CameraSystem.IMixedRealityCameraSystem, System.Collections.IEqualityComparer

[<UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/configuration/mixed-reality-configuration-guide#camera")>]
type MixedRealityCameraSystem = class
    inherit BaseDataProviderAccessCoreSystem
    interface IMixedRealityCameraSystem
    interface IMixedRealityEventSystem
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEventSource
    interface IEqualityComparer

Public Class MixedRealityCameraSystem
Inherits BaseDataProviderAccessCoreSystem
Implements IDisposable, IEqualityComparer, IMixedRealityCameraSystem

Inheritance: Object

BaseService

BaseEventSystem

BaseCoreSystem

BaseDataProviderAccessCoreSystem
MixedRealityCameraSystem

Attributes: UnityEngine.HelpURLAttribute

Implements: IMixedRealityCameraSystem IMixedRealityEventSource IMixedRealityEventSystem IMixedRealityService IEqualityComparer IDisposable

Constructors

MixedRealityCameraSystem(BaseMixedRealityProfile)	Constructor.
MixedRealityCameraSystem(IMixedRealityServiceRegistrar, BaseMixedRealityProfile)	Obsolete. Constructor.

Fields

DefaultPriority	(Inherited from BaseService)
disposed	Value indicating if the object has completed disposal. (Inherited from BaseService)

Properties

CameraProfile	Typed representation of the ConfigurationProfile property.
ConfigurationProfile	The configuration profile for the service. (Inherited from BaseService)
EventHandlersByType	List of all event handlers grouped by type that are registered to this Event System. (Inherited from BaseEventSystem)
EventListeners	List of event listeners that are registered to this Event System. (Inherited from BaseEventSystem)
IsEnabled	Indicates whether or not the service is currently enabled. (Inherited from BaseService)
IsInitialized	Indicates whether or not the service has been initialized. (Inherited from BaseService)
IsMarkedDestroyed	Indicates whether or not the Destroy method been called on this service. (Inherited from BaseService)
IsOpaque	Is the current camera displaying on an opaque (VR / immersive) or a transparent (AR) device
Name	Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action.
Priority	Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated. (Inherited from BaseService)
Registrar	Obsolete. The service registrar instance that registered this service. (Inherited from BaseCoreSystem)
SourceId	The unique source id of this event source.
SourceName	The name of this event source.

Methods

Destroy()	Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed.
Disable()	Optional Disable function to pause the service.
Dispose()	Cleanup resources used by this object. (Inherited from BaseService)
Dispose(Boolean)	Cleanup resources used by the object (Inherited from BaseService)
Enable()	Optional Enable function to enable / re-enable the service.
GetDataProvider(String)	Get the data provider that is registered under the specified name. (Inherited from BaseDataProviderAccessCoreSystem)
GetDataProvider<T>(String)	Get the data provider that is registered under the specified name (optional) and matching the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
GetDataProviders()	Gets the collection of registered data providers. (Inherited from BaseDataProviderAccessCoreSystem)
GetDataProviders<T>()	Get the collection of registered observers of the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)	The main function for handling and forwarding all events to their intended recipients. (Inherited from BaseEventSystem)
Initialize()	The initialize function is used to setup the service once created. This method is called once all services have been registered in the Mixed Reality Toolkit.
LateUpdate()	(Inherited from BaseDataProviderAccessCoreSystem)
Register(GameObject)	Registers a GameObject to listen for events from this Event System. (Inherited from BaseEventSystem)
RegisterDataProvider<T>(T)	Registers a service of the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
RegisterDataProvider<T>(Type, String, SupportedPlatforms, Object[])	Registers a data provider of the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
RegisterDataProvider<T>(Type, SupportedPlatforms, Object[])	Obsolete. Registers a data provider of the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
RegisterHandler<T>(IEventSystemHandler)	Registers the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler. (Inherited from BaseEventSystem)
Reset()	(Inherited from BaseDataProviderAccessCoreSystem)
Unregister(GameObject)	Unregisters a GameObject from listening for events from this Event System. (Inherited from BaseEventSystem)
UnregisterDataProvider<T>(String)	Unregisters a data provider of the specified type. (Inherited from BaseDataProviderAccessCoreSystem)
UnregisterDataProvider<T>(T)	Unregisters a data provider. (Inherited from BaseDataProviderAccessCoreSystem)
UnregisterHandler<T>(IEventSystemHandler)	Unregisters the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler. (Inherited from BaseEventSystem)
Update()	Optional Update function to perform per-frame updates of the service.

Explicit Interface Implementations

IEqualityComparer.Equals(Object, Object)	Determines whether the specified objects are equal.
IEqualityComparer.GetHashCode(Object)	Returns a hash code for the specified object.

Applies to