Class SparseSpatialMap

命名空间: easyar

提供SparseSpatialMap系统主要的功能，地图生成和存储、地图加载和定位，同时可以获取点云，平面等环境信息并进行hit Test。 SparseSpatialMap占用2个camera的buffer。应使用camera的setBufferCapacity设置不少于所有组件占用的camera的buffer数量。

SparseSpatialMap

方法

isAvailable

检查SparseSpatialMap是否可用。总是返回true。

bool easyar_SparseSpatialMap_isAvailable(void)

static bool isAvailable()

public static boolean isAvailable()

companion object fun isAvailable(): Boolean

+ (bool)isAvailable

public static func isAvailable() -> Bool

public static bool isAvailable()

类型	描述
Boolean

inputFrameSink

输入帧输入端口。SparseSpatialMap输入帧必须包含camera参数、时间戳信息和空间信息（cameraTransform和trackingStatus）。参考 InputFrameSink 。注意：camera支持针孔和鱼眼相机模型，使用鱼眼相机性能会受影响。

void easyar_SparseSpatialMap_inputFrameSink(easyar_SparseSpatialMap * This, easyar_InputFrameSink * * Return)

std::shared_ptr<InputFrameSink> inputFrameSink()

public @Nonnull InputFrameSink inputFrameSink()

fun inputFrameSink(): InputFrameSink

- (easyar_InputFrameSink *)inputFrameSink

public func inputFrameSink() -> InputFrameSink

public virtual InputFrameSink inputFrameSink()

类型	描述
InputFrameSink

bufferRequirement

当前组件占用camera buffer的数量。

int easyar_SparseSpatialMap_bufferRequirement(easyar_SparseSpatialMap * This)

int bufferRequirement()

public int bufferRequirement()

fun bufferRequirement(): Int

- (int)bufferRequirement

public func bufferRequirement() -> Int32

public virtual int bufferRequirement()

类型	描述
Int32

outputFrameSource

输出帧输出端口。参考 OutputFrameSource 。

void easyar_SparseSpatialMap_outputFrameSource(easyar_SparseSpatialMap * This, easyar_OutputFrameSource * * Return)

std::shared_ptr<OutputFrameSource> outputFrameSource()

public @Nonnull OutputFrameSource outputFrameSource()

fun outputFrameSource(): OutputFrameSource

- (easyar_OutputFrameSource *)outputFrameSource

public func outputFrameSource() -> OutputFrameSource

public virtual OutputFrameSource outputFrameSource()

类型	描述
OutputFrameSource

create

构造SparseSpatialMap。

void easyar_SparseSpatialMap_create(easyar_SparseSpatialMap * * Return)

static std::shared_ptr<SparseSpatialMap> create()

public static @Nonnull SparseSpatialMap create()

companion object fun create(): SparseSpatialMap

+ (easyar_SparseSpatialMap *)create

public static func create() -> SparseSpatialMap

public static SparseSpatialMap create()

类型	描述
SparseSpatialMap

setResultPoseType

设置结果姿态类型。默认enableStabilization为false。只有 InputFrame 中包含空间信息时才有效。

void easyar_SparseSpatialMap_setResultPoseType(easyar_SparseSpatialMap * This, bool enableStabilization)

void setResultPoseType(bool enableStabilization)

public void setResultPoseType(boolean enableStabilization)

fun setResultPoseType(enableStabilization: Boolean): Unit

- (void)setResultPoseType:(bool)enableStabilization

public func setResultPoseType(_ enableStabilization: Bool) -> Void

public virtual void setResultPoseType(bool enableStabilization)

参数

名称	类型	描述
enableStabilization	Boolean

类型	描述
Void

setResultAsyncMode

设置结果异步模式。如果结果通过outputFrameSource输出，则应设置位true，如果结果通过getSyncResult获取，则应设置为false。默认enableAsync为true。同步模式仅在输入帧包含空间信息且使用XR License时可生效。

bool easyar_SparseSpatialMap_setResultAsyncMode(easyar_SparseSpatialMap * This, bool enableAsync)

bool setResultAsyncMode(bool enableAsync)

public boolean setResultAsyncMode(boolean enableAsync)

fun setResultAsyncMode(enableAsync: Boolean): Boolean

- (bool)setResultAsyncMode:(bool)enableAsync

public func setResultAsyncMode(_ enableAsync: Bool) -> Bool

public virtual bool setResultAsyncMode(bool enableAsync)

参数

名称	类型	描述
enableAsync	Boolean

类型	描述
Boolean

start

开始SparseSpatialMap算法。

bool easyar_SparseSpatialMap_start(easyar_SparseSpatialMap * This)

bool start()

public boolean start()

fun start(): Boolean

- (bool)start

public func start() -> Bool

public virtual bool start()

类型	描述
Boolean

stop

停止SparseSpatialMap算法。调用start重新运行。

