Class SpatialMappingBase

Inheritance

Object

SpatialMappingBase

SpatialMappingCollider

SpatialMappingRenderer

Namespace: UnityEngine.XR.WSA

Syntax

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public abstract class SpatialMappingBase : MonoBehaviour

Fields

m_BakePhysics

Declaration

protected bool m_BakePhysics

Field Value

Type	Description
Boolean

m_SurfaceParentWasDynamicallyCreated

Declaration

protected bool m_SurfaceParentWasDynamicallyCreated

Field Value

Type	Description
Boolean

Properties

bakePhysics

Declaration

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public bool bakePhysics { get; protected set; }

Property Value

Type	Description
Boolean

bounds

Declaration

protected Bounds bounds { get; set; }

Property Value

Type	Description
Bounds

freezeUpdates

Declaration

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public bool freezeUpdates { get; set; }

Property Value

Type	Description
Boolean

halfBoxExtents

Declaration

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public Vector3 halfBoxExtents { get; set; }

Property Value

Type	Description
Vector3

lastUpdatedObserverPosition

Declaration

protected Vector3 lastUpdatedObserverPosition { get; set; }

Property Value

Type	Description
Vector3

lodToPcm

Declaration

protected static int[] lodToPcm { get; }

Property Value

Type	Description
Int32[]

lodType

Declaration

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public SpatialMappingBase.LODType lodType { get; set; }

Property Value

Type	Description
SpatialMappingBase.LODType

nextSurfaceChangeUpdateTime

Declaration

protected float nextSurfaceChangeUpdateTime { get; set; }

Property Value

Type	Description
Single

numUpdatesBeforeRemoval

Declaration

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public int numUpdatesBeforeRemoval { get; set; }

Property Value

Type	Description
Int32

observerId

Declaration

protected int observerId { get; set; }

Property Value

Type	Description
Int32

pendingSurfacesForEviction

Declaration

protected Dictionary<int, SpatialMappingBase.Surface> pendingSurfacesForEviction { get; set; }

Property Value

Type	Description
Dictionary<Int32, SpatialMappingBase.Surface>

secondsBetweenUpdates

Declaration

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public float secondsBetweenUpdates { get; set; }

Property Value

Type	Description
Single

selectedCamera

Declaration

protected Camera selectedCamera { get; set; }

Property Value

Type	Description
Camera

sphereRadius

Declaration

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public float sphereRadius { get; set; }

Property Value

Type	Description
Single

surfaceObjects

Declaration

protected Dictionary<int, SpatialMappingBase.Surface> surfaceObjects { get; set; }

Property Value

Type	Description
Dictionary<Int32, SpatialMappingBase.Surface>

surfaceObserver

Declaration

protected SurfaceObserver surfaceObserver { get; set; }

Property Value

Type	Description
SurfaceObserver

surfaceParent

Declaration

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public GameObject surfaceParent { get; set; }

Property Value

Type	Description
GameObject

surfaceParentWasDynamicallyCreated

Declaration

protected bool surfaceParentWasDynamicallyCreated { get; set; }

Property Value

Type	Description
Boolean

surfacesToRemoveFromDict

Declaration

protected List<int> surfacesToRemoveFromDict { get; set; }

Property Value

Type	Description
List<Int32>

volumeType

Declaration

[Obsolete("Support for built-in VR will be removed in Unity 2020.1. Please update to the new Unity XR Plugin System. More information about the new XR Plugin System can be found at https://docs.google.com/document/d/1AMk4NwRVAtnG-LScXT2ne_s5mD4rmWK_C9dyn39ZDbc/edit.", false)]
public SpatialMappingBase.VolumeType volumeType { get; set; }

Property Value

Type	Description
SpatialMappingBase.VolumeType

Methods

AddRequiredComponentsForBaking(SpatialMappingBase.Surface)

Declaration

protected virtual void AddRequiredComponentsForBaking(SpatialMappingBase.Surface surface)

