litesoft
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/*
* Copyright 2011 Daniel Kurka
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.googlecode.gwtphonegap.client.compass;
/**
* Obtains the direction that the device is pointing.
*
* @author Daniel Kurka
*
*/
public interface Compass {
/**
* Get the current compass heading.
*
* The compass is a sensor that detects the direction or heading that the
* device is pointed. It measures the heading in degrees from 0 to 359.99.
*
* The compass heading is returned using the {@link CompassCallback }
*
* <h2>Supported Platforms</h2>
* <ul>
*
* <li>Android</li>
* <li>iPhone</li>
*
* </ul>
*
*
* @param options
* the options when capturing data
* @param callback
* the callback to invoke when data is ready or operation has
* failed
*/
public void getCurrentHeading(CompassOptions options, CompassCallback callback);
/**
* At a regular interval, get the compass heading in degrees.
*
* The compass is a sensor that detects the direction or heading that the
* device is pointed. It measures the heading in degrees from 0 to 359.99.
*
* The compass.watchHeading gets the device's current heading at a regular
* interval. Each time the heading is retrieved, the headingSuccess callback
* function is executed. Specify the interval in milliseconds via the
* frequency parameter in the compassOptions object.
*
* The returned watch ID references references the compass watch interval.
* The watch ID can be used with compass.clearWatch to stop watching the
* compass.
*
* <h2>Supported Platforms</h2>
* <ul>
*
* <li>Android</li>
* <li>iPhone</li>
*
* </ul>
*
*
* @param options
* the options when capturing data
* @param callback
* the callback to invoke when data is ready or operation has
* failed
* @return reference to clear the watcher
*/
public CompassWatcher watchHeading(CompassOptions options, CompassCallback callback);
/**
* Stop watching the compass referenced by the watch ID parameter.
*
* @param watcher
* the watcher from
* {@link #watchHeading(CompassOptions, CompassCallback)}
*/
public void clearWatcher(CompassWatcher watcher);
}
|
Revision |
Author |
Commited |
Message |
666
|
GeorgeS
|
Sun 13 May, 2012 18:11:48 +0000 |
|