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