File: DeviceOrientationControls.html

package info (click to toggle)
three.js 111%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 15,184 kB
  • sloc: javascript: 133,174; makefile: 24; sh: 1
file content (89 lines) | stat: -rw-r--r-- 1,962 bytes parent folder | download | duplicates (4)
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
<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="list.js"></script>
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>

		<h1>[name]</h1>

		<p class="desc">
			Can be used to orient the camera based on the mobile device's orientation.
		</p>

		<h2>Example</h2>

		<p>[example:misc_controls_deviceorientation misc / controls / deviceorientation ]</p>

		<h2>Constructor</h2>

		<h3>[name]( [param:Camera object] )</h3>
		<p>
			<p>
				[page:Camera object]: The camera to be controlled.
			</p>
			<p>
				Creates a new instance of [name].
			</p>
		</p>

		<h2>Properties</h2>

		<h3>[property:Number alphaOffset]</h3>
		<p>
			The alpha offset in radians. Default is *0*.
		</p>

		<h3>[property:Object deviceOrientation]</h3>
		<p>
			The current *deviceorientation* event object.
		</p>

		<h3>[property:Boolean enabled]</h3>
		<p>
			Whether or not the controls are enabled.
		</p>

		<h3>[property:Camera object]</h3>
		<p>
			The camera to be controlled.
		</p>

		<h3>[property:Number screenOrientation]</h3>
		<p>
			The orientation in degrees (in 90-degree increments) of the viewport relative to the device's natural orientation. Default is *0*.
		</p>

		<h2>Methods</h2>

		<h3>[method:null connect] ()</h3>
		<p>
			Adds the event listeners of the controls and enables it.
		</p>

		<h3>[method:null disconnect] ()</h3>
		<p>
			Removes the event listeners of the controls and disables it.
		</p>

		<h3>[method:null dispose] ()</h3>
		<p>
			Should be called if the controls is no longer required.
		</p>

		<h3>[method:null update] ()</h3>
		<p>
			Updates the controls. Usually called in the animation loop.
		</p>

		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/examples/js/controls/DeviceOrientationControls.js examples/js/controls/DeviceOrientationControls.js]
		</p>
	</body>
</html>