samien
/
three.js
зеркало из https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>ShapePath - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
	<h1 translate="no">ShapePath</h1>
		<section>
			<header>
				<div class="class-description"><p>This class is used to convert a series of paths to an array of
shapes. It is specifically used in context of fonts and SVG.</p></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="ShapePath" translate="no">new <a href="#ShapePath">ShapePath</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new shape path.</p>
						</div>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="color" translate="no">.<a href="#color">color</a><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
					<div class="description">
						<p>The color of the shape.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="currentPath" translate="no">.<a href="#currentPath">currentPath</a><span class="type-signature"> : <a href="Path.html">Path</a></span> </h3>
					<div class="description">
						<p>The current path that is being generated.</p>
						<p>Default is <code>null</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="subPaths" translate="no">.<a href="#subPaths">subPaths</a><span class="type-signature"> : Array.&lt;<a href="Path.html">Path</a>></span> </h3>
					<div class="description">
						<p>The paths that have been generated for this shape.</p>
						<p>Default is <code>null</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="userData" translate="no">.<a href="#userData">userData</a><span class="type-signature"> : Object</span> </h3>
					<div class="description">
						<p>An object that can be used to store custom data about the shape path.
Mainly used by SVGLoader to store style information.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="bezierCurveTo" translate="no">.<a href="#bezierCurveTo">bezierCurveTo</a><span class="signature">( aCP1x : <span class="param-type">number</span>, aCP1y : <span class="param-type">number</span>, aCP2x : <span class="param-type">number</span>, aCP2y : <span class="param-type">number</span>, aX : <span class="param-type">number</span>, aY : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="ShapePath.html">ShapePath</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Adds an instance of <a href="CubicBezierCurve.html">CubicBezierCurve</a> to the path by connecting
the current point with the given one.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">aCP1x</strong>
									</td>
									<td class="description last">
										<p>The x coordinate of the first control point.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">aCP1y</strong>
									</td>
									<td class="description last">
										<p>The y coordinate of the first control point.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">aCP2x</strong>
									</td>
									<td class="description last">
										<p>The x coordinate of the second control point.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">aCP2y</strong>
									</td>
									<td class="description last">
										<p>The y coordinate of the second control point.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">aX</strong>
									</td>
									<td class="description last">
										<p>The x coordinate of the end point.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">aY</strong>
									</td>
									<td class="description last">
										<p>The y coordinate of the end point.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="lineTo" translate="no">.<a href="#lineTo">lineTo</a><span class="signature">( x : <span class="param-type">number</span>, y : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="ShapePath.html">ShapePath</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Adds an instance of <a href="LineCurve.html">LineCurve</a> to the path by connecting
the current point with the given one.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">x</strong>
									</td>
									<td class="description last">
										<p>The x coordinate of the end point.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">y</strong>
									</td>
									<td class="description last">
										<p>The y coordinate of the end point.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="moveTo" translate="no">.<a href="#moveTo">moveTo</a><span class="signature">( x : <span class="param-type">number</span>, y : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="ShapePath.html">ShapePath</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Creates a new path and moves it current point to the given one.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">x</strong>
									</td>
									<td class="description last">
										<p>The x coordinate.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">y</strong>
									</td>
									<td class="description last">
										<p>The y coordinate.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="quadraticCurveTo" translate="no">.<a href="#quadraticCurveTo">quadraticCurveTo</a><span class="signature">( aCPx : <span class="param-type">number</span>, aCPy : <span class="param-type">number</span>, aX : <span class="param-type">number</span>, aY : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="ShapePath.html">ShapePath</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Adds an instance of <a href="QuadraticBezierCurve.html">QuadraticBezierCurve</a> to the path by connecting
the current point with the given one.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">aCPx</strong>
									</td>
									<td class="description last">
										<p>The x coordinate of the control point.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">aCPy</strong>
									</td>
									<td class="description last">
										<p>The y coordinate of the control point.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">aX</strong>
									</td>
									<td class="description last">
										<p>The x coordinate of the end point.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">aY</strong>
									</td>
									<td class="description last">
										<p>The y coordinate of the end point.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="splineThru" translate="no">.<a href="#splineThru">splineThru</a><span class="signature">( pts : <span class="param-type">Array.&lt;<a href="Vector2.html">Vector2</a>></span> )</span><span class="type-signature"> : <a href="ShapePath.html">ShapePath</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Adds an instance of <a href="SplineCurve.html">SplineCurve</a> to the path by connecting
the current point with the given list of points.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">pts</strong>
									</td>
									<td class="description last">
										<p>An array of points in 2D space.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="toShapes" translate="no">.<a href="#toShapes">toShapes</a><span class="signature">()</span><span class="type-signature"> : Array.&lt;<a href="Shape.html">Shape</a>></span> </h3>
					<div class="method">
						<div class="description">
							<p>Converts the paths into an array of shapes.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> An array of shapes.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/extras/core/ShapePath.js" translate="no" target="_blank" rel="noopener">src/extras/core/ShapePath.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>