File: Box3Helper.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 (66 lines) | stat: -rw-r--r-- 1,575 bytes parent folder | download | duplicates (2)
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
<!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:Object3D] &rarr; [page:Line] &rarr; [page:LineSegments] &rarr;

		<h1>[name]</h1>

		<p class="desc">
			Helper object to visualize a [page:Box3].
		</p>


		<h2>Example</h2>

		<code>
		var box = new THREE.Box3();
		box.setFromCenterAndSize( new THREE.Vector3( 1, 1, 1 ), new THREE.Vector3( 2, 1, 3 ) );

		var helper = new THREE.Box3Helper( box, 0xffff00 );
		scene.add( helper );
		</code>


		<h2>Constructor</h2>


		<h3>[name]( [param:Box3 box], [param:Color color] )</h3>
		<p>
		[page:Box3 box]  -- the Box3 to show.<br />
		[page:Color color] --  (optional) the box's color. Default is 0xffff00.<br /><br />

		Creates a new wireframe box that represents the passed Box3.
		</p>

		<h2>Properties</h2>
		<p>See the base [page:LineSegments] class for common properties.</p>

		<h3>[property:Box3 box]</h3>
		<p>The Box3 being visualized.</p>


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


		<h3>[method:void updateMatrixWorld]( [param:Boolean force] )</h3>
		<p>
			This overrides the method in the base [page:Object3D] class so that it
			also updates the wireframe box to the extent of the [page:Box3Helper.box .box]
			property.
		</p>

		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>