paper 0.13.0 → 0.15.0

package/dist/docs/classes/TextRange.html

@@ -0,0 +1,186 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>TextRange</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>TextRange</h1>
+
+<p>A part of a <a href="../classes/TextStory.html"><tt>TextStory</tt></a>&rsquo;s content, from its <a href="../classes/TextRange.html#start"><tt>start</tt></a>  to its <a href="../classes/TextRange.html#end"><tt>end</tt></a>, whose style is that of its letters and paragraphs:  read, a property is the one they share, or <code>undefined</code>; set, it changes  them. It has the same style properties as items, e.g.  <code>text.words[0].fontSize = 24</code>. A range is a snapshot of two indices:  changing styles never moves it, but changing the content leaves ranges  taken before out of date, as indices into any string.</p>
+
+
+</div>
+
+
+
+
+
+<!-- ================================ properties =========================== -->
+	<div class="reference-members">
+		<h2>Properties</h2>
+		
+			
+<div id="story" class="member">
+<div class="member-link">
+<a name="story" href="#story"><tt><b>story</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The story the range is part of.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<a href="../classes/TextStory.html"><tt>TextStory</tt></a>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="start" class="member">
+<div class="member-link">
+<a name="start" href="#start"><tt><b>start</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The index of the range&rsquo;s first character.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<tt>Number</tt>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="end" class="member">
+<div class="member-link">
+<a name="end" href="#end"><tt><b>end</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The index after the range&rsquo;s last character.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<tt>Number</tt>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="content" class="member">
+<div class="member-link">
+<a name="content" href="#content"><tt><b>content</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The content of the range.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<tt>String</tt>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="style" class="member">
+<div class="member-link">
+<a name="style" href="#style"><tt><b>style</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The style of the range: of its characters, and of the paragraphs it touches.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<a href="../classes/Style.html"><tt>Style</tt></a>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+	</div>
+
+
+
+
+
+
+
+
+<!-- =========================== copyright notice ========================== -->
+<p class="footer">
+Paper.js v0.15.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/TextStory.html

