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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
							<!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:Curve] &rarr; [page:CurvePath] &rarr; [page:Path] &rarr;

		<h1>[name]</h1>

		<p class="desc">
			Defines an arbitrary 2d shape plane using paths with optional holes. It
			can be used with [page:ExtrudeGeometry], [page:ShapeGeometry], to get
			points, or to get triangulated faces.
		</p>

		<h2>Code Example</h2>

		<code>
		const heartShape = new THREE.Shape();

		heartShape.moveTo( 25, 25 );
		heartShape.bezierCurveTo( 25, 25, 20, 0, 0, 0 );
		heartShape.bezierCurveTo( - 30, 0, - 30, 35, - 30, 35 );
		heartShape.bezierCurveTo( - 30, 55, - 10, 77, 25, 95 );
		heartShape.bezierCurveTo( 60, 77, 80, 55, 80, 35 );
		heartShape.bezierCurveTo( 80, 35, 80, 0, 50, 0 );
		heartShape.bezierCurveTo( 35, 0, 25, 25, 25, 25 );

		const extrudeSettings = { 
			depth: 8, 
			bevelEnabled: true, 
			bevelSegments: 2, 
			steps: 2, 
			bevelSize: 1, 
			bevelThickness: 1 
		};

		const geometry = new THREE.ExtrudeGeometry( heartShape, extrudeSettings );

		const mesh = new THREE.Mesh( geometry, new THREE.MeshPhongMaterial() );
		</code>

		<h2>Examples</h2>

		<p>
			[example:webgl_geometry_shapes geometry / shapes ]<br />
			[example:webgl_geometry_extrude_shapes geometry / extrude / shapes ]<br />
			[example:webgl_geometry_extrude_shapes2 geometry / extrude / shapes2 ]<br />
		</p>

		<h2>Constructor</h2>

		<h3>[name]( [param:Array points] )</h3>
		<p>
			points -- (optional) array of [page:Vector2 Vector2s].<br /><br />

			Creates a Shape from the points. The first point defines the offset, then
			successive points are added to the [page:CurvePath.curves curves] array as
			[page:LineCurve LineCurves].<br /><br />

			If no points are specified, an empty shape is created and the
			[page:.currentPoint] is set to the origin.
		</p>

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

		<h3>[property:String uuid]</h3>
		<p>
			[link:http://en.wikipedia.org/wiki/Universally_unique_identifier UUID] of
			this instance. This gets automatically assigned, so this shouldn't be
			edited.
		</p>

		<h3>[property:Array holes]</h3>
		<p>An array of [page:Path paths] that define the holes in the shape.</p>

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

		<h3>[method:Array extractPoints]( [param:Integer divisions] )</h3>
		<p>
			divisions -- The fineness of the result.<br /><br />

			Call [page:Curve.getPoints getPoints] on the shape and the [page:.holes]
			array, and return an object of the form:
			<code> { shape holes } </code>
			where shape and holes are arrays of [page:Vector2 Vector2s].
		</p>

		<h3>[method:Array getPointsHoles]( [param:Integer divisions] )</h3>
		<p>
			divisions -- The fineness of the result.<br /><br />

			Get an array of [page:Vector2 Vector2s] that represent the holes in the
			shape.
		</p>

		<h2>Source</h2>

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