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を返す。その他のOSは現時点では未対応。

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>