Table of Contents

Class Magnetometer

命名空間
easyar

Magnetometer調用了系統提供的磁力計，輸出 MagnetometerResult 。 當不再需要該設備時，可以調用close對其進行關閉。close之後不應繼續使用。 不建議同時打開多次，可能會無法使用或精度下降。

Magnetometer

建構函式

Magnetometer 

void easyar_Magnetometer__ctor(easyar_Magnetometer * * Return)
Magnetometer()
public Magnetometer()
constructor()
+ (easyar_Magnetometer *) create
public convenience init()
public Magnetometer()

方法

isAvailable

檢查是否可用。只在Android或iOS上且硬體支援時返回true。其他作業系統暫不支援。

bool easyar_Magnetometer_isAvailable(easyar_Magnetometer * This)
bool isAvailable()
public boolean isAvailable()
fun isAvailable(): Boolean
- (bool)isAvailable
public func isAvailable() -> Bool
public virtual bool isAvailable()

傳回值

類型 描述
Boolean

output

輸出埠。

void easyar_Magnetometer_output(easyar_Magnetometer * This, easyar_MagnetometerResultSource * * Return)
std::shared_ptr<MagnetometerResultSource> output()
public @Nonnull MagnetometerResultSource output()
fun output(): MagnetometerResultSource
- (easyar_MagnetometerResultSource *)output
public func output() -> MagnetometerResultSource
public virtual MagnetometerResultSource output()

傳回值

類型 描述
MagnetometerResultSource

open

打開設備。取樣週期由內部實現所確定。如果打開失敗，返回false。

bool easyar_Magnetometer_open(easyar_Magnetometer * This)
bool open()
public boolean open()
fun open(): Boolean
- (bool)open
public func `open`() -> Bool
public virtual bool open()

傳回值

類型 描述
Boolean

openWithSamplingPeriod

以特定取樣週期打開設備。取樣週期會受到硬體限制而可能無法達到指定值。如果打開失敗，返回false。

bool easyar_Magnetometer_openWithSamplingPeriod(easyar_Magnetometer * This, int samplingPeriodMilliseconds)
bool openWithSamplingPeriod(int samplingPeriodMilliseconds)
public boolean openWithSamplingPeriod(int samplingPeriodMilliseconds)
fun openWithSamplingPeriod(samplingPeriodMilliseconds: Int): Boolean
- (bool)openWithSamplingPeriod:(int)samplingPeriodMilliseconds
public func openWithSamplingPeriod(_ samplingPeriodMilliseconds: Int32) -> Bool
public virtual bool openWithSamplingPeriod(int samplingPeriodMilliseconds)

參數

名稱 類型 描述
samplingPeriodMilliseconds Int32

傳回值

類型 描述
Boolean

close

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

void easyar_Magnetometer_close(easyar_Magnetometer * This)
void close()
public void close()
fun close(): Unit
- (void)close
public func close() -> Void
public virtual void close()

傳回值

類型 描述
Void

getCurrentResult

取得目前的最新結果。如果結果尚未取得，返回空。

easyar_OptionalOfMagnetometerResult easyar_Magnetometer_getCurrentResult(easyar_Magnetometer * This)
std::optional<MagnetometerResult> getCurrentResult()
public @Nullable MagnetometerResult getCurrentResult()
fun getCurrentResult(): MagnetometerResult?
- (easyar_MagnetometerResult *)getCurrentResult
public func getCurrentResult() -> MagnetometerResult?
public virtual Optional<MagnetometerResult> getCurrentResult()

傳回值

類型 描述
Optional<MagnetometerResult>