Interface IMixedRealitySpatialAwarenessObserver

Inherited Members

IMixedRealityService.Name

IMixedRealityService.Priority

IMixedRealityService.ConfigurationProfile

IMixedRealityService.Initialize()

IMixedRealityService.Reset()

IMixedRealityService.Enable()

IMixedRealityService.Update()

IMixedRealityService.LateUpdate()

IMixedRealityService.Disable()

IMixedRealityService.Destroy()

IMixedRealityEventSource.SourceId

IMixedRealityEventSource.SourceName

Namespace: Microsoft.MixedReality.Toolkit.SpatialAwareness

Assembly: cs.temp.dll.dll

Syntax

public interface IMixedRealitySpatialAwarenessObserver : IMixedRealityDataProvider, IMixedRealityService, IDisposable, IMixedRealityEventSource, IEqualityComparer

Properties

DefaultPhysicsLayer

Get or sets the default Unity Physics Layer on which to set the spatial object.

Declaration

int DefaultPhysicsLayer { get; }

Property Value

Type	Description
Int32

DefaultPhysicsLayer

Get or sets the default Unity Physics Layer on which to set the spatial object.

Declaration

int DefaultPhysicsLayer { get; }

Property Value

Type	Description
Int32

IsRunning

Is the observer running (actively accumulating spatial data)?

Declaration

bool IsRunning { get; }

Property Value

Type	Description
Boolean

IsRunning

Is the observer running (actively accumulating spatial data)?

Declaration

bool IsRunning { get; }

Property Value

Type	Description
Boolean

IsStationaryObserver

Should the observer remain stationary in the scene?

Declaration

bool IsStationaryObserver { get; set; }

Property Value

Type	Description
Boolean

Remarks

Set IsStationaryObserver to false to move the volume with the user. If set to true, the origin will be 0,0,0 or the last known location.

IsStationaryObserver

Should the observer remain stationary in the scene?

Declaration

bool IsStationaryObserver { get; set; }

Property Value

Type	Description
Boolean

Remarks

Set IsStationaryObserver to false to move the volume with the user. If set to true, the origin will be 0,0,0 or the last known location.

ObservationExtents

Gets or sets the extents( 1/2 size) of the volume, in meters per axis, from which individual observations will be made.

Declaration

Vector3 ObservationExtents { get; set; }

Property Value

Type	Description
Vector3

Remarks

When used when ObserverVolumeType is set to the X value of the extents will be used as the radius.

ObservationExtents

Gets or sets the extents( 1/2 size) of the volume, in meters per axis, from which individual observations will be made.

Declaration

Vector3 ObservationExtents { get; set; }

Property Value

Type	Description
Vector3

Remarks

When used when ObserverVolumeType is set to the X value of the extents will be used as the radius.

ObserverOrigin

Gets or sets the origin, in World Space, of the observer.

Declaration

Vector3 ObserverOrigin { get; set; }

Property Value

Type	Description
Vector3

Remarks

Moving the observer origin allows the spatial awareness system to locate and discard meshes as the user navigates the environment.

ObserverOrigin

Gets or sets the origin, in World Space, of the observer.

Declaration

Vector3 ObserverOrigin { get; set; }

Property Value

Type	Description
Vector3

Remarks

Moving the observer origin allows the spatial awareness system to locate and discard meshes as the user navigates the environment.

ObserverRotation

Gets or sets the orientation of the volume in World Space.

Declaration

Quaternion ObserverRotation { get; set; }

Property Value

Type	Description
Quaternion

Remarks

This is only used when ObserverVolumeType is set to

ObserverRotation

Gets or sets the orientation of the volume in World Space.

Declaration

Quaternion ObserverRotation { get; set; }

Property Value

Type	Description
Quaternion

Remarks

This is only used when ObserverVolumeType is set to

ObserverVolumeType

Gets or sets the type of volume the observer should operate in.

Declaration

VolumeType ObserverVolumeType { get; set; }

Property Value

Type	Description
VolumeType

ObserverVolumeType

Gets or sets the type of volume the observer should operate in.

Declaration

VolumeType ObserverVolumeType { get; set; }

Property Value

Type	Description
VolumeType

StartupBehavior

Indicates the developer's intended startup behavior.

Declaration

AutoStartBehavior StartupBehavior { get; set; }

Property Value

Type	Description
AutoStartBehavior

StartupBehavior

Indicates the developer's intended startup behavior.

Declaration

AutoStartBehavior StartupBehavior { get; set; }

Property Value

Type	Description
AutoStartBehavior

UpdateInterval

Gets or sets the frequency, in seconds, at which the spatial observer should update.

Declaration

float UpdateInterval { get; set; }

Property Value

Type	Description
Single

UpdateInterval

Gets or sets the frequency, in seconds, at which the spatial observer should update.

Declaration

float UpdateInterval { get; set; }

Property Value

Type	Description
Single

Methods

ClearObservations()

Clears the observer's collection of observations.

Declaration

void ClearObservations()

Remarks

If the observer is currently running, calling ClearObservations will suspend it.

ClearObservations()

Clears the observer's collection of observations.

Declaration

void ClearObservations()

Remarks

If the observer is currently running, calling ClearObservations will suspend it.

Resume()

Start | resume the observer.

Declaration

void Resume()

Resume()

Start | resume the observer.

Declaration

void Resume()

Suspend()

Stop | pause the observer

Declaration

void Suspend()

Suspend()

Stop | pause the observer

Declaration

void Suspend()