Class MixedRealityCameraSystem
The Camera system controls the settings of the main camera.
Inheritance
Implements
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.CameraSystem
Assembly: cs.temp.dll.dll
Syntax
public class MixedRealityCameraSystem : BaseDataProviderAccessCoreSystem, IMixedRealityDataProviderAccess, IMixedRealityCameraSystem, IMixedRealityEventSystem, IMixedRealityEventSource, IEqualityComparer, IMixedRealityService, IDisposable
Constructors
MixedRealityCameraSystem(BaseMixedRealityProfile)
Constructor.
Declaration
public MixedRealityCameraSystem(BaseMixedRealityProfile profile = null)
Parameters
Type | Name | Description |
---|---|---|
BaseMixedRealityProfile | profile | The configuration profile for the service. |
MixedRealityCameraSystem(IMixedRealityServiceRegistrar, BaseMixedRealityProfile)
Constructor.
Declaration
[Obsolete("This constructor is obsolete (registrar parameter is no longer required) and will be removed in a future version of the Microsoft Mixed Reality Toolkit.")]
public MixedRealityCameraSystem(IMixedRealityServiceRegistrar registrar, BaseMixedRealityProfile profile = null)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityServiceRegistrar | registrar | The IMixedRealityServiceRegistrar instance that loaded the service. |
BaseMixedRealityProfile | profile | The configuration profile for the service. |
Properties
CameraProfile
Typed representation of the ConfigurationProfile property.
Declaration
public MixedRealityCameraProfile CameraProfile { get; }
Property Value
Type | Description |
---|---|
MixedRealityCameraProfile |
IsOpaque
Is the current camera displaying on an opaque (VR / immersive) or a transparent (AR) device
Declaration
public bool IsOpaque { get; }
Property Value
Type | Description |
---|---|
Boolean |
Name
Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action.
Declaration
public override string Name { get; protected set; }
Property Value
Type | Description |
---|---|
String |
Overrides
SourceId
The unique source id of this event source.
Declaration
public uint SourceId { get; }
Property Value
Type | Description |
---|---|
UInt32 |
SourceName
The name of this event source.
Declaration
public string SourceName { get; }
Property Value
Type | Description |
---|---|
String |
Methods
Destroy()
Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed.
Declaration
public override void Destroy()
Overrides
Disable()
Optional Disable function to pause the service.
Declaration
public override void Disable()
Overrides
Enable()
Optional Enable function to enable / re-enable the service.
Declaration
public override void Enable()
Overrides
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.
Declaration
public override void Initialize()
Overrides
Update()
Optional Update function to perform per-frame updates of the service.
Declaration
public override void Update()