void easyar_SparseSpatialMap_stop(easyar_SparseSpatialMap * This)

void stop()

public void stop()

fun stop(): Unit

- (void)stop

public func stop() -> Void

public virtual void stop()

类型	描述
Void

close

关闭SparseSpatialMap。close之后不应继续使用。

void easyar_SparseSpatialMap_close(easyar_SparseSpatialMap * This)

void close()

public void close()

fun close(): Unit

- (void)close

public func close() -> Void

public virtual void close()

类型	描述
Void

getPointCloudBuffer

获取当前点云数据位置信息。其中点云位置为世界坐标系中的位置，buffer每一个点由三个连续的值表示，分别代表X，Y，Z轴上的坐标值，每一个值占用4字节。

void easyar_SparseSpatialMap_getPointCloudBuffer(easyar_SparseSpatialMap * This, easyar_Buffer * * Return)

std::shared_ptr<Buffer> getPointCloudBuffer()

public @Nonnull Buffer getPointCloudBuffer()

fun getPointCloudBuffer(): Buffer

- (easyar_Buffer *)getPointCloudBuffer

public func getPointCloudBuffer() -> Buffer

public virtual Buffer getPointCloudBuffer()

类型	描述
Buffer

getMapPlanes

获取检测到的平面，类型为 PlaneType 。

void easyar_SparseSpatialMap_getMapPlanes(easyar_SparseSpatialMap * This, easyar_ListOfPlaneData * * Return)

std::vector<std::shared_ptr<PlaneData>> getMapPlanes()

public java.util.@Nonnull ArrayList<@Nonnull PlaneData> getMapPlanes()

fun getMapPlanes(): ArrayList<PlaneData>

- (NSArray<easyar_PlaneData *> *)getMapPlanes

public func getMapPlanes() -> [PlaneData]

public virtual List<PlaneData> getMapPlanes()

类型	描述
List<PlaneData>

hitTestAgainstPointCloud

在当前点云中进行Hit Test，得到距离相机从近到远一条射线上的n（n>=0）个位置坐标。

void easyar_SparseSpatialMap_hitTestAgainstPointCloud(easyar_SparseSpatialMap * This, easyar_Vec2F cameraImagePoint, easyar_ListOfVec3F * * Return)

std::vector<Vec3F> hitTestAgainstPointCloud(Vec2F cameraImagePoint)

public java.util.@Nonnull ArrayList<@Nonnull Vec3F> hitTestAgainstPointCloud(@Nonnull Vec2F cameraImagePoint)

fun hitTestAgainstPointCloud(cameraImagePoint: Vec2F): ArrayList<Vec3F>

- (NSArray<easyar_Vec3F *> *)hitTestAgainstPointCloud:(easyar_Vec2F *)cameraImagePoint

public func hitTestAgainstPointCloud(_ cameraImagePoint: Vec2F) -> [Vec3F]

public virtual List<Vec3F> hitTestAgainstPointCloud(Vec2F cameraImagePoint)

参数

名称	类型	描述
cameraImagePoint	Vec2F

类型	描述
List<Vec3F>

hitTestAgainstPlanes

在当前检测到的平面上进行Hit Test，得到距离相机从近到远一条射线上的n（n>=0）个位置坐标。输入图像坐标系（[0, 1]^2）的x朝右、y朝下，原点在左上角。可以使用 imageCoordinatesFromScreenCoordinates 来从屏幕坐标转换为图像坐标。输出为点云在世界坐标系中的坐标。

void easyar_SparseSpatialMap_hitTestAgainstPlanes(easyar_SparseSpatialMap * This, easyar_Vec2F cameraImagePoint, easyar_ListOfVec3F * * Return)

std::vector<Vec3F> hitTestAgainstPlanes(Vec2F cameraImagePoint)

public java.util.@Nonnull ArrayList<@Nonnull Vec3F> hitTestAgainstPlanes(@Nonnull Vec2F cameraImagePoint)

fun hitTestAgainstPlanes(cameraImagePoint: Vec2F): ArrayList<Vec3F>

- (NSArray<easyar_Vec3F *> *)hitTestAgainstPlanes:(easyar_Vec2F *)cameraImagePoint

public func hitTestAgainstPlanes(_ cameraImagePoint: Vec2F) -> [Vec3F]

public virtual List<Vec3F> hitTestAgainstPlanes(Vec2F cameraImagePoint)

参数

名称	类型	描述
cameraImagePoint	Vec2F

类型	描述
List<Vec3F>

getMapVersion

获取当前SparseSpatialMap的地图版本。

void easyar_SparseSpatialMap_getMapVersion(easyar_String * * Return)

static std::string getMapVersion()

public static java.lang.@Nonnull String getMapVersion()

companion object fun getMapVersion(): String

+ (NSString *)getMapVersion

public static func getMapVersion() -> String

public static string getMapVersion()

类型	描述
String

