File: FirstPersonControls.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 (165 lines) | stat: -rw-r--r-- 4,230 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!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">
			This class is an alternative implementation of [page:FlyControls].
		</p>

		<h2>Example</h2>

		<p>[example:webgl_geometry_terrain webgl / geometry / terrain ]</p>

		<h2>Constructor</h2>

		<h3>[name]( [param:Camera object], [param:HTMLDOMElement domElement] )</h3>
		<p>
			<p>
				[page:Camera object]: The camera to be controlled.
			</p>
			<p>
				[page:HTMLDOMElement domElement]: The HTML element used for event listeners.
			</p>
			<p>
				Creates a new instance of [name].
			</p>
		</p>

		<h2>Properties</h2>

		<h3>[property:Boolean activeLook]</h3>
		<p>
			Whether or not it's possible to look around. Default is *true*.
		</p>

		<h3>[property:Boolean autoForward]</h3>
		<p>
			Whether or not the camera is automatically moved forward. Default is *false*.
		</p>

		<h3>[property:Boolean constrainVertical]</h3>
		<p>
			Whether or not looking around is vertically constrained by [[page:.verticalMin], [page:.verticalMax]]. Default is *false*.
		</p>

		<h3>[property:HTMLDOMElement domElement]</h3>
		<p>
			The HTMLDOMElement used to listen for mouse / touch events. This must be passed in the constructor; changing it here will
			not set up new event listeners.
		</p>

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

		<h3>[property:Number heightCoef]</h3>
		<p>
			Determines how much faster the camera moves when it's y-component is near [page:.heightMax]. Default is *1*.
		</p>

		<h3>[property:Number heightMax]</h3>
		<p>
			Upper camera height limit used for movement speed adjusment. Default is *1*.
		</p>

		<h3>[property:Number heightMin]</h3>
		<p>
			Lower camera height limit used for movement speed adjusment. Default is *0*.
		</p>

		<h3>[property:Boolean heightSpeed]</h3>
		<p>
			Whether or not the camera's height influences the forward movement speed. Default is *false*.
			Use the properties [page:.heightCoef], [page:.heightMin] and [page:.heightMax] for configuration.
		</p>

		<h3>[property:Boolean lookVertical]</h3>
		<p>
			Whether or not it's possible to vertically look around. Default is *true*.
		</p>

		<h3>[property:Number lookSpeed]</h3>
		<p>
			The look around speed. Default is *0.005*.
		</p>

		<h3>[property:Boolean mouseDragOn]</h3>
		<p>
			Whether or not the mouse is pressed down. Read-only property.
		</p>

		<h3>[property:Number movementSpeed]</h3>
		<p>
			The movement speed. Default is *1*.
		</p>

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

		<h3>[property:Number verticalMax]</h3>
		<p>
			How far you can vertically look around, upper limit. Range is 0 to Math.PI radians. Default is *Math.PI*.
		</p>

		<h3>[property:Number verticalMin]</h3>
		<p>
			How far you can vertically look around, lower limit. Range is 0 to Math.PI radians. Default is *0*.
		</p>

		<h2>Methods</h2>

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

		<h3>[method:null handleResize] ()</h3>
		<p>
			Should be called if the application window is resized.
		</p>

		<h3>[method:FirstPersonControls lookAt]( [param:Vector3 vector] )<br />
		[method:FirstPersonControls lookAt]( [param:Float x], [param:Float y], [param:Float z] )</h3>
		<p>
			<p>
				<p>
					vector - A vector representing the target position.
				</p>
				<p>
					Optionally, the x, y, z components of the world space position.
				</p>
			</p>
			<p>
				Ensures the controls orient the camera towards the defined target position.
			</p>
		</p>

		<h3>[method:null update] ( [param:Number delta] )</h3>
		<p>
			<p>
				[page:Number delta]: Time delta value.
			</p>
			<p>
				Updates the controls. Usually called in the animation loop.
			</p>
		</p>

		<h2>Source</h2>

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