Class Magnetometer

命名空间

easyar

Magnetometer调用了系统提供的磁力计，输出 MagnetometerResult 。 当不再需要该设备时，可以调用close对其进行关闭。close之后不应继续使用。 不建议同时打开多次，可能会无法使用或精度下降。

Magnetometer

构造函数

Magnetometer

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

void easyar_Magnetometer__ctor(easyar_Magnetometer * * Return)

Magnetometer()

public Magnetometer()

constructor()

+ (easyar_Magnetometer *) create

public convenience init()

public Magnetometer()

方法

isAvailable

检查是否可用。只在Android或iOS上且硬件支持时返回true。其他操作系统暂不支持。

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

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

输出端口。

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

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。

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

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。

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

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之后不应继续使用。

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

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

获取当前的最新结果。如果结果尚未获取到，返回空。

• c
• cpp
• java
• kotlin
• objective-c
• swift
• csharp

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>