jsxgraph 1.14.0 → 1.14.1

package/distrib/docs/JXG.Sphere3D.html

@@ -329,6 +329,36 @@ type <a href="Sphere3D.html">Sphere3D</a> instead.</p></div>
     
         <p class="summary">The type of projection (<code>'parallel'</code> or <code>'central'</code>) that the sphere is currently drawn in.</p>
     
+</dd>
+--></p>
+        
+            <p class="columntext">
+
+<a href="#range_u">range_u</a>
+
+<!--
+<dt id="range_u_short">
+    <a href="#range_u">range_u</a>
+</dt>
+<dd>
+    
+        <p class="summary">The parameter range of <code>u</code></p>.</p>
+    
+</dd>
+--></p>
+        
+            <p class="columntext">
+
+<a href="#range_v">range_v</a>
+
+<!--
+<dt id="range_v_short">
+    <a href="#range_v">range_v</a>
+</dt>
+<dd>
+    
+        <p class="summary">The parameter range of <code>v</code></p>.</p>
+    
 </dd>
 --></p>
         
@@ -776,6 +806,144 @@ Can be:</p>
 
 
         
+            
+<h4 class="name" id="range_u"><span class="type-signature"></span>range_u<span class="type-signature"> : Array</span></h4>
+
+
+
+
+
+<dl class="details">
+    
+      <dt class="tag-description">Description</dt>
+      <dd class="tag-description"><p>The parameter range of <code>u</code></p></dd>
+    
+
+    
+        <dt class="tag-description">Type</dt>
+        <dd class="tag-description">
+<span class="param-type">Array</span>
+
+
+</dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source</dt>
+      <dd class="tag-source">
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line192">line 192</a>
+      </dd>
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="range_v"><span class="type-signature"></span>range_v<span class="type-signature"> : Array</span></h4>
+
+
+
+
+
+<dl class="details">
+    
+      <dt class="tag-description">Description</dt>
+      <dd class="tag-description"><p>The parameter range of <code>v</code></p></dd>
+    
+
+    
+        <dt class="tag-description">Type</dt>
+        <dd class="tag-description">
+<span class="param-type">Array</span>
+
+
+</dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source</dt>
+      <dd class="tag-source">
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line198">line 198</a>
+      </dd>
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+        
 
         <h4 class="subsection-title" id="members-inherited">Inherited</h4>
         <div class="list_container">
@@ -880,6 +1048,94 @@ Can be:</p>
     
         <p class="summary">Calculates the radius of the circle.</p>
     
+</dd>
+--></p>
+        
+            <p class="columntext">
+
+<a href="#X">X</a>
+
+<!--
+<dt id="X_short">
+    <a href="#X">X</a>
+</dt>
+<dd>
+    
+        <p class="summary">Returns the x-coordinate of the sphere given as parametric surface for parameters <code>u</code> and <code>v</code>.</p>
+    
+</dd>
+--></p>
+        
+            <p class="columntext">
+
+<a href="#Y">Y</a>
+
+<!--
+<dt id="Y_short">
+    <a href="#Y">Y</a>
+</dt>
+<dd>
+    
+        <p class="summary">Returns the y-coordinate of the sphere given as parametric surface for parameters <code>u</code> and <code>v</code>.</p>
+    
+</dd>
+--></p>
+        
+            <p class="columntext">
+
+<a href="#Z">Z</a>
+
+<!--
+<dt id="Z_short">
+    <a href="#Z">Z</a>
+</dt>
+<dd>
+    
+        <p class="summary">Returns the z-coordinate of the sphere given as parametric surface for parameters <code>u</code> and <code>v</code>.</p>
+    
+</dd>
+--></p>
+        
+            <p class="columntext">
+
+<a href="#buildProjection">buildProjection</a>
+
+<!--
+<dt id="buildProjection_short">
+    <a href="#buildProjection">buildProjection</a>
+</dt>
+<dd>
+    
+        <p class="summary">Create 2D helper points and an ellipse to visualize the <code>sphere3d</code>.</p>
+    
+</dd>
+--></p>
+        
+            <p class="columntext">
+
+<a href="#focusFn">focusFn</a>
+
+<!--
+<dt id="focusFn_short">
+    <a href="#focusFn">focusFn</a>
+</dt>
+<dd>
+    
+        <p class="summary">The central projection of a sphere is an ellipse.</p>
+    
+</dd>
+--></p>
+        
+            <p class="columntext">
+
+<a href="#innerVertexFn">innerVertexFn</a>
+
+<!--
+<dt id="innerVertexFn_short">
+    <a href="#innerVertexFn">innerVertexFn</a>
+</dt>
+<dd>
+    
 </dd>
 --></p>
         
