Class SpatialMappingObserver

A spatial mapping observer.

Inheritance
object
SpatialMappingObserver
Namespace: Evergine.Framework.XR.SpatialMapping
Assembly: Evergine.Framework.dll
Syntax
public abstract class SpatialMappingObserver

Constructors

SpatialMappingObserver()

Initializes a new instance of the SpatialMappingObserver class.

Declaration
public SpatialMappingObserver()

Fields

surfaces

Surface dictionary.

Declaration
protected Dictionary<Guid, SpatialMappingSurface> surfaces
Field Value
Type Description
Dictionary<Guid, SpatialMappingSurface>

Properties

Extents

Gets or sets the extents of the observation volume.

Declaration
public virtual Vector3 Extents { get; set; }
Property Value
Type Description
Vector3

IsSupported

Gets a value indicating whether spatial mapping is supported.

Declaration
public abstract bool IsSupported { get; }
Property Value
Type Description
bool

ObtainNormals

Gets or sets a value indicating whether the standard information must be captured.

Declaration
public virtual bool ObtainNormals { get; set; }
Property Value
Type Description
bool

Surfaces

Gets the surface dictionary.

Declaration
public IDictionary<Guid, SpatialMappingSurface> Surfaces { get; }
Property Value
Type Description
IDictionary<Guid, SpatialMappingSurface>

TrianglesPerCubicMeter

Gets or sets the number of triangles calculated per cubic meter.

Declaration
public virtual float TrianglesPerCubicMeter { get; set; }
Property Value
Type Description
float

Methods

Destroy()

Destroys all resources of this instance.

Declaration
protected virtual void Destroy()

Dispose()

Public implementation of the Dispose pattern, callable by consumers.

Declaration
public void Dispose()

Dispose(bool)

Protected implementation of Dispose pattern.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Disposes native elements.

~SpatialMappingObserver()

Finalizes an instance of the SpatialMappingObserver class.

Declaration
protected ~SpatialMappingObserver()

FireOnSurfaceChanged(Guid, SpatialMappingSurface, SurfaceChange)

Handles the SurfaceObserver's OnSurfaceChanged event.

Declaration
protected void FireOnSurfaceChanged(Guid id, SpatialMappingSurface surface, SurfaceChange changeType)
Parameters
Type Name Description
Guid id

The identifier assigned to the surface that has changed.
SpatialMappingSurface surface

The surface.
SurfaceChange changeType

The type of change that occurred on the surface.

Initialize()

Initializes this instance.

Declaration
public abstract void Initialize()

InternalUpdate()

Updates the surface observer.

Declaration
protected abstract void InternalUpdate()

Update()

Updates the observers.

Declaration
public void Update()

UpdateSurfaces()

Processes all spatial surfaces.

Declaration
public abstract void UpdateSurfaces()

Events

OnSurfaceChanged

Event fires when a spatial surface changes

Declaration
public event SpatialMappingObserver.OnSurfaceChangedHandler OnSurfaceChanged
Event Type
Type Description
SpatialMappingObserver.OnSurfaceChangedHandler

Extension Methods