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