Table of Contents

Class ObjectTracker

命名空間
easyar

ObjectTracker實現了3D object target的檢測和跟蹤。 ObjectTracker佔用(1 + SimultaneousNum)個camera的buffer。應使用camera的setBufferCapacity設置不少於所有組件佔用的camera的buffer數量。 創建之後,可以調用start/stop來開始和停止運行,start/stop是非常輕量的調用。 當不再需要該組件時,可以調用close對其進行關閉。close之後不應繼續使用。 ObjectTracker通過feedbackFrameSink輸入 FeedbackFrame ,應將 FeedbackFrameSource 連接到feedbackFrameSink上進行使用。 在 Target 可以被ObjectTracker跟蹤之前,你需要通過loadTarget/unloadTarget將它載入。可以通過傳入接口的回調來獲取load/unload的結果。

ObjectTracker

方法

isAvailable

返回true。

bool easyar_ObjectTracker_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

feedbackFrameSink

FeedbackFrame 輸入端口。FeedbackFrame中的InputFrame成員要求必須擁有圖像、時間戳和camera參數,camera支持針孔和魚眼相機。

void easyar_ObjectTracker_feedbackFrameSink(easyar_ObjectTracker * This, easyar_FeedbackFrameSink * * Return)
std::shared_ptr<FeedbackFrameSink> feedbackFrameSink()
public @Nonnull FeedbackFrameSink feedbackFrameSink()
fun feedbackFrameSink(): FeedbackFrameSink
- (easyar_FeedbackFrameSink *)feedbackFrameSink
public func feedbackFrameSink() -> FeedbackFrameSink
public virtual FeedbackFrameSink feedbackFrameSink()

傳回值

類型 描述
FeedbackFrameSink

bufferRequirement

當前組件佔用camera buffer的數量。

int easyar_ObjectTracker_bufferRequirement(easyar_ObjectTracker * This)
int bufferRequirement()
public int bufferRequirement()
fun bufferRequirement(): Int
- (int)bufferRequirement
public func bufferRequirement() -> Int32
public virtual int bufferRequirement()

傳回值

類型 描述
Int32

outputFrameSource

OutputFrame 輸出端口。

