Search Results for

    Show / Hide Table of Contents

    Class SpatialMappingObserver

    Spatial Mapping observer.

    Inheritance
    object
    SpatialMappingObserver
    Implements
    IDisposable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Evergine.Framework.XR.SpatialMapping
    Assembly: Evergine.Framework.dll
    Syntax
    public abstract class SpatialMappingObserver : IDisposable

    Constructors

    SpatialMappingObserver()

    Initializes a new instance of the SpatialMappingObserver class.

    Declaration
    public SpatialMappingObserver()

    Fields

    surfaces

    Surfaces 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 the spatial mapping is supported.

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

    ObtainNormals

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

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

    Surfaces

    Gets the surfaces dictionary.

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

    TrianglesPerCubicMeter

    Gets or sets the number of triangles to calculate per cubic meter.

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

    Methods

    Destroy()

    Destroy all resources of this instance.

    Declaration
    protected virtual void Destroy()

    Dispose()

    Public implementation of 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

    Dispose 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 which has changed.

    SpatialMappingSurface surface

    The surface.

    SurfaceChange changeType

    The type of change that occurred on the surface.

    Initialize()

    Initialize this instance.

    Declaration
    public abstract void Initialize()

    InternalUpdate()

    Update the surface observer.

    Declaration
    protected abstract void InternalUpdate()

    Update()

    Updates the observer.

    Declaration
    public void Update()

    UpdateSurfaces()

    Process all spatial surfaces.

    Declaration
    public abstract void UpdateSurfaces()

    Events

    OnSurfaceChanged

    Event fired when a spatial surface is changed

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

    Implements

    IDisposable

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In This Article
    Back to top
    Generated by DocFX