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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
/*
* Copyright 2010 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.accelerometer;
public interface Accelerometer {
/**
* Get the current acceleration along the x, y, and z axis.
*
* The accelerometer is a motion sensor that detects the change (delta) in
* movement relative to the current position. The accelerometer can detect
* 3D movement along the x, y, and z axis. The acceleration is returned
* using the accelerometerSuccess callback function.
*
* <h1>iPhone Quirks</h1>
* <ul>
* <li>Phone doesn't have the concept of getting the current acceleration at
* any given point.</li>
* <li>You must watch the acceleration and capture the data at given time
* intervals.</li>
* <li>Thus, the getCurrentAcceleration function will give you the last
* value reported from a phoneGap watchAccelerometer call.</li>
* </ul>
*
* @param accelerationCallback
* @param options
*/
public void getCurrentAcceleration(AccelerationCallback accelerationCallback, AccelerationOptions options);
/**
* At a regular interval, get the acceleration along the x, y, and z axis.
*
* <h1>Description</h1>
*
* <p>
* The accelerometer is a motion sensor that detects the change (delta) in
* movement relative to the current position. The accelerometer can detect
* 3D movement along the x, y, and z axis.
* </p>
*
* <p>
* The accelerometer.watchAcceleration gets the device's current
* acceleration at a regular interval. Each time the Acceleration is
* retrieved, the accelerometerSuccess callback function is executed.
* Specify the interval in milliseconds via the frequency parameter in the
* acceleratorOptions object.
* </p>
*
* <p>
* The returned watch ID references references the accelerometer watch
* interval. The watch ID can be used with accelerometer.clearWatch to stop
* watching the accelerometer.
* <p/>
*
*
* <h1>Supported Platforms</h1>
* <ul>
* <li>Android</li>
* <li>iPhone</li>
* </ul>
*
* <h1>iPhone Quirks</h1>
* <ul>
* <li>At the interval requested, PhoneGap will call the success callback
* function and pass the accelerometer results.</li>
* <li>However, in requests to the device PhoneGap restricts the interval to
* minimum of every 40ms and a maximum of every 1000ms.
* <ul>
* <li>For example, if you request an interval of 3 seconds (3000ms),
* PhoneGap will request an interval of 1 second from the device but invoke
* the success callback at the requested interval of 3 seconds.</li>
* </ul>
* </li>
*
* </ul>
*
* @param options
* @param accelerationCallback
* @return
*/
public AccelerometerWatcher watchAcceleration(AccelerationOptions options, AccelerationCallback accelerationCallback);
/**
* Stop watching the Acceleration referenced by the watch ID parameter.
*
* <h1>Supported Platforms</h1>
* <ul>
* <li>Android</li>
* <li>iPhone</li>
* </ul>
*
* @param watcher
* The Object returned by accelerometer.watchAcceleration.
*
*/
public void clearWatch(AccelerometerWatcher watcher);
}
|
Revision |
Author |
Commited |
Message |
666
|
GeorgeS
|
Sun 13 May, 2012 18:11:48 +0000 |
|