AR + GPS Location  3.0.0
All Classes Namespaces Functions Variables Properties Events Pages
ARLocation.MockLocationProvider Class Reference
Inheritance diagram for ARLocation.MockLocationProvider:
ARLocation.AbstractLocationProvider ARLocation.ILocationProvider

Public Attributes

override string Name => "MockLocationProvider"
 
override bool IsCompassEnabled => true
 
Location mockLocation = new Location()
 
- Public Attributes inherited from ARLocation.AbstractLocationProvider
bool HasStarted => Status == LocationProviderStatus.Started
 

Protected Member Functions

override? HeadingReading ReadHeading ()
 Reads the heading from the device; should be implemented by each provider. More...
 
override? LocationReading ReadLocation ()
 Reads the location from the device; should be implemented by each provider. More...
 
override void RequestLocationAndCompassUpdates ()
 Requests the location and compass updates from the device; should be implemented by each provider. More...
 
override void UpdateLocationRequestStatus ()
 Updates the location service status from the device; should be implemented by each provider. More...
 
- Protected Member Functions inherited from ARLocation.AbstractLocationProvider
virtual void InnerOnEnabled ()
 
void EmitLocationUpdated ()
 
void EmitLocationUpdatedRaw ()
 
void EmitCompassUpdated ()
 
void UpdateLocation (LocationReading newLocation)
 
void UpdateHeading (HeadingReading newHeading)
 
bool ShouldUpdateHeading (HeadingReading newHeading)
 
bool ShouldUpdateLocation (LocationReading newLocation)
 

Additional Inherited Members

- Public Member Functions inherited from ARLocation.AbstractLocationProvider
virtual IEnumerator Start (uint maxWaitTime=10000, uint delay=0)
 
void ForceLocationUpdate ()
 
virtual void Update ()
 
void Restart ()
 
void ResetStartPoint ()
 
void SetCompassLowPassFactor (double factor)
 
string GetStatusString ()
 
string GetInfoString ()
 
void OnEnabled (LocationEnabledDelegate del)
 
void OnFail (LocationFailedDelegate del)
 
void Pause ()
 Pauses location updates More...
 
void Resume ()
 Resumes location updates More...
 
- Protected Attributes inherited from ARLocation.AbstractLocationProvider
double LowPassFilterFactor
 
- Properties inherited from ARLocation.AbstractLocationProvider
abstract string Name [get]
 The name of the location provider. More...
 
LocationProviderOptions Options [get, set]
 The options of the location provider. More...
 
LocationReading CurrentLocation [get, protected set]
 Gets or sets the current location. More...
 
LocationReading LastLocation [get, protected set]
 Gets or sets the previous location. More...
 
LocationReading LastLocationRaw [get, protected set]
 
LocationReading CurrentLocationRaw [get, protected set]
 Gets or sets the previous raw location reading. More...
 
HeadingReading CurrentHeading [get, protected set]
 The current heading reading. More...
 
HeadingReading LastHeading [get, protected set]
 The previous heading reading. More...
 
LocationReading FirstLocation [get, protected set]
 The start point, i.e., the first measured location. More...
 
LocationProviderStatus Status [get, protected set]
 Gets or sets the current status of the location provider. More...
 
bool IsEnabled [get, protected set]
 If true, the location provider is enablied and getting regular location updated from the device. More...
 
bool FirstReading [get, protected set]
 If true, the first reading has not occured yet. More...
 
abstract bool IsCompassEnabled [get]
 If true, the provider has a functioning magnetic compass sensor. More...
 
float StartTime [get, protected set]
 The start time of the location provider. More...
 
bool Paused [get, protected set]
 If true, location updates are paused. More...
 
int LocationUpdateCount [get, protected set]
 
bool ApplyCompassTiltCompensationOnAndroid = true [get, set]
 
double DistanceFromStartPoint [get]
 
- Properties inherited from ARLocation.ILocationProvider
string Name [get]
 
LocationProviderOptions Options [get, set]
 
LocationReading CurrentLocation [get]
 
LocationReading CurrentLocationRaw [get]
 
LocationReading LastLocation [get]
 
LocationReading LastLocationRaw [get]
 
LocationReading FirstLocation [get]
 
HeadingReading CurrentHeading [get]
 
HeadingReading LastHeading [get]
 
float StartTime [get]
 
bool IsCompassEnabled [get]
 
double DistanceFromStartPoint [get]
 
bool IsEnabled [get]
 
bool Paused [get]
 
int LocationUpdateCount [get]
 
bool HasStarted [get]
 
bool ApplyCompassTiltCompensationOnAndroid [get, set]
 
- Events inherited from ARLocation.AbstractLocationProvider
LocationUpdatedDelegate LocationUpdated
 Event for when a new location data is received. More...
 
CompassUpdateDelegate CompassUpdated
 Event for when a new compass data is received. More...
 
LocationEnabledDelegate LocationEnabled
 
LocationFailedDelegate LocationFailed
 
LocationUpdatedDelegate LocationUpdatedRaw
 
- Events inherited from ARLocation.ILocationProvider
LocationUpdatedDelegate LocationUpdated
 
LocationUpdatedDelegate LocationUpdatedRaw
 
CompassUpdateDelegate CompassUpdated
 
LocationEnabledDelegate LocationEnabled
 
LocationFailedDelegate LocationFailed
 

Detailed Description

Definition at line 6 of file MockLocationProvider.cs.

Member Function Documentation

◆ ReadHeading()

override? HeadingReading ARLocation.MockLocationProvider.ReadHeading ( )
protectedvirtual

Reads the heading from the device; should be implemented by each provider.

Returns
The heading.

Implements ARLocation.AbstractLocationProvider.

Definition at line 14 of file MockLocationProvider.cs.

◆ ReadLocation()

override? LocationReading ARLocation.MockLocationProvider.ReadLocation ( )
protectedvirtual

Reads the location from the device; should be implemented by each provider.

Returns
The location.

Implements ARLocation.AbstractLocationProvider.

Definition at line 31 of file MockLocationProvider.cs.

◆ RequestLocationAndCompassUpdates()

override void ARLocation.MockLocationProvider.RequestLocationAndCompassUpdates ( )
protectedvirtual

Requests the location and compass updates from the device; should be implemented by each provider.

Implements ARLocation.AbstractLocationProvider.

Definition at line 46 of file MockLocationProvider.cs.

◆ UpdateLocationRequestStatus()

override void ARLocation.MockLocationProvider.UpdateLocationRequestStatus ( )
protectedvirtual

Updates the location service status from the device; should be implemented by each provider.

Implements ARLocation.AbstractLocationProvider.

Definition at line 51 of file MockLocationProvider.cs.


The documentation for this class was generated from the following file: