paper 0.15.0 → 0.17.0

package/dist/docs/classes/PatternDefinition.html

@@ -0,0 +1,367 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>PatternDefinition</title>
+<base target="class-frame">
+<link href="../assets/css/docs.css" rel="stylesheet" type="text/css">
+<script src="../assets/js/paper.js"></script>
+<script src="../assets/js/jquery.js"></script>
+<script src="../assets/js/codemirror.js"></script>
+<script src="../assets/js/docs.js"></script>
+</head>
+<body>
+<article class="reference"> 
+<div class="reference-class">
+<h1>PatternDefinition</h1>
+
+<p>A pattern definition repeats an item as the tile of pattern colors, which fill and stroke items with it, see <a href="../classes/Color.html#pattern"><tt>color.pattern</tt></a>: a <a href="../classes/Raster.html"><tt>Raster</tt></a> for image patterns, or any other item for vector patterns. As with symbol definitions, the item is removed from the scene graph, and all pattern colors that use the pattern share it, so they change along with it.</p>
+<h4>Example:<span class="description">A dotted pattern, filling and stroking a circle:</span></h4>
+
+<div class="paperscript split">
+
+<div class="buttons">
+<div class="button run">Run</div>
+</div>
+
+<script type="text/paperscript" canvas="canvas-0">
+var dot = new Path.Circle({
+    center: [5, 5],
+    radius: 3,
+    fillColor: 'red'
+});
+
+// Repeat the dot every 10 points, with a gap of 2 points between the
+// tiles of the stroke's pattern:
+var pattern = new PatternDefinition(dot, {
+    tile: new Rectangle(0, 0, 10, 10)
+});
+var spaced = new PatternDefinition(dot.clone(), {
+    tile: new Rectangle(0, 0, 10, 10),
+    spacing: 2
+});
+
+var circle = new Path.Circle({
+    center: view.center,
+    radius: 70,
+    fillColor: { pattern: pattern },
+    strokeColor: {
+        pattern: spaced,
+        matrix: new Matrix().rotate(45)
+    },
+    strokeWidth: 20
+});
+</script>
+<div class="canvas"><canvas width="516" height="200" id="canvas-0"></canvas></div>
+</div>
+
+
+
+</div>
+
+<!-- =============================== constructors ========================== -->
+<div class="reference-members">
+	<h2>Constructors</h2>
+	
+		
+<div id="patterndefinition-item" class="member">
+<div class="member-link">
+<a name="patterndefinition-item" href="#patterndefinition-item"><tt><b>PatternDefinition</b>(item[, options])</tt></a>
+</div>
+<div class="member-description hidden">
+<div class="member-text">
+    <p>Creates a pattern definition.</p>
+    <ul class="member-list">
+<h4>Options:</h4>
+<li>[options.tile] {Rectangle} the rectangle that is repeated,
+    the bounds of the item by default</li>
+<li><tt>options.spacing: <a href="../classes/Size.html"><tt>Size</tt></a></tt> &mdash; the gap between the tiles &mdash;&nbsp;default: <tt>0</tt></li>
+<li>[options.name] {String} the name of the pattern</li>
+</ul>
+    
+<ul class="member-list">
+	<h4>Parameters:</h4>
+	
+	<li>
+<tt>item:</tt> 
+<a href="../classes/Item.html"><tt>Item</tt></a>
+&mdash;&nbsp;the item to repeat, which is removed from the scene  graph and becomes the pattern&rsquo;s tile content
+
+</li>
+	
+	<li>
+<tt>options:</tt> 
+<tt>Object</tt>
+
+&mdash;&nbsp;optional
+</li>
+	
+</ul>
+
+    
+	<ul class="member-list">
+		<h4>Returns:</h4>
+		
+			<li>
+<tt><a href="../classes/PatternDefinition.html"><tt>PatternDefinition</tt></a></tt>
+</li>
+
+		
+	</ul>
+
+
+
+    
+    
+</div>
+</div>
+</div>
+	
+</div>
+
+
+
+
+
+<!-- ================================ properties =========================== -->
+	<div class="reference-members">
+		<h2>Properties</h2>
+		
+			
+<div id="project" class="member">
+<div class="member-link">
+<a name="project" href="#project"><tt><b>project</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The project that this pattern belongs to.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<a href="../classes/Project.html"><tt>Project</tt></a>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="name" class="member">
+<div class="member-link">
+<a name="name" href="#name"><tt><b>name</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The name of the pattern.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<tt>String</tt>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="item" class="member">
+<div class="member-link">
+<a name="item" href="#item"><tt><b>item</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The item that the pattern repeats. Unlike the items of symbols, it isn&rsquo;t moved to 0, 0, so the tiles are at its own coordinates.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<a href="../classes/Item.html"><tt>Item</tt></a>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="tile" class="member">
+<div class="member-link">
+<a name="tile" href="#tile"><tt><b>tile</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The rectangle that is repeated, in the coordinates of the pattern&rsquo;s item.</p>
+	
+	
+	
+		<ul class="member-list">
+			<h4>Default:</h4>
+			<li><tt>the bounds of the pattern's item</tt></li>
+		</ul>
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<a href="../classes/Rectangle.html"><tt>Rectangle</tt></a>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="spacing" class="member">
+<div class="member-link">
+<a name="spacing" href="#spacing"><tt><b>spacing</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The gap between the tiles, horizontally and vertically.</p>
+	
+	
+	
+		<ul class="member-list">
+			<h4>Default:</h4>
+			<li><tt>0</tt></li>
+		</ul>
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<a href="../classes/Size.html"><tt>Size</tt></a>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+	</div>
+
+
+
+
+
+<!-- ============================== methods ================================ -->
+	<div class="reference-members">
+		<h2>Methods</h2>
+		
+	
+<div id="clone" class="member">
+<div class="member-link">
+<a name="clone" href="#clone"><tt><b>clone</b>()</tt></a>
+</div>
+<div class="member-description hidden">
+<div class="member-text">
+	<p>Returns a copy of the pattern, with a copy of its item and its name.</p>
+    
+	
+	
+	<ul class="member-list">
+		<h4>Returns:</h4>
+		
+			<li>
+<tt><a href="../classes/PatternDefinition.html"><tt>PatternDefinition</tt></a></tt>
+</li>
+
+		
+	</ul>
+
+
+
+	
+	
+</div>
+</div>
+</div>
+
+	
+<div id="equals-pattern" class="member">
+<div class="member-link">
+<a name="equals-pattern" href="#equals-pattern"><tt><b>equals</b>(pattern)</tt></a>
+</div>
+<div class="member-description hidden">
+<div class="member-text">
+	<p>Checks whether the pattern is equal to the supplied pattern.</p>
+    
+	
+<ul class="member-list">
+	<h4>Parameters:</h4>
+	
+	<li>
+<tt>pattern:</tt> 
+<a href="../classes/PatternDefinition.html"><tt>PatternDefinition</tt></a>
+
+
+</li>
+	
+</ul>
+
+	
+	<ul class="member-list">
+		<h4>Returns:</h4>
+		
+			<li>
+<tt><tt>Boolean</tt></tt>&nbsp;&mdash;&nbsp;<tt>true</tt> if they are equal, <tt>false</tt> otherwise
+</li>
+
+		
+	</ul>
+
+
+
+	
+	
+</div>
+</div>
+</div>
+
+
+		
+	</div>
+
+
+
+
+<!-- =========================== copyright notice ========================== -->
+<p class="footer">
+Paper.js v0.17.0<br>
+Copyright &#169; 2011—2026 <a href="http://www.lehni.org" target="_blank">J&uuml;rg Lehni</a> &amp; <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
+<div class="content-end"></div>
+
+
+</article>
+</body>

