Class StateReceiver

This is the central data source for localization data and any other data provided by StateReceiverBackends.

Inheritance

object

Object

ScriptableObject

SingletonBase

Singleton<StateReceiver>

StateReceiver

Inherited Members

Singleton<StateReceiver>.Instance

SingletonBase.SingletonOnCreate()

SingletonBase.SingletonOnEnable()

SingletonBase.SingletonOnDisable()

Namespace: Holoride.ElasticSDK

Assembly: Holoride.ElasticSDK.Library.Runtime.dll

Syntax

[PublicAPI]
[HelpURL("http://localhost:8080/api/Holoride.ElasticSDK.StateReceiver.html")]
[Obfuscation(Exclude = true, ApplyToMembers = true)]
public sealed class StateReceiver : Singleton<StateReceiver>

Properties

AvailableBackends

Gets the list of all available backends.

Declaration

public static IReadOnlyList<StateReceiverBackend> AvailableBackends { get; }

Property Value

Type	Description
IReadOnlyList<StateReceiverBackend>

CurrentBackend

Gets or sets the backend currently in use.

Note: Beware when changing the CurrentBackend you need to re-acquire the references to the Pivot and Route.

Declaration

public static StateReceiverBackend CurrentBackend { get; set; }

Property Value

Type	Description
StateReceiverBackend

EditorBackend

Declaration

public StateReceiverBackend EditorBackend { get; }

Property Value

Type	Description
StateReceiverBackend

Pivot

Gets the pivot of the CurrentBackend, used as reference point for the mapping between real world GeoCoordinate and the coordinate system in Unity.

Note: Beware when changing the CurrentBackend you need to re-acquire the reference to the Pivot.

Declaration

public static ISharedGeoCoordinate Pivot { get; }

Property Value

Type	Description
ISharedGeoCoordinate

Route

Gets the current route of the CurrentBackend.

Note: Beware when changing the CurrentBackend you need to re-acquire the reference to the Route.

Declaration

public static Route Route { get; }

Property Value

Type	Description
Route

State

Declaration

public static StateReceiverState State { get; }

Property Value

Type	Description
StateReceiverState

StationaryBackend

Declaration

public StateReceiverBackend StationaryBackend { get; }

Property Value

Type	Description
StateReceiverBackend

TravelBackend

Declaration

public StateReceiverBackend TravelBackend { get; }

Property Value

Type	Description
StateReceiverBackend

TravelInformationState

Declaration

public static TravelInformationState TravelInformationState { get; }

Property Value

Type	Description
TravelInformationState

VehicleSensorState

Declaration

public static VehicleSensorState VehicleSensorState { get; }

Property Value

Type	Description
VehicleSensorState

Methods

AddListener(IStateReceiverListener)

Registers a new listener that should be notified of state receiver events. All registered listeners will automatically migrated when the selected TravelBackend changes.

Declaration

public static void AddListener(IStateReceiverListener listener)

Parameters

Type	Name	Description
IStateReceiverListener	listener	The listener to add.

NotifyListenerConfigurationChanged()

Declaration

public static void NotifyListenerConfigurationChanged()

RemoveListener(IStateReceiverListener)

Removes a listener previously registered with AddListener(IStateReceiverListener).

Declaration

public static void RemoveListener(IStateReceiverListener listener)

Parameters

Type	Name	Description
IStateReceiverListener	listener	The listener to remove.

TryGetBackend(Type, out StateReceiverBackend)

Get the first available backend with the specified type.

Declaration

public static bool TryGetBackend(Type type, out StateReceiverBackend result)

Parameters

Type	Name	Description
Type	type	The type of the backend to get.
StateReceiverBackend	result	The first backend with the specified type.

Returns

Type	Description
bool	Whether a backend with the specified type exists and could be returned.

TryGetBackend<T>(out T)

Get the first available backend with the specified type.

Declaration

public static bool TryGetBackend<T>(out T result) where T : StateReceiverBackend

Parameters

Type	Name	Description
T	result	The first backend with the specified type.

Returns

Type	Description
bool	Whether a backend with the specified type exists and could be returned.

Type Parameters

Name	Description
T	The type of the backend to get.

Events

OnBackendChanged

Invoked when the CurrentBackend has changed.

Declaration

public static event StateReceiver.BackendChangedHandler OnBackendChanged

Event Type

Type	Description
StateReceiver.BackendChangedHandler

Remarks

StateReceiver.BackendChangedHandler takes a StateReceiverBackend argument.