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

Проверяет доступность. Возвращает true только на Android или iOS при поддержке аппаратным обеспечением. Другие операционные системы пока не поддерживаются.

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>