Difference between revisions of "Geolocation"

(adjusted content)
Line 29: Line 29:
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Methods</translate> ===
 
=== <translate>Methods</translate> ===
[[Special:MyLanguage/Geolocation.getAccuracy|Geolocation.getAccuracy]] ''<translate>returns the previously set desired accuracy</translate>''<br/><!-- GIDEROSMTD:Geolocation.getAccuracy() returns the previously set desired accuracy -->
+
[[Special:MyLanguage/Geolocation.getAccuracy|Geolocation.getAccuracy]] ''<translate>returns the previously set desired accuracy</translate>''<br/>
[[Special:MyLanguage/Geolocation.getThreshold|Geolocation.getThreshold]] ''<translate>returns the previously set minimum distance threshold</translate>''<br/><!-- GIDEROSMTD:Geolocation.getThreshold() returns the previously set minimum distance threshold -->
+
<!-- GIDEROSMTD:Geolocation.getAccuracy() returns the previously set desired accuracy -->
[[Special:MyLanguage/Geolocation.isAvailable|Geolocation.isAvailable]] ''<translate>does this device have the capability to determine current location?</translate>''<br/><!-- GIDEROSMTD:Geolocation.isAvailable() does this device have the capability to determine current location? -->
+
[[Special:MyLanguage/Geolocation.getThreshold|Geolocation.getThreshold]] ''<translate>returns the previously set minimum distance threshold</translate>''<br/>
[[Special:MyLanguage/Geolocation.isHeadingAvailable|Geolocation.isHeadingAvailable]] ''<translate>does this device have the capability to determine heading?</translate>''<br/><!-- GIDEROSMTD:Geolocation.isHeadingAvailable() does this device have the capability to determine heading? -->
+
<!-- GIDEROSMTD:Geolocation.getThreshold() returns the previously set minimum distance threshold -->
[[Special:MyLanguage/Geolocation.new|Geolocation.new]] ''<translate>Creates new Geolocation instance</translate>''<br/><!-- GIDEROSMTD:Geolocation.new() Creates new Geolocation instance -->
+
[[Special:MyLanguage/Geolocation.isAvailable|Geolocation.isAvailable]] ''<translate>does this device have the capability to determine current location?</translate>''<br/>
[[Special:MyLanguage/Geolocation.setAccuracy|Geolocation.setAccuracy]] ''<translate>of the location data</translate>''<br/><!-- GIDEROSMTD:Geolocation.setAccuracy(accuracy) of the location data -->
+
<!-- GIDEROSMTD:Geolocation.isAvailable() does this device have the capability to determine current location? -->
[[Special:MyLanguage/Geolocation.setThreshold|Geolocation.setThreshold]] ''<translate>threshold</translate>''<br/><!-- GIDEROSMTD:Geolocation.setThreshold(threshold) threshold -->
+
[[Special:MyLanguage/Geolocation.isHeadingAvailable|Geolocation.isHeadingAvailable]] ''<translate>does this device have the capability to determine heading?</translate>''<br/>
[[Special:MyLanguage/Geolocation:start|Geolocation:start]] ''<translate>starts the generation of updates that report the current location and heading</translate>''<br/><!-- GIDEROSMTD:Geolocation:start() starts the generation of updates that report the current location and heading -->
+
<!-- GIDEROSMTD:Geolocation.isHeadingAvailable() does this device have the capability to determine heading? -->
[[Special:MyLanguage/Geolocation:startUpdatingHeading|Geolocation:startUpdatingHeading]] ''<translate>starts the generation of updates that report the heading</translate>''<br/><!-- GIDEROSMTD:Geolocation:startUpdatingHeading() starts the generation of updates that report the heading -->
+
[[Special:MyLanguage/Geolocation.new|Geolocation.new]] ''<translate>creates new Geolocation instance</translate>''<br/>
[[Special:MyLanguage/Geolocation:startUpdatingLocation|Geolocation:startUpdatingLocation]] ''<translate>starts the generation of updates that report the current location</translate>''<br/><!-- GIDEROSMTD:Geolocation:startUpdatingLocation() starts the generation of updates that report the current location -->
+
<!-- GIDEROSMTD:Geolocation.new() creates new Geolocation instance -->
[[Special:MyLanguage/Geolocation:stop|Geolocation:stop]] ''<translate>stops the generation of updates that report the current location and heading</translate>''<br/><!-- GIDEROSMTD:Geolocation:stop() stops the generation of updates that report the current location and heading -->
+
[[Special:MyLanguage/Geolocation.setAccuracy|Geolocation.setAccuracy]] ''<translate>sets the accuracy of the location data</translate>''<br/>
[[Special:MyLanguage/Geolocation:stopUpdatingHeading|Geolocation:stopUpdatingHeading]] ''<translate>stops the generation of updates that report the heading</translate>''<br/><!-- GIDEROSMTD:Geolocation:stopUpdatingHeading() stops the generation of updates that report the heading -->
+
<!-- GIDEROSMTD:Geolocation.setAccuracy(accuracy) sets the accuracy of the location data -->
[[Special:MyLanguage/Geolocation:stopUpdatingLocation|Geolocation:stopUpdatingLocation]] ''<translate>stops the generation of updates that report the current location</translate>''<br/><!-- GIDEROSMTD:Geolocation:stopUpdatingLocation() stops the generation of updates that report the current location -->
+
[[Special:MyLanguage/Geolocation.setThreshold|Geolocation.setThreshold]] ''<translate>sets the threshold</translate>''<br/>
 +
