Difference between revisions of "Geolocation"
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
+ | <languages /> | ||
+ | <!-- GIDEROSOBJ:Geolocation --> | ||
+ | '''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform winrt.png]]<br/> | ||
+ | '''<translate>Available since</translate>:''' Gideros 2012.8<br/> | ||
+ | '''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Object|Object]]<br/> | ||
− | + | === <translate>Description</translate> === | |
− | + | The [[Special:MyLanguage/Geolocation|Geolocation]] class is used to configure the parameters and dispatching of location and heading related events. | |
− | |||
− | |||
− | |||
− | The [[Geolocation]] class is used to configure the parameters and dispatching of location and heading related events. | ||
− | |||
− | |||
+ | === <translate>Examples</translate> === | ||
<source lang="lua"> | <source lang="lua"> | ||
geolocation = Geolocation.new() | geolocation = Geolocation.new() | ||
+ | |||
local function onLocationUpdate(event) | local function onLocationUpdate(event) | ||
print("location: ", event.latitude, event.longitude, event.altitude) | print("location: ", event.latitude, event.longitude, event.altitude) | ||
Line 26: | Line 27: | ||
{|- | {|- | ||
− | |||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
+ | === <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.getThreshold|Geolocation.getThreshold]] ''<translate>returns the previously set minimum distance threshold</translate>''<br/> | ||
+ | <!-- GIDEROSMTD:Geolocation.getThreshold() returns the previously set minimum distance threshold --> | ||
+ | [[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.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? --> | ||
+ | [[Special:MyLanguage/Geolocation.new|Geolocation.new]] ''<translate>creates new Geolocation instance</translate>''<br/> | ||
+ | <!-- GIDEROSMTD:Geolocation.new() creates new Geolocation instance --> | ||
+ | [[Special:MyLanguage/Geolocation.setAccuracy|Geolocation.setAccuracy]] ''<translate>sets the accuracy of the location data</translate>''<br/> | ||
+ | <!-- GIDEROSMTD:Geolocation.setAccuracy(accuracy) sets the accuracy of the location data --> | ||
+ | [[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/> | |
− | [[Geolocation | + | <!-- 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 --> | |
− | [[Geolocation | + | [[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/> | |
− | [[Geolocation | + | <!-- 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 --> | |
− | [[Geolocation: | + | [[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 --> | |
− | [[Geolocation:stopUpdatingHeading]] ''stops the generation of updates that report the heading''<br/> | ||
− | [[Geolocation:stopUpdatingLocation]] ''stops the generation of updates that report the current location''<br/> | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
− | + | === <translate>Events</translate> === | |
− | === Events === | + | [[Special:MyLanguage/Event.ERROR|Event.ERROR]]<br/> |
− | [[Event.ERROR]]<br/> | + | <!-- GIDEROSEVT:Event.ERROR error --> |
− | [[Event.HEADING_UPDATE]]<br/> | + | [[Special:MyLanguage/Event.HEADING_UPDATE|Event.HEADING_UPDATE]]<br/> |
− | [[Event.LOCATION_UPDATE]]<br/> | + | <!-- GIDEROSEVT:Event.HEADING_UPDATE headingUpdate --> |
− | + | [[Special:MyLanguage/Event.LOCATION_UPDATE|Event.LOCATION_UPDATE]]<br/> | |
− | === Constants === | + | <!-- GIDEROSEVT:Event.LOCATION_UPDATE locationUpdate --> |
− | + | === <translate>Constants</translate> === | |
|} | |} | ||
− | {{ | + | {{GIDEROS IMPORTANT LINKS}} |
Revision as of 13:57, 30 January 2020
Supported platforms:
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()
MethodsGeolocation.getAccuracy returns the previously set desired accuracy Geolocation:start starts the generation of updates that report the current location and heading |
EventsEvent.ERROR Constants |