SparseSpatialMapWorkerFrameFilter Class¶

Description¶

在场景中控制 SparseSpatialMap 的 MonoBehaviour ，在Unity环境下提供功能扩展。如有需要可以直接使用 SparseSpatialMapWorkerFrameFilter.Builder 、 SparseSpatialMapWorkerFrameFilter.Localizer 或 SparseSpatialMapWorkerFrameFilter.Manager 。

Enums¶

public enum SparseSpatialMapWorkerFrameFilter.Mode

工作模式。

Classes¶

public class SparseSpatialMapWorkerFrameFilter.MapLocalizerConfig	地图定位配置。
public class SparseSpatialMapWorkerFrameFilter.SpatialMapServiceConfig	SparseSpatialMapManager 服务器配置。

MonoBehaviour Messages¶

protected virtual void Awake()

protected virtual void OnEnable()

protected virtual void Start()

protected virtual void OnDisable()

protected virtual void OnDestroy()

Fields¶

LocalizerConfig¶

C#: public SparseSpatialMapWorkerFrameFilter.MapLocalizerConfig LocalizerConfig

地图定位配置，在每次启动（ SparseSpatialMapWorkerFrameFilter.OnEnable ）前使用。

UseGlobalServiceConfig¶

C#: public bool UseGlobalServiceConfig

是否使用全局服务器配置。全局配置可以点击Unity菜单EasyAR -> Change Global Spatial Map Service Config可以在属性面板里面进行填写。

ServiceConfig¶

C#: public SparseSpatialMapWorkerFrameFilter.SpatialMapServiceConfig ServiceConfig

SparseSpatialMapWorkerFrameFilter.UseGlobalServiceConfig == false时使用的服务器配置，只对该物体有效。

Properties¶

Builder¶

C#: public SparseSpatialMap Builder { get; }

EasyAR Sense API，在地图构建时，如果功能可以使用，可以在Awake之后访问。

在地图构建时（ SparseSpatialMapWorkerFrameFilter.WorkingMode == SparseSpatialMapWorkerFrameFilter.Mode.Build ）使用。

Localizer¶

C#: public SparseSpatialMap Localizer { get; }

EasyAR Sense API，如果功能可以使用，可以在Awake之后访问。

在地图定位时（ SparseSpatialMapWorkerFrameFilter.WorkingMode == SparseSpatialMapWorkerFrameFilter.Mode.Localize ）使用。

Manager¶

C#: public SparseSpatialMapManager Manager { get; }

EasyAR Sense API，如果功能可以使用，可以在Awake之后访问。

在地图构建和上传时使用。

WorkingMode¶

C#: public SparseSpatialMapWorkerFrameFilter.Mode WorkingMode { get; }

当前工作模式。工作模式启动为 SparseSpatialMapWorkerFrameFilter.Mode.Build ，会在加载地图之后变成 SparseSpatialMapWorkerFrameFilter.Mode.Localize 。

LocalizedMap¶

C#: public SparseSpatialMapController LocalizedMap { get; }

当前被定为的地图。

BuilderMapController¶

C#: public SparseSpatialMapController BuilderMapController { get; }

用于建图的map controller。如果想可视化地查看建图过程，需要在建图开始之前设置一个即将被加载的 SparseSpatialMapController 的 SparseSpatialMapController.SourceType 为 SparseSpatialMapController.DataSource.MapBuilder 。

MapControllers¶

C#: public List< SparseSpatialMapController > MapControllers { get; }

已加载的 SparseSpatialMapController 。

Events¶

MapLoad¶

C#: public event Action< SparseSpatialMapController , SparseSpatialMapController.SparseSpatialMapInfo , bool, string> MapLoad

Map加载完成的事件。bool值表示加载是否成功。string值表示出错时的错误信息。

MapUnload¶

C#: public event Action< SparseSpatialMapController , SparseSpatialMapController.SparseSpatialMapInfo , bool, string> MapUnload

Map卸载完成的事件。bool值表示卸载是否成功。string值表示出错时的错误信息。

MapHost¶

C#: public event Action< SparseSpatialMapController , SparseSpatialMapController.SparseSpatialMapInfo , bool, string> MapHost

Map创建及上传完成的事件。bool值表示创建及上传是否成功。string值表示出错时的错误信息。

Methods¶

LoadMap¶

C#: public void LoadMap( SparseSpatialMapController map)

加载地图。

UnloadMap¶

C#: public void UnloadMap( SparseSpatialMapController map)

卸载地图。

HostMap¶

C#: public void HostMap( SparseSpatialMapController map, string name, Optional< Image > preview)

创建并上传地图。