package/dist/docs/classes/Point.html

@@ -844,6 +844,34 @@ console.log(result); // {x: 2, y: 0}</code></pre>
     
 	
 	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="values" class="member">
+<div class="member-link">
+<a name="values" href="#values"><tt><b>values</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The point&rsquo;s coordinates as an array, <code>[x, y]</code>, as <a href="../classes/Matrix.html#values"><tt>matrix.values</tt></a> gives those of a matrix.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			Array of <tt>Numbers</tt>
+		</li>
+	</ul>
+    
+	
+	
 </div>
 
 </div>
@@ -1634,7 +1662,7 @@ console.log(result); // {x: -12, y: 6}</code></pre>
 </div>
 <div class="member-description hidden">
 <div class="member-text">
-	<p>Checks if the vector represented by this point is collinear (parallel) to another vector.</p>
+	<p>Checks if the vector represented by this point is collinear (parallel) to another vector, within a tolerance of 1e-8 for the sine of the angle between them.</p>
     
 	
 <ul class="member-list">
@@ -1675,7 +1703,7 @@ console.log(result); // {x: -12, y: 6}</code></pre>
 </div>
 <div class="member-description hidden">
 <div class="member-text">
-	<p>Checks if the vector represented by this point is orthogonal (perpendicular) to another vector.</p>
+	<p>Checks if the vector represented by this point is orthogonal (perpendicular) to another vector, within a tolerance of 1e-8 for the cosine of the angle between them.</p>
     
 	
 <ul class="member-list">
@@ -1716,7 +1744,7 @@ console.log(result); // {x: -12, y: 6}</code></pre>
 </div>
 <div class="member-description hidden">
 <div class="member-text">
-	<p>Checks if this point has both the x and y coordinate set to 0.</p>
+	<p>Checks if this point has both the x and y coordinate set to 0, within a tolerance of 1e-12, unlike <a href="../classes/Point.html#equals-point"><tt>equals(point)</tt></a>, which compares exactly.</p>
     
 	
 	
@@ -1724,7 +1752,7 @@ console.log(result); // {x: -12, y: 6}</code></pre>
 		<h4>Returns:</h4>
 		
 			<li>
-<tt><tt>Boolean</tt></tt>&nbsp;&mdash;&nbsp;<tt>true</tt> if both x and y are 0, <tt>false</tt> otherwise
+<tt><tt>Boolean</tt></tt>&nbsp;&mdash;&nbsp;<tt>true</tt> if both x and y are 0, within the tolerance, <tt>false</tt> otherwise
 </li>
 
 		
@@ -2823,7 +2851,7 @@ var point = maxPoint * randomPoint;</code></pre>
 
 <!-- =========================== copyright notice ========================== -->
 <p class="footer">
-Paper.js v0.15.0<br>
+Paper.js v0.17.0<br>
 Copyright &#169; 2011—2026 <a href="http://www.lehni.org" target="_blank">J&uuml;rg Lehni</a> &amp; <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
 <div class="content-end"></div>