@@ -0,0 +1,355 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>TextStory</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>TextStory</h1>
+
+<p>The text of one or more linked <a href="../classes/TextItem.html"><tt>TextItem</tt></a>s, which it flows  through in order: its content, kept in runs of characters that share a  style, and the styles of its paragraphs. A text item that isn&rsquo;t linked  has a story of its own.</p>
+
+
+</div>
+
+
+
+
+
+<!-- ================================ properties =========================== -->
+	<div class="reference-members">
+		<h2>Properties</h2>
+		
+			
+<div id="textitems" class="member">
+<div class="member-link">
+<a name="textitems" href="#textitems"><tt><b>textItems</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The text items that the story flows through, in order.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			Array of <a href="../classes/TextItem.html"><tt>TextItem</tt></a> objects
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="content" class="member">
+<div class="member-link">
+<a name="content" href="#content"><tt><b>content</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The text of the story, from the first of its text items to the last.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<tt>String</tt>
+		</li>
+	</ul>
+    
+	
+	<h4>Example:<span class="description">Setting the content of a PointText item:</span></h4>
+
+<div class="paperscript split">
+
+<div class="buttons">
+<div class="button run">Run</div>
+</div>
+
+<script type="text/paperscript" canvas="canvas-0">
+// Create a point-text item at {x: 30, y: 30}:
+var text = new PointText(new Point(30, 30));
+text.fillColor = 'black';
+
+// Set the content of the text item:
+text.content = 'Hello world';
+</script>
+<div class="canvas"><canvas width="516" height="100" id="canvas-0"></canvas></div>
+</div>
+
+
+<h4>Example:<span class="description">Interactive example, move your mouse over the view below:</span></h4>
+
+<div class="paperscript split">
+
+<div class="buttons">
+<div class="button run">Run</div>
+</div>
+
+<script type="text/paperscript" canvas="canvas-1">
+// Create a point-text item at {x: 30, y: 30}:
+var text = new PointText(new Point(30, 30));
+text.fillColor = 'black';
+
+text.content = 'Move your mouse over the view, to see its position';
+
+function onMouseMove(event) {
+    // Each time the mouse is moved, set the content of
+    // the point text to describe the position of the mouse:
+    text.content = 'Your position is: ' + event.point.toString();
+}
+</script>
+<div class="canvas"><canvas width="516" height="100" id="canvas-1"></canvas></div>
+</div>
+
+
+</div>
+
+</div>
+</div>
+		
+			
+<div id="runs" class="member">
+<div class="member-link">
+<a name="runs" href="#runs"><tt><b>runs</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The runs of the text: its ranges that each have one style throughout. Set it to plain objects with a <code>content</code> and style properties, which then make the whole text.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			Array of <a href="../classes/TextRange.html"><tt>TextRange</tt></a> objects
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="paragraphs" class="member">
+<div class="member-link">
+<a name="paragraphs" href="#paragraphs"><tt><b>paragraphs</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The paragraphs of the text, without their line breaks. Set it to plain objects with paragraph style properties, one per paragraph.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			Array of <a href="../classes/TextRange.html"><tt>TextRange</tt></a> objects
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="words" class="member">
+<div class="member-link">
+<a name="words" href="#words"><tt><b>words</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The words of the text, as the browser finds them (Intl.Segmenter), or else separated by white space.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			Array of <a href="../classes/TextRange.html"><tt>TextRange</tt></a> objects
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
+<div id="letters" class="member">
+<div class="member-link">
+<a name="letters" href="#letters"><tt><b>letters</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The letters of the text, each as readers see one (a grapheme: an emoji, or a letter with its accents), spaces and punctuation included.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			Array of <a href="../classes/TextRange.html"><tt>TextRange</tt></a> objects
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+	</div>
+
+
+
+
+
+<!-- ============================== methods ================================ -->
+	<div class="reference-members">
+		<h2>Methods</h2>
+		
+	
+<div id="replace-content-start-end" class="member">
+<div class="member-link">
+<a name="replace-content-start-end" href="#replace-content-start-end"><tt><b>replace</b>(content, start, end)</tt></a>
+</div>
+<div class="member-description hidden">
+<div class="member-text">
+	<p>Replaces the content from <code>start</code> to <code>end</code>, or of a range, with new content, which takes the style of the content it replaces, or of the character before it when it&rsquo;s inserted.</p>
+    
+	
+<ul class="member-list">
+	<h4>Parameters:</h4>
+	
+	<li>
+<tt>content:</tt> 
+<tt>String</tt>
+&mdash;&nbsp;the new content
+
+</li>
+	
+	<li>
+<tt>start:</tt> 
+<tt>Number</tt>
+&mdash;&nbsp;the index of the first character to replace
+
+</li>
+	
+	<li>
+<tt>end:</tt> 
+<tt>Number</tt>
+&mdash;&nbsp;the index after the last character to replace
+
+</li>
+	
+</ul>
+
+	
+
+
+	
+	
+</div>
+</div>
+</div>
+
+	
+<div id="range-start-end" class="member">
+<div class="member-link">
+<a name="range-start-end" href="#range-start-end"><tt><b>range</b>(start, end)</tt></a>
+</div>
+<div class="member-description hidden">
+<div class="member-text">
+	<p>The range of the text from <code>start</code> to <code>end</code>.</p>
+    
+	
+<ul class="member-list">
+	<h4>Parameters:</h4>
+	
+	<li>
+<tt>start:</tt> 
+<tt>Number</tt>
+&mdash;&nbsp;the index of its first character
+
+</li>
+	
+	<li>
+<tt>end:</tt> 
+<tt>Number</tt>
+&mdash;&nbsp;the index after its last character
+
+</li>
+	
+</ul>
+
+	
+	<ul class="member-list">
+		<h4>Returns:</h4>
+		
+			<li>
+<tt><a href="../classes/TextRange.html"><tt>TextRange</tt></a></tt>
+</li>
+
+		
+	</ul>
+
+
+
+	
+	
+</div>
+</div>
+</div>
+
+
+		
+	</div>
+
+
+
+
+<!-- =========================== copyright notice ========================== -->
+<p class="footer">
+Paper.js v0.15.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/Tool.html

