DenseSpatialMapBuilderFrameFilter Class

Description

MonoBehaviour which controls DenseSpatialMap in the scene, providing a few extensions in the Unity environment.


Fields

MapMeshMaterial

C#

public Material MapMeshMaterial

Material for map mesh render. Only effective if modified before the session starts. Mesh transparency is not enabled in URP by now when using default material.

TargetMaxUpdateTimePerFrame

C#

public int TargetMaxUpdateTimePerFrame

The target maximum update time per frame in milliseconds. Modify at any time and takes effect immediately.

The real time used each frame may differ from this value and a minimum amount fo data is ensured to be updated no matter what the value is. No extra time will be used if data does need to update. Decrease this value if the mesh update slows rendering.

EnableMeshCollider

C#

public bool EnableMeshCollider

Whether to create mesh collider on the mesh created. Only effective if modified before the session starts.


Properties

enabled

C#

public bool enabled { get; set; }

Start/Stop building when ARSession is running. Building will start only when MonoBehaviour .enabled is true after session started.

RenderMesh

C#

public bool RenderMesh { get; set; }

Mesh render on/off.

MeshColor

C#

public Color MeshColor { get; set; }

Mesh color. Only effective if modified after the session starts.

Alpha is ingored when using URP or running in HMD when default shader is in use.

MeshBlocks

C#

public List< DenseSpatialMapBlockController > MeshBlocks { get; }

All mesh blocks.


Events

MeshBlockCreate

C#

public event Action< DenseSpatialMapBlockController > MeshBlockCreate

Event when a new mesh block created.

MeshBlockUpdate

C#

public event Action<List< DenseSpatialMapBlockController >> MeshBlockUpdate

Event when mesh block updates.