Interface IRecenterOffsetManagerBackend

Platform specific implementation details of the RecenterOffsetManager.

Namespace: Holoride.ElasticSDK

Assembly: Holoride.ElasticSDK.Library.Runtime.dll

Syntax

public interface IRecenterOffsetManagerBackend

Properties

IsGlobalRecenterOffsetAvailable

Gets a value indicating whether global recenter offset is currently available through this backend, i.e. the current localization data provided via the StateReceiver is live localization data providing the actual global vehicle heading (and is not a replay or similar).

Declaration

bool IsGlobalRecenterOffsetAvailable { get; }

Property Value

Type	Description
bool

Methods

RequestCurrentValues()

Request current values for recenter offset and apply rate.

This may be implemented as an asynchronous operation, the result is returned via the RecenterOffsetApplyRateChanged and GlobalRecenterOffsetChanged events.

Declaration

void RequestCurrentValues()

SetGlobalRecenterOffset(float)

Stores a new global recenter offset value through this backend.

This may be implemented as an asynchronous operations, will fire UserRecentered once applied.

Declaration

void SetGlobalRecenterOffset(float value)

Parameters

Type	Name	Description
float	value	The new global recenter offset.

Events

GlobalRecenterOffsetChanged

Fired when the global recenter offset changed.

This is fired both when an external recentering operation was triggered, in which case it will be followed by the UserRecentered event, or when the backend performed a gradual correction to the current recenter offset, to mitigate headset drift. In the latter case, the new value will be slowly applied over time, based on the last received recenter offset apply rate via RecenterOffsetApplyRateChanged.

Declaration

event Action<float> GlobalRecenterOffsetChanged

Event Type

Type	Description
Action<float>

RecenterOffsetApplyRateChanged

Fired when the recenter apply rate has changed.

Declaration

event Action<float> RecenterOffsetApplyRateChanged

Event Type

Type	Description
Action<float>

UserRecentered

Fired when a user actively caused a recenter operation.

This may happen either due to an externally detected action (e.g. system recenter), or as a response to the application calling SetGlobalRecenterOffset(float), which is always expected to be caused by a user triggered recenter.

Declaration

event Action UserRecentered

Event Type

Type	Description
Action