javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
							<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		[page:Object3D] &rarr; [page:Line] &rarr;

		<h1>[name]</h1>

		<p class="desc">The PolarGridHelper is an object to define polar grids. Grids are two-dimensional arrays of lines.</p>

		<h2>Code Example</h2>

		<code>
		const radius = 10;
		const sectors = 16;
		const rings = 8;
		const divisions = 64;

		const helper = new THREE.PolarGridHelper( radius, sectors, rings, divisions );
		scene.add( helper );
		</code>

		<h2>Examples</h2>

		<p>
			[example:webgl_helpers WebGL / helpers]
		</p>

		<h2>Constructor</h2>

		<h3>[name]( [param:Number radius], [param:Number sectors], [param:Number rings], [param:Number divisions], [param:Color color1], [param:Color color2] )</h3>
		<p>
		radius -- The radius of the polar grid. This can be any positive number. Default is 10.<br />
		sectors -- The number of sectors the grid will be divided into. This can be any positive integer. Default is 16.<br />
		rings -- The number of rings. This can be any positive integer. Default is 8.<br />
		divisions -- The number of line segments used for each circle. This can be any positive integer that is 3 or greater. Default is 64.<br />
		color1 -- The first color used for grid elements. This can be a [page:Color], a hexadecimal value and an CSS-Color name. Default is 0x444444 <br />
		color2 -- The second color used for grid elements. This can be a [page:Color], a hexadecimal value and an CSS-Color name. Default is 0x888888
		</p>
		<p>
		Creates a new [name] of radius 'radius' with 'sectors' number of sectors and 'rings' number of rings, where each circle is smoothed into 'divisions' number of line segments. Colors are optional.
		</p>

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

		<h3>[method:undefined dispose]()</h3>
		<p>
		Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
		</p>

		<h2>Source</h2>

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