提交 174c6699 编写于 作者: L looeee

Updated docs

上级 f62cff89
......@@ -194,6 +194,9 @@
<h2>Helpers</h2>
<h3>[page:BoundingBoxHelper]</h3>
<div>BoundingBoxHelper has been deprecated. Use [page:BoxHelper] instead.</div>
<h3>[page:EdgesHelper]</h3>
<div>EdgesHelper has been removed. Use [page:EdgesGeometry] instead.</div>
......
<!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:Mesh] &rarr;
<h1>[name]</h1>
<div class="desc">A helper object to show the world-axis-aligned bounding box for an object.</div>
<h2>Example</h2>
<code>var hex = 0xff0000;
var sphereMaterial = new THREE.MeshLambertMaterial( {color: 0x00ff00} );
var sphere = new THREE.Mesh( new THREE.SphereGeometry( 30, 12, 12), sphereMaterial );
scene.add( sphere );
var bbox = new THREE.BoundingBoxHelper( sphere, hex );
bbox.update();
scene.add( bbox );
</code>
<div>
Note that this helper will create a wireframe [page:Mesh] object with a [page:BoxGeometry];
the resulting bounding box object will therefore have face diagonals. You may want to
use [page:BoxHelper], which generates a [page:LineSegments] object without face diagonals.
</div>
<h2>Constructor</h2>
<h3>[name]( [page:Object3D object], [page:Number hex] )</h3>
<div>
[page:Object3D object] -- Object3D -- the object3D to show the world-axis-aligned boundingbox.<br />
[page:Number hex] -- hexadecimal value that defines the box's color. Default is 0x888888.
</div>
<h2>Properties</h2>
<div>See the base [page:Mesh] class for common properties.</div>
<h3>[property:Object3D object]</h3>
<div>Contains the object3D to show the world-axis-aligned boundingbox.</div>
<h3>[property:Box3 box]</h3>
<div>Contains the bounding box of the object.</div>
<h2>Methods</h2>
<div>See the base [page:LineSegments] class for common methods.</div>
<h3>[method:null update]()</h3>
<div>Updates the BoundingBoxHelper based on the object property.</div>
<h2>Source</h2>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</body>
</html>
......@@ -114,7 +114,6 @@ var list = {
"Extras / Helpers": [
[ "ArrowHelper", "api/extras/helpers/ArrowHelper" ],
[ "AxisHelper", "api/extras/helpers/AxisHelper" ],
[ "BoundingBoxHelper", "api/extras/helpers/BoundingBoxHelper" ],
[ "BoxHelper", "api/extras/helpers/BoxHelper" ],
[ "CameraHelper", "api/extras/helpers/CameraHelper" ],
[ "DirectionalLightHelper", "api/extras/helpers/DirectionalLightHelper" ],
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册