Home Explore Help
Sign In
javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Add docs for Box3Helper and PlaneHelper

Vidar Tonaas Fauske 8 years ago
parent
575a12da98
commit
dc6dc5a1ab
2 changed files with 127 additions and 0 deletions
Unified View Show Diff Stats
  1. 63 0
      docs/api/helpers/Box3Helper.html
  2. 64 0
      docs/api/helpers/PlaneHelper.html

+ 63 - 0
docs/api/helpers/Box3Helper.html
View File 

@@ -0,0 +1,63 @@
 
+<!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:LineSegments] &rarr;
 
+
 
+		<h1>[name]</h1>
 
+
 
+		<div class="desc">
 
+			Helper object to visualize a [page:Box3].
 
+		</div>
 
+
 
+
 
+		<h2>Example</h2>
 
+
 
+		<code>
 
+		var box = new THREE.Box3();
 
+		// Initialize the box somehow:
 
+		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]( [page:Box3 box], [page:Color color] )</h3>
 
+		<div>
 
+		[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.
 
+		</div>
 
+
 
+		<h2>Properties</h2>
 
+		<div>See the base [page:LineSegments] class for common properties.</div>
 
+
 
+		<h3>[property:Box3 box]</h3>
 
+		<div>The Box3 being visualized.</div>
 
+
 
+
 
+		<h2>Methods</h2>
 
+		<div>See the base [page:LineSegments] class for common methods.</div>
 
+
 
+
 
+		<h3>[method:void updateMatrixWorld]( force )</h3>
 
+		<div>
 
+			Overridden to also update the wireframe box to the extent of the passed
 
+			[page:Box3Helper.box].
 
+		</div>
 
+
 
+		<h2>Source</h2>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>

+ 64 - 0
docs/api/helpers/PlaneHelper.html
View File 

@@ -0,0 +1,64 @@
 
+<!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:LineSegments] &rarr;
 
+
 
+		<h1>[name]</h1>
 
+
 
+		<div class="desc">
 
+			Helper object to visualize a [page:Plane].
 
+		</div>
 
+
 
+
 
+		<h2>Example</h2>
 
+
 
+		<code>
 
+		var plane = new THREE.Plane(new THREE.Vector3(1, 1, 0.2), 3);
 
+		helper = new THREE.PlaneHelper( plane, 1, 0xffff00 );
 
+		scene.add( helper );
 
+		</code>
 
+
 
+
 
+		<h2>Constructor</h2>
 
+
 
+
 
+		<h3>[name]( [page:Plane plane], [page:Float size], [page:Color hex] )</h3>
 
+		<div>
 
+		[page:Plane plane] --  the plane to visualize.<br />
 
+		[page:Float size] -- (optional) side length of plane helper. Default is 1.
 
+		[page:Color color] --  (optional) the color of the helper. Default is 0xffff00.<br /><br />
 
+
 
+		Creates a new wireframe representation of the passed plane.
 
+		</div>
 
+
 
+		<h2>Properties</h2>
 
+		<div>See the base [page:LineSegments] class for common properties.</div>
 
+
 
+		<h3>[property:Plane plane]</h3>
 
+		<div>The [page:Plane plane] being visualized.</div>
 
+
 
+		<h3>[property:Float size]</h3>
 
+		<div>The side lengths of plane helper.</div>
 
+
 
+
 
+		<h2>Methods</h2>
 
+		<div>See the base [page:LineSegments] class for common methods.</div>
 
+
 
+		<h3>[method:void updateMatrixWorld]( force )</h3>
 
+		<div>
 
+			Overridden to also update the helper size and location according to passed
 
+			[page:PlaneHelper.plane] and the [page:PlaneHelper.size] property.
 
+		</div>
 
+
 
+		<h2>Source</h2>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>