Class GeoLocationModule

Inheritance
Object
ScriptableSettingsBase
ScriptableSettingsBase<GeoLocationModule>
ScriptableSettings<GeoLocationModule>
GeoLocationModule
Inherited Members
Unity.XRTools.Utils.Internal.ScriptableSettingsBase.GetInstanceByType(System.Type)
Namespace: Unity.MARS.Providers
Syntax
[ScriptableSettingsPath("Assets/MARS/UserSettings")]
[ModuleOrder(1073741824)]
[MovedFrom("Unity.MARS")]
public class GeoLocationModule : ScriptableSettings<GeoLocationModule>, IModuleDependency<MARSDatabase>, IModuleDependency<SlowTaskModule>, IModuleBuildCallbacks, IModule

Fields

MaxLatitude

Declaration
public const float MaxLatitude = 90F
Field Value
Type Description
Single

MaxLongitude

Declaration
public const float MaxLongitude = 180F
Field Value
Type Description
Single

Properties

continuousUpdates

When enabled, the location service will continue to poll for updates after acquiring initial location

Declaration
public bool continuousUpdates { get; set; }
Property Value
Type Description
Boolean

Methods

SetCurrentLocationAndUpdateTrait(GeographicCoordinate)

Given a GeographicCoordinate, immediately update the GeoLocationModule and MARS database with it

Declaration
public void SetCurrentLocationAndUpdateTrait(GeographicCoordinate location)
Parameters
Type Name Description
GeographicCoordinate location

TryGetGeoLocation(out GeographicCoordinate)

Declaration
public bool TryGetGeoLocation(out GeographicCoordinate coordinate)
Parameters
Type Name Description
GeographicCoordinate coordinate
Returns
Type Description
Boolean

TryStartService()

Declaration
public bool TryStartService()
Returns
Type Description
Boolean

Events

GeoLocationChanged

Declaration
public event Action<GeographicCoordinate> GeoLocationChanged
Event Type
Type Description
Action<GeographicCoordinate>

Explicit Interface Implementations

IModule.LoadModule()

Declaration
void IModule.LoadModule()
Implements

IModule.UnloadModule()

Declaration
void IModule.UnloadModule()
Implements

IModuleDependency<MARSDatabase>.ConnectDependency(MARSDatabase)

Declaration
void IModuleDependency<MARSDatabase>.ConnectDependency(MARSDatabase dependency)
Parameters
Type Name Description
MARSDatabase dependency
Implements

IModuleDependency<SlowTaskModule>.ConnectDependency(SlowTaskModule)

Declaration
void IModuleDependency<SlowTaskModule>.ConnectDependency(SlowTaskModule dependency)
Parameters
Type Name Description
SlowTaskModule dependency
Implements