@@ -1072,7 +1328,1004 @@ Can be:</p>
     
     <dt class="tag-source">Source</dt>
       <dd class="tag-source">
-          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line203">line 203</a>
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line227">line 227</a>
+      </dd>
+    
+
+    
+</dl>
+
+
+
+
+</div>
+        
+            
+
+<div class="container-method">
+
+    
+
+    <h4 class="name" id="X"><span class="type-signature"></span>X(<span class="signature-param">u</span>, <span class="signature-param">v</span>)<span class="type-signature"> &rarr; {Number}</span></h4>
+
+    
+      <p class="tag-description"><p>Returns the x-coordinate of the sphere given as parametric surface for parameters <code>u</code> and <code>v</code>.</p></p>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+  <h3 class="h3-parameters">Parameters</h3>
+  
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th>Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code class='signature-param'>u</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code class='signature-param'>v</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description"></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h3 class="h3-returns">Returns</h3>
+
+        
+<div class="param-desc">
+    <p>x-coordinate</p>
+</div>
+
+
+
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Number</span>
+
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+<h3 class="h3-details">Details</h3>
+
+
+
+
+<dl class="details">
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source</dt>
+      <dd class="tag-source">
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line161">line 161</a>
+      </dd>
+    
+
+    
+</dl>
+
+
+
+
+</div>
+        
+            
+
+<div class="container-method">
+
+    
+
+    <h4 class="name" id="Y"><span class="type-signature"></span>Y(<span class="signature-param">u</span>, <span class="signature-param">v</span>)<span class="type-signature"> &rarr; {Number}</span></h4>
+
+    
+      <p class="tag-description"><p>Returns the y-coordinate of the sphere given as parametric surface for parameters <code>u</code> and <code>v</code>.</p></p>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+  <h3 class="h3-parameters">Parameters</h3>
+  
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th>Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code class='signature-param'>u</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code class='signature-param'>v</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description"></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h3 class="h3-returns">Returns</h3>
+
+        
+<div class="param-desc">
+    <p>y-coordinate</p>
+</div>
+
+
+
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Number</span>
+
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+<h3 class="h3-details">Details</h3>
+
+
+
+
+<dl class="details">
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source</dt>
+      <dd class="tag-source">
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line172">line 172</a>
+      </dd>
+    
+
+    
+</dl>
+
+
+
+
+</div>
+        
+            
+
+<div class="container-method">
+
+    
+
+    <h4 class="name" id="Z"><span class="type-signature"></span>Z(<span class="signature-param">u</span>, <span class="signature-param">v</span>)<span class="type-signature"> &rarr; {Number}</span></h4>
+
+    
+      <p class="tag-description"><p>Returns the z-coordinate of the sphere given as parametric surface for parameters <code>u</code> and <code>v</code>.</p></p>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+  <h3 class="h3-parameters">Parameters</h3>
+  
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th>Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code class='signature-param'>u</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description"></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code class='signature-param'>v</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description"></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h3 class="h3-returns">Returns</h3>
+
+        
+<div class="param-desc">
+    <p>z-coordinate</p>
+</div>
+
+
+
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Number</span>
+
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+<h3 class="h3-details">Details</h3>
+
+
+
+
+<dl class="details">
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source</dt>
+      <dd class="tag-source">
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line183">line 183</a>
+      </dd>
+    
+
+    
+</dl>
+
+
+
+
+</div>
+        
+            
+
+<div class="container-method">
+
+    
+
+    <h4 class="name" id="buildProjection"><span class="type-signature"></span>buildProjection(<span class="signature-param">attr</span>)<span class="type-signature"></span></h4>
+
+    
+      <p class="tag-description"><p>Create 2D helper points and an ellipse to visualize the <code>sphere3d</code>.
+Handles central and parallel projection simultaneously.</p>
+<p>This is done only once at creation time.</p></p>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+  <h3 class="h3-parameters">Parameters</h3>
+  
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th>Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code class='signature-param'>attr</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">object</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description"><p>Attributes for the sphere objects</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h3 class="h3-details">Details</h3>
+
+
+
+
+<dl class="details">
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source</dt>
+      <dd class="tag-source">
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line362">line 362</a>
+      </dd>
+    
+
+    
+</dl>
+
+
+
+
+</div>
+        
+            
+
+<div class="container-method">
+
+    
+
+    <h4 class="name" id="focusFn"><span class="type-signature"></span>focusFn(<span class="signature-param">sgn</span>)<span class="type-signature"> &rarr; {Array}</span></h4>
+
+    
+      <p class="tag-description"><p>The central projection of a sphere is an ellipse. The front and back
+points of the sphere -- that is, the points closest to and furthest
+from the screen -- project to the foci of the ellipse.</p>
+<p>To see this, look at the cone tangent to the sphere whose tip is at
+the camera. The image of the sphere is the ellipse where this cone
+intersects the screen. By acting on the sphere with scalings centered
+on the camera, you can send it to either of the Dandelin spheres that
+touch the screen at the foci of the image ellipse.</p>
+<p>This factory method produces two functions, <code>focusFn(-1)</code> and
+<code>focusFn(1)</code>, that evaluate to the projections of the front and back
+points of the sphere, respectively.</p>
+<p>The parallel projection of a sphere is a cicle. We use an ellipse curve
+for this projection, too. The two focii now coincide with the center of
+the sphere. The 2D radius point is defined by the projection of the center
+and the projected radius.</p></p>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+  <h3 class="h3-parameters">Parameters</h3>
+  
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th>Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code class='signature-param'>sgn</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description"><p>Expecst -1 or 1 for the two focus points</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h3 class="h3-returns">Returns</h3>
+
+        
+<div class="param-desc">
+    <p>2D coordinates of the projected focus point</p>
+</div>
+
+
+
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Array</span>
+
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+<h3 class="h3-details">Details</h3>
+
+
+
+
+<dl class="details">
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source</dt>
+      <dd class="tag-source">
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line271">line 271</a>
+      </dd>
+    
+
+    
+</dl>
+
+
+
+
+</div>
+        
+            
+
+<div class="container-method">
+
+    
+
+    <h4 class="name" id="innerVertexFn"><span class="type-signature"></span>innerVertexFn()<span class="type-signature"> &rarr; {Array}</span></h4>
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h3 class="h3-returns">Returns</h3>
+
+        
+<div class="param-desc">
+    <p>2D coordinates of the projected 3rd point that is on the ellipse.</p>
+</div>
+
+
+
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Array</span>
+
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+<h3 class="h3-details">Details</h3>
+
+
+
+
+<dl class="details">
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source</dt>
+      <dd class="tag-source">
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line297">line 297</a>
       </dd>
     
 
@@ -1242,7 +2495,7 @@ Can be:</p>
     
     <dt class="tag-source">Source</dt>
       <dd class="tag-source">
-          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line190">line 190</a>
+          <a href="3d_sphere3d.js.html">3d/sphere3d.js</a>, <a href="3d_sphere3d.js.html#line214">line 214</a>
       </dd>