<!-- GIDEROSMTD:Geolocation.setThreshold(threshold) sets the threshold -->
 +
[[Special:MyLanguage/Geolocation:start|Geolocation:start]] ''<translate>starts the generation of updates that report the current location and heading</translate>''<br/>
 +
<!-- GIDEROSMTD:Geolocation:start() starts the generation of updates that report the current location and heading -->
 +
[[Special:MyLanguage/Geolocation:startUpdatingHeading|Geolocation:startUpdatingHeading]] ''<translate>starts the generation of updates that report the heading</translate>''<br/>
 +
<!-- GIDEROSMTD:Geolocation:startUpdatingHeading() starts the generation of updates that report the heading -->
 +
[[Special:MyLanguage/Geolocation:startUpdatingLocation|Geolocation:startUpdatingLocation]] ''<translate>starts the generation of updates that report the current location</translate>''<br/>
 +
<!-- GIDEROSMTD:Geolocation:startUpdatingLocation() starts the generation of updates that report the current location -->
 +
[[Special:MyLanguage/Geolocation:stop|Geolocation:stop]] ''<translate>stops the generation of updates that report the current location and heading</translate>''<br/>
 +
<!-- GIDEROSMTD:Geolocation:stop() stops the generation of updates that report the current location and heading -->
 +
[[Special:MyLanguage/Geolocation:stopUpdatingHeading|Geolocation:stopUpdatingHeading]] ''<translate>stops the generation of updates that report the heading</translate>''<br/>
 +
<!-- GIDEROSMTD:Geolocation:stopUpdatingHeading() stops the generation of updates that report the heading -->
 +
[[Special:MyLanguage/Geolocation:stopUpdatingLocation|Geolocation:stopUpdatingLocation]] ''<translate>stops the generation of updates that report the current location</translate>''<br/>
 +
<!-- GIDEROSMTD:Geolocation:stopUpdatingLocation() stops the generation of updates that report the current location -->
  
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Events</translate> ===
 
=== <translate>Events</translate> ===
[[Special:MyLanguage/Event.ERROR|Event.ERROR]]<br/><!-- GIDEROSEVT:Event.ERROR error-->
+
[[Special:MyLanguage/Event.ERROR|Event.ERROR]]<br/>
[[Special:MyLanguage/Event.HEADING_UPDATE|Event.HEADING_UPDATE]]<br/><!-- GIDEROSEVT:Event.HEADING_UPDATE headingUpdate-->
+
<!-- GIDEROSEVT:Event.ERROR error -->
[[Special:MyLanguage/Event.LOCATION_UPDATE|Event.LOCATION_UPDATE]]<br/><!-- GIDEROSEVT:Event.LOCATION_UPDATE locationUpdate-->
+
[[Special:MyLanguage/Event.HEADING_UPDATE|Event.HEADING_UPDATE]]<br/>
 +
<!-- GIDEROSEVT:Event.HEADING_UPDATE headingUpdate -->
 +
[[Special:MyLanguage/Event.LOCATION_UPDATE|Event.LOCATION_UPDATE]]<br/>
 +
<!-- GIDEROSEVT:Event.LOCATION_UPDATE locationUpdate -->
 
=== <translate>Constants</translate> ===
 
=== <translate>Constants</translate> ===
 
|}
 
|}

Revision as of 00:16, 5 January 2020


Supported platforms: Platform android.pngPlatform ios.pngPlatform winrt.png
Available since: Gideros 2012.8
Inherits from: Object

Description

The Geolocation class is used to configure the parameters and dispatching of location and heading related events.

Examples

geolocation = Geolocation.new()

local function onLocationUpdate(event)
	print("location: ", event.latitude, event.longitude, event.altitude)
end

local function onHeadingUpdate(event)
	print("heading: ", event.magneticHeading, event.trueHeading)
end

geolocation:addEventListener(Event.LOCATION_UPDATE, onLocationUpdate)
geolocation:addEventListener(Event.HEADING_UPDATE, onHeadingUpdate)
geolocation:start()

Methods

Geolocation.getAccuracy returns the previously set desired accuracy
Geolocation.getThreshold returns the previously set minimum distance threshold
Geolocation.isAvailable does this device have the capability to determine current location?
Geolocation.isHeadingAvailable does this device have the capability to determine heading?
Geolocation.new creates new Geolocation instance
Geolocation.setAccuracy sets the accuracy of the location data
Geolocation.setThreshold sets the threshold
Geolocation:start starts the generation of updates that report the current location and heading
Geolocation:startUpdatingHeading starts the generation of updates that report the heading
Geolocation:startUpdatingLocation starts the generation of updates that report the current location
Geolocation:stop stops the generation of updates that report the current location and heading
Geolocation:stopUpdatingHeading stops the generation of updates that report the heading
Geolocation:stopUpdatingLocation stops the generation of updates that report the current location

Events

Event.ERROR
Event.HEADING_UPDATE
Event.LOCATION_UPDATE

Constants