unloadMap

通过回调，卸载指定的SparseSpatialMap地图数据。可以通过回调的返回值判断卸载是否成功,成功返回true,否则返回false。

void easyar_SparseSpatialMap_unloadMap(easyar_SparseSpatialMap * This, easyar_String * mapID, easyar_CallbackScheduler * callbackScheduler, easyar_OptionalOfFunctorOfVoidFromBool resultCallBack)

void unloadMap(std::string mapID, std::shared_ptr<CallbackScheduler> callbackScheduler, std::optional<std::function<void(bool)>> resultCallBack)

public void unloadMap(java.lang.@Nonnull String mapID, @Nonnull CallbackScheduler callbackScheduler, @Nullable FunctorOfVoidFromBool resultCallBack)

fun unloadMap(mapID: String, callbackScheduler: CallbackScheduler, resultCallBack: FunctorOfVoidFromBool?): Unit

- (void)unloadMap:(NSString *)mapID callbackScheduler:(easyar_CallbackScheduler *)callbackScheduler resultCallBack:(void (^)(bool))resultCallBack

public func unloadMap(_ mapID: String, _ callbackScheduler: CallbackScheduler, _ resultCallBack: ((Bool) -> Void)?) -> Void

public virtual void unloadMap(string mapID, CallbackScheduler callbackScheduler, Optional<Action<bool>> resultCallBack)

参数

名称	类型	描述
mapID	String
callbackScheduler	CallbackScheduler
resultCallBack	Optional<Action<>>

类型	描述
Void

setConfig

设置SparseSpatialMap相关的配置。参考 SparseSpatialMapConfig 。

void easyar_SparseSpatialMap_setConfig(easyar_SparseSpatialMap * This, easyar_SparseSpatialMapConfig * config)

void setConfig(std::shared_ptr<SparseSpatialMapConfig> config)

public void setConfig(@Nonnull SparseSpatialMapConfig config)

fun setConfig(config: SparseSpatialMapConfig): Unit

- (void)setConfig:(easyar_SparseSpatialMapConfig *)config

public func setConfig(_ config: SparseSpatialMapConfig) -> Void

public virtual void setConfig(SparseSpatialMapConfig config)

参数

名称	类型	描述
config	SparseSpatialMapConfig

类型	描述
Void

getConfig

获取SparseSpatialMap相关的配置。参考 SparseSpatialMapConfig 。

void easyar_SparseSpatialMap_getConfig(easyar_SparseSpatialMap * This, easyar_SparseSpatialMapConfig * * Return)

std::shared_ptr<SparseSpatialMapConfig> getConfig()

public @Nonnull SparseSpatialMapConfig getConfig()

fun getConfig(): SparseSpatialMapConfig

- (easyar_SparseSpatialMapConfig *)getConfig

public func getConfig() -> SparseSpatialMapConfig

public virtual SparseSpatialMapConfig getConfig()

类型	描述
SparseSpatialMapConfig

startLocalization

开始在已加载地图中尝试定位。在此之前，需要设定所需的配置参数。参考 LocalizationMode。

bool easyar_SparseSpatialMap_startLocalization(easyar_SparseSpatialMap * This)

bool startLocalization()

public boolean startLocalization()

fun startLocalization(): Boolean

- (bool)startLocalization

public func startLocalization() -> Bool

public virtual bool startLocalization()

类型	描述
Boolean

stopLocalization

停当前定位过程。

void easyar_SparseSpatialMap_stopLocalization(easyar_SparseSpatialMap * This)

void stopLocalization()

public void stopLocalization()

fun stopLocalization(): Unit

- (void)stopLocalization

public func stopLocalization() -> Void

public virtual void stopLocalization()

类型	描述
Void

getSyncResult

获得同步输出结果。如果SparseSpatialMap已暂停，或者未通过setResultAsyncMode将结果异步模式设为false，则返回值为空。

void easyar_SparseSpatialMap_getSyncResult(easyar_SparseSpatialMap * This, easyar_MotionInputData * motionInputData, easyar_OptionalOfSparseSpatialMapResult * Return)

std::optional<std::shared_ptr<SparseSpatialMapResult>> getSyncResult(std::shared_ptr<MotionInputData> motionInputData)

public @Nullable SparseSpatialMapResult getSyncResult(@Nonnull MotionInputData motionInputData)

fun getSyncResult(motionInputData: MotionInputData): SparseSpatialMapResult?

- (easyar_SparseSpatialMapResult *)getSyncResult:(easyar_MotionInputData *)motionInputData

public func getSyncResult(_ motionInputData: MotionInputData) -> SparseSpatialMapResult?

public virtual Optional<SparseSpatialMapResult> getSyncResult(MotionInputData motionInputData)

参数

名称	类型	描述
motionInputData	MotionInputData

类型	描述
Optional<SparseSpatialMapResult>

Table of Contents