File: DragControls.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 (119 lines) | stat: -rw-r--r-- 2,457 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
<!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>
		[page:EventDispatcher] &rarr;

		<h1>[name]</h1>

		<p class="desc">
		This class can be used to provide a drag'n'drop interaction.
		</p>

		<h2>Example</h2>

		<p>[example:misc_controls_drag misc / controls / drag ]</p>

		<code>
var controls = new THREE.DragControls( objects, camera, renderer.domElement );

// add event listener to highlight dragged objects

controls.addEventListener( 'dragstart', function ( event ) {

	event.object.material.emissive.set( 0xaaaaaa );

} );

controls.addEventListener( 'dragend', function ( event ) {

	event.object.material.emissive.set( 0x000000 );

} );

		</code>

		<h2>Constructor</h2>

		<h3>[name]( [param:Array objects], [param:Camera camera], [param:HTMLDOMElement domElement] )</h3>
		<p>
			<p>
				[page:Array objects]: An array of draggable 3D objects.
			</p>
			<p>
			[page:Camera camera]: The camera of the rendered scene.
			</p>
			<p>
			[page:HTMLDOMElement domElement]: The HTML element used for event listeners.
			</p>
			<p>
				Creates a new instance of [name].
			</p>
		</p>

		<h2>Events</h2>

		<h3>dragstart</h3>
		<p>
			Fires when the user starts to drag a 3D object.
		</p>

		<h3>drag</h3>
		<p>
			Fires when the user drags a 3D object.
		</p>

		<h3>dragend</h3>
		<p>
			Fires when the user has finished dragging a 3D object.
		</p>

		<h3>hoveron</h3>
		<p>
			Fires when the pointer is moved onto a 3D object, or onto one of its children.
		</p>

		<h3>hoveroff</h3>
		<p>
			Fires when the pointer is moved out of a 3D object.
		</p>

		<h2>Properties</h2>

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

		<h2>Methods</h2>

		<p>See the base [page:EventDispatcher] class for common methods.</p>

		<h3>[method:null activate] ()</h3>
		<p>
			Adds the event listeners of the controls.
		</p>

		<h3>[method:null deactivate] ()</h3>
		<p>
			Removes the event listeners of the controls.
		</p>

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

		<h2>Source</h2>

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