Class Player

The data obtained by the vehicle sensors.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
Player
Implements
Namespace: Holoride.ElasticSDK
Assembly: Holoride.ElasticSDK.Runtime.dll
Syntax
[DefaultExecutionOrder(-5000)]
[DisallowMultipleComponent]
[HelpURL("http://localhost:8080/api/Holoride.ElasticSDK.Player.html")]
public class Player : MonoBehaviour, IStateReceiverLocalizationEventListener, IStateReceiverListener

Fields

OnConnect

Declaration
[Tooltip("Fired when connection to the underlying vehicle localization service has been successfully established.")]
public UnityEvent OnConnect
Field Value
Type Description
UnityEvent

OnConnectError

Declaration
[Tooltip("Fired when connection to the underlying vehicle localization service failed.")]
public StringUnityEvent OnConnectError
Field Value
Type Description
StringUnityEvent

OnDisconnect

Declaration
[Tooltip("Fired when connection to the underlying vehicle localization service has been lost or was closed successfully.")]
public UnityEvent OnDisconnect
Field Value
Type Description
UnityEvent

OnRouteChanged

Declaration
[Tooltip("Fired when the route has changed.")]
public UnityEvent OnRouteChanged
Field Value
Type Description
UnityEvent

OnUserRecenter

Declaration
[Tooltip("Fired when the user triggered a successful manual recenter via button press.")]
public UnityEvent OnUserRecenter
Field Value
Type Description
UnityEvent

OnVehicleLocalizationAvailable

Declaration
[Tooltip("Fired when vehicle localization becomes available.")]
public Player.VehicleLocalizationStatusUnityEvent OnVehicleLocalizationAvailable
Field Value
Type Description
Player.VehicleLocalizationStatusUnityEvent

OnVehicleLocalizationReset

Declaration
[Tooltip("Fired when the service reports that localization has been reset.")]
public UnityEvent OnVehicleLocalizationReset
Field Value
Type Description
UnityEvent

OnVehicleLocalizationStart

Declaration
[Tooltip("Called as soon as the first geo coordinate is set.")]
public UnityEvent OnVehicleLocalizationStart
Field Value
Type Description
UnityEvent

OnVehicleLocalizationUnavailable

Declaration
[Tooltip("Fired when vehicle localization becomes unavailable.")]
public Player.VehicleLocalizationStatusUnityEvent OnVehicleLocalizationUnavailable
Field Value
Type Description
Player.VehicleLocalizationStatusUnityEvent

Methods

OnMapAccessTokenReceived(string)

Declaration
public void OnMapAccessTokenReceived(string token)
Parameters
Type Name Description
string token

Recenter()

Sends broadcast to service to trigger a recenter process for the vehicle.

Declaration
public void Recenter()
Remarks

Delayed by 3 frames to avoid race conditions.

Events

OnVehicleLocalizationReceivedAsync

Declaration
public event Action<VehicleSensorState> OnVehicleLocalizationReceivedAsync
Event Type
Type Description
Action<VehicleSensorState>

Explicit Interface Implementations

IStateReceiverLocalizationEventListener.OnConnect()

Declaration
void IStateReceiverLocalizationEventListener.OnConnect()

IStateReceiverLocalizationEventListener.OnConnectError(StateReceiverInitializationError)

Declaration
void IStateReceiverLocalizationEventListener.OnConnectError(StateReceiverInitializationError error)
Parameters
Type Name Description
StateReceiverInitializationError error

IStateReceiverLocalizationEventListener.OnDisconnect()

Declaration
void IStateReceiverLocalizationEventListener.OnDisconnect()

IStateReceiverLocalizationEventListener.OnRouteChanged()

Declaration
void IStateReceiverLocalizationEventListener.OnRouteChanged()

IStateReceiverLocalizationEventListener.OnVehicleLocalizationReceivedAsync(VehicleSensorState)

Declaration
void IStateReceiverLocalizationEventListener.OnVehicleLocalizationReceivedAsync(VehicleSensorState state)
Parameters
Type Name Description
VehicleSensorState state

IStateReceiverLocalizationEventListener.OnVehicleLocalizationReset()

Declaration
void IStateReceiverLocalizationEventListener.OnVehicleLocalizationReset()

IStateReceiverLocalizationEventListener.OnVehicleLocalizationStart()

Declaration
void IStateReceiverLocalizationEventListener.OnVehicleLocalizationStart()

IStateReceiverLocalizationEventListener.OnVehicleLocalizationStatusChanged(VehicleLocalizationStatus)

Declaration
void IStateReceiverLocalizationEventListener.OnVehicleLocalizationStatusChanged(VehicleLocalizationStatus status)
Parameters
Type Name Description
VehicleLocalizationStatus status

Implements