void easyar_ObjectTracker_outputFrameSource(easyar_ObjectTracker * 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

創建。

void easyar_ObjectTracker_create(easyar_ObjectTracker * * Return)
static std::shared_ptr<ObjectTracker> create()
public static @Nonnull ObjectTracker create()
companion object fun create(): ObjectTracker
+ (easyar_ObjectTracker *)create
public static func create() -> ObjectTracker
public static ObjectTracker create()

傳回值

類型 描述
ObjectTracker

setResultPostProcessing

設置結果後處理。 enablePersistentTargetInstance默認爲false,開啓時,如果 InputFrame 數據中包含空間信息,則 ImageTrackerResult 中的targetInstances會包含所有識別到的instance(包括當前未跟蹤的)。 enableMotionFusion默認爲false,開啓時,如果 InputFrame 數據中包含時間信息和空間信息,則 ImageTrackerResult 中的 targetInstances 的 pose 會進行平滑處理使用 RealTimeCoordinateTransform 進行處理。

void easyar_ObjectTracker_setResultPostProcessing(easyar_ObjectTracker * This, bool enablePersistentTargetInstance, bool enableMotionFusion)
void setResultPostProcessing(bool enablePersistentTargetInstance, bool enableMotionFusion)
public void setResultPostProcessing(boolean enablePersistentTargetInstance, boolean enableMotionFusion)
fun setResultPostProcessing(enablePersistentTargetInstance: Boolean, enableMotionFusion: Boolean): Unit
- (void)setResultPostProcessing:(bool)enablePersistentTargetInstance enableMotionFusion:(bool)enableMotionFusion
public func setResultPostProcessing(_ enablePersistentTargetInstance: Bool, _ enableMotionFusion: Bool) -> Void
public virtual void setResultPostProcessing(bool enablePersistentTargetInstance, bool enableMotionFusion)

參數

名稱 類型 描述
enablePersistentTargetInstance Boolean
enableMotionFusion Boolean

傳回值

類型 描述
Void

setResultAsyncMode

設置結果異步模式。如果結果通過outputFrameSource輸出,則應設置位true,如果結果通過getSyncResult獲取,則應設置爲false。默認enableAsync爲true。同步模式僅在輸入幀包含空間信息且使用XR License時可生效。

bool easyar_ObjectTracker_setResultAsyncMode(easyar_ObjectTracker * 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

開始跟蹤算法。

bool easyar_ObjectTracker_start(easyar_ObjectTracker * This)
bool start()
public boolean start()
fun start(): Boolean
- (bool)start
public func start() -> Bool
public virtual bool start()

傳回值

類型 描述
Boolean

stop

暫停跟蹤算法。調用start來重新啓動跟蹤。

void easyar_ObjectTracker_stop(easyar_ObjectTracker * This)
void stop()
public void stop()
fun stop(): Unit
- (void)stop
public func stop() -> Void
public virtual void stop()

傳回值

類型 描述
Void

close

關閉。close之後不應繼續使用。

void easyar_ObjectTracker_close(easyar_ObjectTracker * This)
void close()
public void close()
fun close(): Unit
- (void)close
public func close() -> Void
public virtual void close()

傳回值

類型 描述
Void

loadTarget

加載一個 Target 進入tracker。 Target 只有在成功加載進入tracker之後才能被識別和跟蹤。 這個方法是異步方法。加載過程可能會需要一些時間來完成,這段時間內新的和丟失的target的檢測可能會花比平時更多的時間,但是檢測到之後的跟蹤不受影響。如果你希望知道加載的結果,需要處理callback數據。callback將會在 CallbackScheduler 所指定的線程上被調用。跟蹤線程和除了其它加載/卸載之外的操作都不會被阻塞。

void easyar_ObjectTracker_loadTarget(easyar_ObjectTracker * This, easyar_Target * target, easyar_CallbackScheduler * callbackScheduler, easyar_FunctorOfVoidFromTargetAndBool callback)
void loadTarget(std::shared_ptr<Target> target, std::shared_ptr<CallbackScheduler> callbackScheduler, std::function<void(std::shared_ptr<Target>, bool)> callback)
public void loadTarget(@Nonnull Target target, @Nonnull CallbackScheduler callbackScheduler, @Nonnull FunctorOfVoidFromTargetAndBool callback)
fun loadTarget(target: Target, callbackScheduler: CallbackScheduler, callback: FunctorOfVoidFromTargetAndBool): Unit
- (void)loadTarget:(easyar_Target *)target callbackScheduler:(easyar_CallbackScheduler *)callbackScheduler callback:(void (^)(easyar_Target * target, bool status))callback
public func loadTarget(_ target: Target, _ callbackScheduler: CallbackScheduler, _ callback: @escaping (Target, Bool) -> Void) -> Void
public virtual void loadTarget(Target target, CallbackScheduler callbackScheduler, Action<Target, bool> callback)

參數

名稱 類型 描述
target Target
callbackScheduler CallbackScheduler
callback Action<,>

傳回值

類型 描述
Void

unloadTarget

從tracker中卸載 Target 。 這個方法是異步方法。卸載過程可能會需要一些時間來完成,這段時間內新的和丟失的target的檢測可能會花比平時更多的時間,但是檢測到之後的跟蹤不受影響。如果你希望知道卸載的結果,需要處理callback數據。callback將會在 CallbackScheduler 所指定的線程上被調用。跟蹤線程和除了其它加載/卸載之外的操作都不會被阻塞。

void easyar_ObjectTracker_unloadTarget(easyar_ObjectTracker * This, easyar_Target * target, easyar_CallbackScheduler * callbackScheduler, easyar_FunctorOfVoidFromTargetAndBool callback)
void unloadTarget(std::shared_ptr<Target> target, std::shared_ptr<CallbackScheduler> callbackScheduler, std::function<void(std::shared_ptr<Target>, bool)> callback)
public void unloadTarget(@Nonnull Target target, @Nonnull CallbackScheduler callbackScheduler, @Nonnull FunctorOfVoidFromTargetAndBool callback)
fun unloadTarget(target: Target, callbackScheduler: CallbackScheduler, callback: FunctorOfVoidFromTargetAndBool): Unit
- (void)unloadTarget:(easyar_Target *)target callbackScheduler:(easyar_CallbackScheduler *)callbackScheduler callback:(void (^)(easyar_Target * target, bool status))callback
public func unloadTarget(_ target: Target, _ callbackScheduler: CallbackScheduler, _ callback: @escaping (Target, Bool) -> Void) -> Void
public virtual void unloadTarget(Target target, CallbackScheduler callbackScheduler, Action<Target, bool> callback)

參數

名稱 類型 描述
target Target
callbackScheduler CallbackScheduler
callback Action<,>

傳回值

類型 描述
Void

targets

返回當前已經被加載進入tracker的target。如果異步的加載/卸載正在執行,在加載/卸載完成之前的返回值將不會反映這些加載/卸載的結果。

void easyar_ObjectTracker_targets(const easyar_ObjectTracker * This, easyar_ListOfTarget * * Return)
std::vector<std::shared_ptr<Target>> targets()
public java.util.@Nonnull ArrayList<@Nonnull Target> targets()
fun targets(): ArrayList<Target>
- (NSArray<easyar_Target *> *)targets
public func targets() -> [Target]
public virtual List<Target> targets()

傳回值

類型 描述
List<>

setSimultaneousNum

設置最大可被tracker跟蹤的目標個數。默認值爲1。

bool easyar_ObjectTracker_setSimultaneousNum(easyar_ObjectTracker * This, int num)
bool setSimultaneousNum(int num)
public boolean setSimultaneousNum(int num)
fun setSimultaneousNum(num: Int): Boolean
- (bool)setSimultaneousNum:(int)num
public func setSimultaneousNum(_ num: Int32) -> Bool
public virtual bool setSimultaneousNum(int num)

參數

名稱 類型 描述
num Int32

傳回值

類型 描述
Boolean

simultaneousNum

獲取最大可被tracker跟蹤的目標個數。默認值爲1。

int easyar_ObjectTracker_simultaneousNum(const easyar_ObjectTracker * This)
int simultaneousNum()
public int simultaneousNum()
fun simultaneousNum(): Int
- (int)simultaneousNum
public func simultaneousNum() -> Int32
public virtual int simultaneousNum()

傳回值

類型 描述
Int32

getSyncResult

獲得同步輸出結果。如果ObjectTracker已暫停,或者未通過setResultAsyncMode將結果異步模式設爲false,則返回值爲空。

void easyar_ObjectTracker_getSyncResult(easyar_ObjectTracker * This, easyar_MotionInputData * motionInputData, easyar_OptionalOfObjectTrackerResult * Return)
std::optional<std::shared_ptr<ObjectTrackerResult>> getSyncResult(std::shared_ptr<MotionInputData> motionInputData)
public @Nullable ObjectTrackerResult getSyncResult(@Nonnull MotionInputData motionInputData)
fun getSyncResult(motionInputData: MotionInputData): ObjectTrackerResult?
- (easyar_ObjectTrackerResult *)getSyncResult:(easyar_MotionInputData *)motionInputData
public func getSyncResult(_ motionInputData: MotionInputData) -> ObjectTrackerResult?
public virtual Optional<ObjectTrackerResult> getSyncResult(MotionInputData motionInputData)

參數

名稱 類型 描述
motionInputData MotionInputData

傳回值

類型 描述
Optional<ObjectTrackerResult>