Parameters

Type	Name	Description
SpatialMappingBase.Surface	surface

Awake()

Declaration

protected virtual void Awake()

BoundsContains(Vector3)

Declaration

protected bool BoundsContains(Vector3 position)

Parameters

Type	Name	Description
Vector3	position

Returns

Type	Description
Boolean

CloneBakedComponents(SurfaceData, SpatialMappingBase.Surface)

Declaration

protected void CloneBakedComponents(SurfaceData bakedData, SpatialMappingBase.Surface target)

Parameters

Type	Name	Description
SurfaceData	bakedData
SpatialMappingBase.Surface	target

DestroySurface(SpatialMappingBase.Surface)

Declaration

protected virtual void DestroySurface(SpatialMappingBase.Surface surface)

Parameters

Type	Name	Description
SpatialMappingBase.Surface	surface

ForEachSurfaceInCache(Action<SpatialMappingBase.Surface>)

Declaration

protected void ForEachSurfaceInCache(Action<SpatialMappingBase.Surface> callback)

Parameters

Type	Name	Description
Action<SpatialMappingBase.Surface>	callback

GetLODFromTPCM(Double)

Declaration

public static SpatialMappingBase.LODType GetLODFromTPCM(double trianglesPerCubicMeter)

Parameters

Type	Name	Description
Double	trianglesPerCubicMeter

Returns

Type	Description
SpatialMappingBase.LODType

OnBeginSurfaceEviction(Boolean, SpatialMappingBase.Surface)

Declaration

protected abstract void OnBeginSurfaceEviction(bool shouldBeActiveWhileRemoved, SpatialMappingBase.Surface surface)

Parameters

Type	Name	Description
Boolean	shouldBeActiveWhileRemoved
SpatialMappingBase.Surface	surface

OnDestroy()

Declaration

protected virtual void OnDestroy()

OnDidApplyAnimationProperties()

Declaration

protected virtual void OnDidApplyAnimationProperties()

OnDisable()

Declaration

protected virtual void OnDisable()

OnEnable()

Declaration

protected virtual void OnEnable()

OnRemoveSurface(SurfaceId)

Declaration

protected void OnRemoveSurface(SurfaceId surfaceId)

Parameters

Type	Name	Description
SurfaceId	surfaceId

OnResetProperties()

Declaration

protected virtual void OnResetProperties()

OnSurfaceDataReady(SpatialMappingBase, SurfaceData, Boolean, Single)

Declaration

protected abstract void OnSurfaceDataReady(SpatialMappingBase requester, SurfaceData bakedData, bool outputWritten, float elapsedBakeTimeSeconds)

Parameters

Type	Name	Description
SpatialMappingBase	requester
SurfaceData	bakedData
Boolean	outputWritten
Single	elapsedBakeTimeSeconds

ProcessEvictedObjects()

Declaration

protected void ProcessEvictedObjects()

Reset()

Declaration

protected virtual void Reset()

ShouldRemainActiveWhileBeingRemoved(SpatialMappingBase.Surface)

Declaration

protected bool ShouldRemainActiveWhileBeingRemoved(SpatialMappingBase.Surface surface)

Parameters

Type	Name	Description
SpatialMappingBase.Surface	surface

Returns

Type	Description
Boolean

Start()

Declaration

protected virtual void Start()

TryGetHighestPriorityRequest(out SurfaceData)

Declaration

protected virtual bool TryGetHighestPriorityRequest(out SurfaceData bestSurfaceData)

Parameters

Type	Name	Description
SurfaceData	bestSurfaceData

Returns

Type	Description
Boolean

Update()

Declaration

protected virtual void Update()

UpdatePosition()

Declaration

protected void UpdatePosition()

UpdateSurfaceData(SpatialMappingBase.Surface)

Declaration

protected virtual void UpdateSurfaceData(SpatialMappingBase.Surface surface)

Parameters

Type	Name	Description
SpatialMappingBase.Surface	surface