@@ -48,6 +48,7 @@ tool.onMouseDrag = function(event) {
 </div>
 
 
+
 </div>
 
 
@@ -59,6 +60,34 @@ tool.onMouseDrag = function(event) {
 		<h2>Properties</h2>
 		
 			
+<div id="scope" class="member">
+<div class="member-link">
+<a name="scope" href="#scope"><tt><b>scope</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The scope that this tool belongs to.</p>
+	
+		<p>Read only.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<a href="../classes/PaperScope.html"><tt>PaperScope</tt></a>
+		</li>
+	</ul>
+    
+	
+	
+</div>
+
+</div>
+</div>
+		
+			
 <div id="mindistance" class="member">
 <div class="member-link">
 <a name="mindistance" href="#mindistance"><tt><b>minDistance</b></tt></a>
@@ -111,6 +140,41 @@ tool.onMouseDrag = function(event) {
 </div>
 		
 			
+<div id="eventinterval" class="member">
+<div class="member-link">
+<a name="eventinterval" href="#eventinterval"><tt><b>eventInterval</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The interval in milliseconds at which the onMouseDrag event fires again while the mouse button is held, also when the mouse doesn&rsquo;t move. The repeated events are at the last point, with a zero <a href="../classes/ToolEvent.html#delta"><tt>toolEvent.delta</tt></a>. <code>null</code>, the default, or anything up to 0 turns it off.</p>
+	
+	
+	
+		<ul class="member-list">
+			<h4>Default:</h4>
+			<li><tt>null</tt></li>
+		</ul>
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<tt>Number</tt>
+		</li>
+	</ul>
+    
+	
+	<h4>Example:<span class="description">Fire the onMouseDrag event 10 times a second, while the mouse button is held:</span></h4>
+
+
+<pre><code>tool.eventInterval = 100;</code></pre>
+
+</div>
+
+</div>
+</div>
+		
+			
 <div id="fixeddistance" class="member">
 <div class="member-link">
 <a name="fixeddistance" href="#fixeddistance"><tt><b>fixedDistance</b></tt></a>
@@ -422,6 +486,68 @@ tool.onKeyDown = function(event) {
     }
 }</code></pre>
 
+</div>
+
+</div>
+</div>
+		
+			
+	<h3>Activation Event Handlers</h3>
+
+<div id="onactivate" class="member">
+<div class="member-link">
+<a name="onactivate" href="#onactivate"><tt><b>onActivate</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The function to be called when the tool is activated through <a href="../classes/Tool.html#activate"><tt>activate</tt></a>(). The function receives the previously active tool, which is the tool itself when it was already active.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<tt>Function</tt>⟋<tt>null</tt>
+		</li>
+	</ul>
+    
+	
+	<h4>Example:</h4>
+
+
+<pre><code>tool.onActivate = function(previous) {
+    if (previous == tool) {
+        console.log('The tool was activated again!');
+    }
+}</code></pre>
+
+</div>
+
+</div>
+</div>
+		
+			
+<div id="ondeactivate" class="member">
+<div class="member-link">
+<a name="ondeactivate" href="#ondeactivate"><tt><b>onDeactivate</b></tt></a>
+</div>
+<div class="member-description hidden">
+
+<div class="member-text">
+	<p>The function to be called when another tool is activated through <a href="../classes/Tool.html#activate"><tt>activate</tt></a>(), while this one is active.</p>
+	
+	
+	
+	<ul class="member-list">
+		<h4>Type:</h4>
+		<li>
+			<tt>Function</tt>⟋<tt>null</tt>
+		</li>
+	</ul>
+    
+	
+	
 </div>
 
 </div>
@@ -753,7 +879,7 @@ tool.onKeyDown = function(event) {
 
 <!-- =========================== copyright notice ========================== -->
 <p class="footer">
-Paper.js v0.13.0<br>
+Paper.js v0.15.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>