Skip to content

Commit c8f8707

Browse files
Mugen87Mugen87
authored
ArcballControls: Derive from Controls. (#29109)
1 parent 86cfa03 commit c8f8707

File tree

7 files changed

+187
-189
lines changed

7 files changed

+187
-189
lines changed

‎docs/examples/en/controls/ArcballControls.html

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<link type="text/css" rel="stylesheet" href="page.css" />
88
</head>
99
<body>
10-
[page:EventDispatcher] &rarr;
10+
[page:Controls] &rarr;
1111

1212
<h1>[name]</h1>
1313

@@ -78,9 +78,9 @@ <h3>[name]( [param:Camera camera], [param:HTMLDOMElement domElement], [param:Sce
7878
<p>
7979
[page:Camera camera]: (required) The camera to be controlled. The camera must not be a child of another object, unless that object is the scene itself.<br><br>
8080

81-
[page:HTMLDOMElement domElement]: The HTML element used for event listeners.<br><br>
81+
[page:HTMLDOMElement domElement]: The HTML element used for event listeners. (optional)<br><br>
8282

83-
[page:Scene scene]: The scene rendered by the camera. If not given, gizmos cannot be shown.
83+
[page:Scene scene]: The scene rendered by the camera. If not given, gizmos cannot be shown. (optional)
8484
</p>
8585

8686
<h2>Events</h2>
@@ -102,6 +102,8 @@ <h3>end</h3>
102102

103103
<h2>Properties</h2>
104104

105+
<p>See the base [page:Controls] class for common properties.</p>
106+
105107
<h3>[property:Boolean adjustNearFar]</h3>
106108
<p>
107109
If true, camera's near and far values will be adjusted every time zoom is performed trying to mantain the same visible portion
@@ -125,17 +127,6 @@ <h3>
125127
The damping inertia used if [page:.enableAnimations] is set to true.
126128
</p>
127129

128-
<h3>[property:HTMLDOMElement domElement]</h3>
129-
<p>
130-
The HTMLDOMElement used to listen for mouse / touch events. This must be passed in the constructor; changing it here will
131-
not set up new event listeners.
132-
</p>
133-
134-
<h3>[property:Boolean enabled]</h3>
135-
<p>
136-
When set to `false`, the controls will not respond to user input. Default is `true`.
137-
</p>
138-
139130
<h3>[property:Boolean enableAnimations]</h3>
140131
<p>
141132
Set to true to enable animations for rotation (damping) and focus operation. Default is true.
@@ -211,9 +202,10 @@ <h3>[property:Float wMax]</h3>
211202
Maximum angular velocity allowed on rotation animation start.
212203
</p>
213204

214-
215205
<h2>Methods</h2>
216206

207+
<p>See the base [page:Controls] class for common methods.</p>
208+
217209
<h3>[method:undefined activateGizmos] ( [param:Boolean isActive] )</h3>
218210
<p>
219211
Make gizmos more or less visible.
@@ -224,11 +216,6 @@ <h3>[method:undefined copyState] ()</h3>
224216
Copy the current state to clipboard (as a readable JSON text).
225217
</p>
226218

227-
<h3>[method:undefined dispose] ()</h3>
228-
<p>
229-
Remove all the event listeners, cancel any pending animation and clean the scene from gizmos and grid.
230-
</p>
231-
232219
<h3>[method:undefined pasteState] ()</h3>
233220
<p>
234221
Set the controls state from the clipboard, assumes that the clipboard stores a JSON text as saved from [page:.copyState].
@@ -274,11 +261,6 @@ <h3>[method:Boolean unsetMouseAction] ( mouse, key )</h3>
274261
Keyboard modifiers can be specified as 'CTRL', 'SHIFT' or null if not needed.
275262
</p>
276263

277-
<h3>[method:undefined update] ()</h3>
278-
<p>
279-
Update the controls. Must be called after any manual changes to the camera's transform.
280-
</p>
281-
282264
<h3>[method:Raycaster getRaycaster] ()</h3>
283265
<p>
284266
Returns the [page:Raycaster] object that is used for user interaction. This object is shared between all instances of

‎docs/examples/en/controls/Controls.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ <h2>Constructor</h2>
2020
<h3>[name]( [param:Object3D object], [param:HTMLDOMElement domElement] )</h3>
2121

2222
<p>
23-
[page:Object3D object]: The object the controls should manage (usually the camera).
23+
[page:Object3D object] - The object the controls should manage (usually the camera).
2424
</p>
2525
<p>
26-
[page:HTMLDOMElement domElement]: The HTML element used for event listeners (optional).
26+
[page:HTMLDOMElement domElement]: The HTML element used for event listeners. (optional)
2727
</p>
2828
<p>
2929
Creates a new instance of [name].

‎docs/examples/en/controls/DragControls.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h3>[name]( [param:Array objects], [param:Camera camera], [param:HTMLDOMElement
6060
[page:Camera camera]: The camera of the rendered scene.
6161
</p>
6262
<p>
63-
[page:HTMLDOMElement domElement]: The HTML element used for event listeners.
63+
[page:HTMLDOMElement domElement]: The HTML element used for event listeners. (optional)
6464
</p>
6565
<p>
6666
Creates a new instance of [name].

‎docs/examples/en/controls/FirstPersonControls.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ <h3>[name]( [param:Camera object], [param:HTMLDOMElement domElement] )</h3>
3838
[page:Camera object]: The camera to be controlled.
3939
</p>
4040
<p>
41-
[page:HTMLDOMElement domElement]: The HTML element used for event listeners.
41+
[page:HTMLDOMElement domElement]: The HTML element used for event listeners. (optional)
4242
</p>
4343
<p>
4444
Creates a new instance of [name].

‎docs/examples/en/controls/FlyControls.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ <h3>[name]( [param:Camera object], [param:HTMLDOMElement domElement] )</h3>
3939
[page:Camera object]: The camera to be controlled.
4040
</p>
4141
<p>
42-
[page:HTMLDOMElement domElement]: The HTML element used for event listeners.
42+
[page:HTMLDOMElement domElement]: The HTML element used for event listeners. (optional)
4343
</p>
4444
<p>
4545
Creates a new instance of [name].

0 commit comments

Comments
 (0)