Home Explore Help
Register Sign In
samien
/
three.js
mirror of https://github.com/mrdoob/three.js.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 6618a69400
Branches Tags
three.js
/
docs
/
pages
/
ShapePath.html

ShapePath.html 9.4 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<title>ShapePath - Three.js Docs</title>
    6. 

  6. 	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
    7. 

  7. 	<script src="../scripts/highlight.min.js"></script>
    8. 

  8. 	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
    9. 

  9. 	<link type="text/css" rel="stylesheet" href="../styles/page.css">
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. 	<h1 translate="no">ShapePath</h1>
    13. 

  13. 		<section>
    14. 

  14. 			<header>
    15. 

  15. 				<div class="class-description"><p>This class is used to convert a series of paths to an array of
    16. 

  16. shapes. It is specifically used in context of fonts and SVG.</p></div>
    17. 

  17. 			</header>
    18. 

  18. 			<article>
    19. 

  19. 				<div class="container-overview">
    20. 

  20. 					<h2>Constructor</h2>
    21. 

  21. 					<h3 class="name name-method" id="ShapePath" translate="no">new <a href="#ShapePath">ShapePath</a><span class="signature">()</span> </h3>
    22. 

  22. 					<div class="method">
    23. 

  23. 						<div class="description">
    24. 

  24. 							<p>Constructs a new shape path.</p>
    25. 

  25. 						</div>
    26. 

  26. 					</div>
    27. 

  27. 				</div>
    28. 

  28. 				<h2 class="subsection-title">Properties</h2>
    29. 

  29. 				<div class="member">
    30. 

  30. 					<h3 class="name" id="color" translate="no">.<a href="#color">color</a><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
    31. 

  31. 					<div class="description">
    32. 

  32. 						<p>The color of the shape.</p>
    33. 

  33. 					</div>
    34. 

  34. 				</div>
    35. 

  35. 				<div class="member">
    36. 

  36. 					<h3 class="name" id="currentPath" translate="no">.<a href="#currentPath">currentPath</a><span class="type-signature"> : <a href="Path.html">Path</a></span> </h3>
    37. 

  37. 					<div class="description">
    38. 

  38. 						<p>The current path that is being generated.<br/>Default is <code>null</code>.</p>
    39. 

  39. 					</div>
    40. 

  40. 				</div>
    41. 

  41. 				<div class="member">
    42. 

  42. 					<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>
    43. 

  43. 					<div class="description">
    44. 

  44. 						<p>The paths that have been generated for this shape.<br/>Default is <code>null</code>.</p>
    45. 

  45. 					</div>
    46. 

  46. 				</div>
    47. 

  47. 				<h2 class="subsection-title">Methods</h2>
    48. 

  48. 					<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>
    49. 

  49. 					<div class="method">
    50. 

  50. 						<div class="description">
    51. 

  51. 							<p>Adds an instance of <a href="CubicBezierCurve.html">CubicBezierCurve</a> to the path by connecting
    52. 

  52. the current point with the given one.</p>
    53. 

  53. 						</div>
    54. 

  54. 						<table class="params">
    55. 

  55. 							<tbody>
    56. 

  56. 								<tr>
    57. 

  57. 									<td class="name"><code>aCP1x</code></td>
    58. 

  58. 									<td class="description last"><p>The x coordinate of the first control point.</p></td>
    59. 

  59. 								</tr>
    60. 

  60. 								<tr>
    61. 

  61. 									<td class="name"><code>aCP1y</code></td>
    62. 

  62. 									<td class="description last"><p>The y coordinate of the first control point.</p></td>
    63. 

  63. 								</tr>
    64. 

  64. 								<tr>
    65. 

  65. 									<td class="name"><code>aCP2x</code></td>
    66. 

  66. 									<td class="description last"><p>The x coordinate of the second control point.</p></td>
    67. 

  67. 								</tr>
    68. 

  68. 								<tr>
    69. 

  69. 									<td class="name"><code>aCP2y</code></td>
    70. 

  70. 									<td class="description last"><p>The y coordinate of the second control point.</p></td>
    71. 

  71. 								</tr>
    72. 

  72. 								<tr>
    73. 

  73. 									<td class="name"><code>aX</code></td>
    74. 

  74. 									<td class="description last"><p>The x coordinate of the end point.</p></td>
    75. 

  75. 								</tr>
    76. 

  76. 								<tr>
    77. 

  77. 									<td class="name"><code>aY</code></td>
    78. 

  78. 									<td class="description last"><p>The y coordinate of the end point.</p></td>
    79. 

  79. 								</tr>
    80. 

  80. 							</tbody>
    81. 

  81. 						</table>
    82. 

  82. 						<dl class="details">
    83. 

  83. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
    84. 

  84. 						</dl>
    85. 

  85. 					</div>
    86. 

  86. 					<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>
    87. 

  87. 					<div class="method">
    88. 

  88. 						<div class="description">
    89. 

  89. 							<p>Adds an instance of <a href="LineCurve.html">LineCurve</a> to the path by connecting
    90. 

  90. the current point with the given one.</p>
    91. 

  91. 						</div>
    92. 

  92. 						<table class="params">
    93. 

  93. 							<tbody>
    94. 

  94. 								<tr>
    95. 

  95. 									<td class="name"><code>x</code></td>
    96. 

  96. 									<td class="description last"><p>The x coordinate of the end point.</p></td>
    97. 

  97. 								</tr>
    98. 

  98. 								<tr>
    99. 

  99. 									<td class="name"><code>y</code></td>
    100. 

  100. 									<td class="description last"><p>The y coordinate of the end point.</p></td>
    101. 

  101. 								</tr>
    102. 

  102. 							</tbody>
    103. 

  103. 						</table>
    104. 

  104. 						<dl class="details">
    105. 

  105. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
    106. 

  106. 						</dl>
    107. 

  107. 					</div>
    108. 

  108. 					<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>
    109. 

  109. 					<div class="method">
    110. 

  110. 						<div class="description">
    111. 

  111. 							<p>Creates a new path and moves it current point to the given one.</p>
    112. 

  112. 						</div>
    113. 

  113. 						<table class="params">
    114. 

  114. 							<tbody>
    115. 

  115. 								<tr>
    116. 

  116. 									<td class="name"><code>x</code></td>
    117. 

  117. 									<td class="description last"><p>The x coordinate.</p></td>
    118. 

  118. 								</tr>
    119. 

  119. 								<tr>
    120. 

  120. 									<td class="name"><code>y</code></td>
    121. 

  121. 									<td class="description last"><p>The y coordinate.</p></td>
    122. 

  122. 								</tr>
    123. 

  123. 							</tbody>
    124. 

  124. 						</table>
    125. 

  125. 						<dl class="details">
    126. 

  126. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
    127. 

  127. 						</dl>
    128. 

  128. 					</div>
    129. 

  129. 					<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>
    130. 

  130. 					<div class="method">
    131. 

  131. 						<div class="description">
    132. 

  132. 							<p>Adds an instance of <a href="QuadraticBezierCurve.html">QuadraticBezierCurve</a> to the path by connecting
    133. 

  133. the current point with the given one.</p>
    134. 

  134. 						</div>
    135. 

  135. 						<table class="params">
    136. 

  136. 							<tbody>
    137. 

  137. 								<tr>
    138. 

  138. 									<td class="name"><code>aCPx</code></td>
    139. 

  139. 									<td class="description last"><p>The x coordinate of the control point.</p></td>
    140. 

  140. 								</tr>
    141. 

  141. 								<tr>
    142. 

  142. 									<td class="name"><code>aCPy</code></td>
    143. 

  143. 									<td class="description last"><p>The y coordinate of the control point.</p></td>
    144. 

  144. 								</tr>
    145. 

  145. 								<tr>
    146. 

  146. 									<td class="name"><code>aX</code></td>
    147. 

  147. 									<td class="description last"><p>The x coordinate of the end point.</p></td>
    148. 

  148. 								</tr>
    149. 

  149. 								<tr>
    150. 

  150. 									<td class="name"><code>aY</code></td>
    151. 

  151. 									<td class="description last"><p>The y coordinate of the end point.</p></td>
    152. 

  152. 								</tr>
    153. 

  153. 							</tbody>
    154. 

  154. 						</table>
    155. 

  155. 						<dl class="details">
    156. 

  156. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
    157. 

  157. 						</dl>
    158. 

  158. 					</div>
    159. 

  159. 					<h3 class="name name-method" id="splineThru" translate="no">.<a href="#splineThru">splineThru</a><span class="signature">( pts : <span class="param-type">Array.&lt;Vector2></span> )</span><span class="type-signature"> : <a href="ShapePath.html">ShapePath</a></span> </h3>
    160. 

  160. 					<div class="method">
    161. 

  161. 						<div class="description">
    162. 

  162. 							<p>Adds an instance of <a href="SplineCurve.html">SplineCurve</a> to the path by connecting
    163. 

  163. the current point with the given list of points.</p>
    164. 

  164. 						</div>
    165. 

  165. 						<table class="params">
    166. 

  166. 							<tbody>
    167. 

  167. 								<tr>
    168. 

  168. 									<td class="name"><code>pts</code></td>
    169. 

  169. 									<td class="description last"><p>An array of points in 2D space.</p></td>
    170. 

  170. 								</tr>
    171. 

  171. 							</tbody>
    172. 

  172. 						</table>
    173. 

  173. 						<dl class="details">
    174. 

  174. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this shape path.</dt>
    175. 

  175. 						</dl>
    176. 

  176. 					</div>
    177. 

  177. 					<h3 class="name name-method" id="toShapes" translate="no">.<a href="#toShapes">toShapes</a><span class="signature">( isCCW : <span class="param-type">boolean</span> )</span><span class="type-signature"> : Array.&lt;<a href="Shape.html">Shape</a>></span> </h3>
    178. 

  178. 					<div class="method">
    179. 

  179. 						<div class="description">
    180. 

  180. 							<p>Converts the paths into an array of shapes.</p>
    181. 

  181. 						</div>
    182. 

  182. 						<table class="params">
    183. 

  183. 							<tbody>
    184. 

  184. 								<tr>
    185. 

  185. 									<td class="name"><code>isCCW</code></td>
    186. 

  186. 									<td class="description last"><p>By default solid shapes are  defined clockwise (CW) and holes are defined counterclockwise (CCW).
    187. 

  187. If this flag is set to <code>true</code>, then those are flipped.</p></td>
    188. 

  188. 								</tr>
    189. 

  189. 							</tbody>
    190. 

  190. 						</table>
    191. 

  191. 						<dl class="details">
    192. 

  192. 							<dt class="tag-returns"><strong>Returns:</strong> An array of shapes.</dt>
    193. 

  193. 						</dl>
    194. 

  194. 					</div>
    195. 

  195. 				<h2 class="subsection-title">Source</h2>
    196. 

  196. 				<p>
    197. 

  197. 					<a href="https://github.com/mrdoob/three.js/blob/master/src/extras/core/ShapePath.js" target="_blank" rel="noopener" translate="no">src/extras/core/ShapePath.js</a>
    198. 

  198. 				</p>
    199. 

  199. 			</article>
    200. 

  200. 		</section>
    201. 

  201. <script src="../scripts/linenumber.js"></script>
    202. 

  202. <script src="../scripts/page.js"></script>
    203. 

  203. </body>
    204. 

  204. </html>
    205.
粤ICP备19079148号