Difference between revisions of "Geolocation"
From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight") |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
<!-- GIDEROSOBJ:Geolocation --> | <!-- GIDEROSOBJ:Geolocation --> | ||
| − | ''' | + | '''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform winrt.png]]<br/> |
| − | ''' | + | '''Available since:''' Gideros 2012.8<br/> |
| − | ''' | + | '''Inherits from:''' [[Object]]<br/> |
| − | === | + | === Description === |
| − | The | + | The '''Geolocation''' Class is used to configure the parameters and dispatching of location and heading related events. |
| − | === | + | === Examples === |
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
geolocation = Geolocation.new() | geolocation = Geolocation.new() | ||
| Line 24: | Line 23: | ||
geolocation:addEventListener(Event.HEADING_UPDATE, onHeadingUpdate) | geolocation:addEventListener(Event.HEADING_UPDATE, onHeadingUpdate) | ||
geolocation:start() | geolocation:start() | ||
| − | </ | + | </syntaxhighlight> |
{|- | {|- | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | === | + | === Methods === |
| − | [[ | + | [[Geolocation.getAccuracy]] ''returns the previously set desired accuracy''<br/><!--GIDEROSMTD:Geolocation.getAccuracy() returns the previously set desired accuracy--> |
| − | <!-- GIDEROSMTD:Geolocation.getAccuracy() returns the previously set desired accuracy --> | + | [[Geolocation.getThreshold]] ''returns the previously set minimum distance threshold''<br/><!--GIDEROSMTD:Geolocation.getThreshold() returns the previously set minimum distance threshold--> |
| − | [[ | + | [[Geolocation.isAvailable]] ''does this device have the capability to determine current location?''<br/><!--GIDEROSMTD:Geolocation.isAvailable() does this device have the capability to determine current location?--> |
| − | <!-- GIDEROSMTD:Geolocation.getThreshold() returns the previously set minimum distance threshold --> | + | [[Geolocation.isHeadingAvailable]] ''does this device have the capability to determine heading?''<br/><!--GIDEROSMTD:Geolocation.isHeadingAvailable() does this device have the capability to determine heading?--> |
| − | [[ | + | [[Geolocation.new]] ''creates new Geolocation instance''<br/><!--GIDEROSMTD:Geolocation.new() creates new Geolocation instance--> |
| − | <!-- GIDEROSMTD:Geolocation.isAvailable() does this device have the capability to determine current location? --> | + | [[Geolocation.setAccuracy]] ''sets the accuracy of the location data''<br/><!--GIDEROSMTD:Geolocation.setAccuracy(accuracy) sets the accuracy of the location data--> |
| − | [[ | + | [[Geolocation.setThreshold]] ''sets the threshold''<br/><!--GIDEROSMTD:Geolocation.setThreshold(threshold) sets the threshold--> |
| − | <!-- GIDEROSMTD:Geolocation.isHeadingAvailable() does this device have the capability to determine heading? --> | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Geolocation.new() creates new Geolocation instance --> | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Geolocation.setAccuracy(accuracy) sets the accuracy of the location data --> | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Geolocation.setThreshold(threshold) sets the threshold --> | ||
| − | [[ | + | [[Geolocation:start]] ''starts the generation of updates that report the current location and heading''<br/><!--GIDEROSMTD:Geolocation:start() starts the generation of updates that report the current location and heading--> |
| − | <!-- GIDEROSMTD: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''<br/><!--GIDEROSMTD:Geolocation:startUpdatingHeading() starts the generation of updates that report the heading--> |
| − | [[ | + | [[Geolocation:startUpdatingLocation]] ''starts the generation of updates that report the current location''<br/><!--GIDEROSMTD:Geolocation:startUpdatingLocation() starts the generation of updates that report the current location--> |
| − | <!-- GIDEROSMTD:Geolocation:startUpdatingHeading() starts the generation of updates that report the heading --> | + | [[Geolocation:stop]] ''stops the generation of updates that report the current location and heading''<br/><!--GIDEROSMTD: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''<br/><!--GIDEROSMTD:Geolocation:stopUpdatingHeading() stops the generation of updates that report the heading--> |
| − | <!-- GIDEROSMTD:Geolocation:startUpdatingLocation() starts the generation of updates that report the current location --> | + | [[Geolocation:stopUpdatingLocation]] ''stops the generation of updates that report the current location''<br/><!--GIDEROSMTD:Geolocation:stopUpdatingLocation() stops the generation of updates that report the current location--> |
| − | [[ | ||
| − | <!-- GIDEROSMTD:Geolocation:stop() stops the generation of updates that report the current location and heading --> | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Geolocation:stopUpdatingHeading() stops the generation of updates that report the heading --> | ||
| − | [[ | ||
| − | <!-- 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;"| | ||
| − | === | + | === Events === |
| − | [[ | + | [[Event.ERROR]]<br/><!--GIDEROSEVT:Event.ERROR error--> |
| − | <!-- GIDEROSEVT:Event.ERROR error --> | + | [[Event.HEADING_UPDATE]]<br/><!--GIDEROSEVT:Event.HEADING_UPDATE headingUpdate--> |
| − | [[ | + | [[Event.LOCATION_UPDATE]]<br/><!--GIDEROSEVT:Event.LOCATION_UPDATE locationUpdate--> |
| − | <!-- GIDEROSEVT:Event.HEADING_UPDATE headingUpdate --> | + | === Constants === |
| − | [[ | ||
| − | <!-- GIDEROSEVT:Event.LOCATION_UPDATE locationUpdate --> | ||
| − | === | ||
|} | |} | ||
{{GIDEROS IMPORTANT LINKS}} | {{GIDEROS IMPORTANT LINKS}} | ||
Latest revision as of 06:54, 10 October 2023
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 |
