Class AttitudeSensor
- Namespace
- easyar
AttitudeSensor calls the system-provided attitude sensor and outputs AttitudeSensorResult. When the device is no longer needed, call close to close it. It should not be used after close. Opening it multiple times at the same time is not recommended, as it may become unavailable or lose accuracy.
Constructors
AttitudeSensor
void easyar_AttitudeSensor__ctor(easyar_AttitudeSensor * * Return)
AttitudeSensor()
public AttitudeSensor()
constructor()
+ (easyar_AttitudeSensor *) create
public convenience init()
public AttitudeSensor()
Methods
isAvailable
Checks whether it is available. Returns true only on Android or iOS when the hardware supports it. Other operating systems are not supported yet.
bool easyar_AttitudeSensor_isAvailable(easyar_AttitudeSensor * This)
bool isAvailable()
public boolean isAvailable()
fun isAvailable(): Boolean
- (bool)isAvailable
public func isAvailable() -> Bool
public virtual bool isAvailable()
Returns
| Type | Description |
|---|---|
| Boolean |
output
Output port.
void easyar_AttitudeSensor_output(easyar_AttitudeSensor * This, easyar_AttitudeSensorResultSource * * Return)
std::shared_ptr<AttitudeSensorResultSource> output()
public @Nonnull AttitudeSensorResultSource output()
fun output(): AttitudeSensorResultSource
- (easyar_AttitudeSensorResultSource *)output
public func output() -> AttitudeSensorResultSource
public virtual AttitudeSensorResultSource output()
Returns
| Type | Description |
|---|---|
| AttitudeSensorResultSource |
open
Opens the device. The sampling period is determined by the internal implementation. If opening fails, returns false.
bool easyar_AttitudeSensor_open(easyar_AttitudeSensor * This)
bool open()
public boolean open()
fun open(): Boolean
- (bool)open
public func `open`() -> Bool
public virtual bool open()
Returns
| Type | Description |
|---|---|
| Boolean |
openWithSamplingPeriod
Opens the device with a specific sampling period. The sampling period may be limited by hardware and may not reach the specified value. If opening fails, returns false.
bool easyar_AttitudeSensor_openWithSamplingPeriod(easyar_AttitudeSensor * 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)
Parameters
| Name | Type | Description |
|---|---|---|
| samplingPeriodMilliseconds | Int32 |
Returns
| Type | Description |
|---|---|
| Boolean |
close
Closes the device. It should not be used after close.
void easyar_AttitudeSensor_close(easyar_AttitudeSensor * This)
void close()
public void close()
fun close(): Unit
- (void)close
public func close() -> Void
public virtual void close()
Returns
| Type | Description |
|---|---|
| Void |
getCurrentResult
Gets the current latest result. If no result has been obtained yet, returns empty.
easyar_OptionalOfAttitudeSensorResult easyar_AttitudeSensor_getCurrentResult(easyar_AttitudeSensor * This)
std::optional<AttitudeSensorResult> getCurrentResult()
public @Nullable AttitudeSensorResult getCurrentResult()
fun getCurrentResult(): AttitudeSensorResult?
- (easyar_AttitudeSensorResult *)getCurrentResult
public func getCurrentResult() -> AttitudeSensorResult?
public virtual Optional<AttitudeSensorResult> getCurrentResult()
Returns
| Type | Description |
|---|---|
| Optional<AttitudeSensorResult> |