diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/euclidean/threed/Line.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/euclidean/threed/Line.html | 656 |
1 files changed, 656 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/euclidean/threed/Line.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/euclidean/threed/Line.html new file mode 100644 index 0000000..c21e321 --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/geometry/euclidean/threed/Line.html @@ -0,0 +1,656 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Line (Apache Commons Math 3.6.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Line (Apache Commons Math 3.6.1 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Line.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/FieldVector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/NotARotationMatrixException.html" title="class in org.apache.commons.math3.geometry.euclidean.threed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/commons/math3/geometry/euclidean/threed/Line.html" target="_top">Frames</a></li> +<li><a href="Line.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.math3.geometry.euclidean.threed</div> +<h2 title="Class Line" class="title">Class Line</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.math3.geometry.euclidean.threed.Line</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Embedding.html" title="interface in org.apache.commons.math3.geometry.partitioning">Embedding</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Euclidean3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Euclidean3D</a>,<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Euclidean1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Euclidean1D</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">Line</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Embedding.html" title="interface in org.apache.commons.math3.geometry.partitioning">Embedding</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Euclidean3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Euclidean3D</a>,<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Euclidean1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Euclidean1D</a>></pre> +<div class="block">The class represent lines in a three dimensional space. + + <p>Each oriented line is intrinsically associated with an abscissa + which is a coordinate on the line. The point at abscissa 0 is the + orthogonal projection of the origin on the line, another equivalent + way to express this is to say that it is the point of the line + which is closest to the origin. Abscissa increases in the line + direction.</p></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#Line(org.apache.commons.math3.geometry.euclidean.threed.Line)">Line</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</code> +<div class="block">Copy constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#Line(org.apache.commons.math3.geometry.euclidean.threed.Vector3D,%20org.apache.commons.math3.geometry.euclidean.threed.Vector3D)">Line</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p1, + <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p2)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>as of 3.3, replaced with <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#Line(org.apache.commons.math3.geometry.euclidean.threed.Vector3D,%20org.apache.commons.math3.geometry.euclidean.threed.Vector3D,%20double)"><code>Line(Vector3D, Vector3D, double)</code></a></i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#Line(org.apache.commons.math3.geometry.euclidean.threed.Vector3D,%20org.apache.commons.math3.geometry.euclidean.threed.Vector3D,%20double)">Line</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p1, + <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p2, + double tolerance)</code> +<div class="block">Build a line from two points.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#closestPoint(org.apache.commons.math3.geometry.euclidean.threed.Line)">closestPoint</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</code> +<div class="block">Compute the point of the instance closest to another line.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#contains(org.apache.commons.math3.geometry.euclidean.threed.Vector3D)">contains</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p)</code> +<div class="block">Check if the instance contains a point.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#distance(org.apache.commons.math3.geometry.euclidean.threed.Line)">distance</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</code> +<div class="block">Compute the shortest distance between the instance and another line.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#distance(org.apache.commons.math3.geometry.euclidean.threed.Vector3D)">distance</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p)</code> +<div class="block">Compute the distance between the instance and a point.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#getAbscissa(org.apache.commons.math3.geometry.euclidean.threed.Vector3D)">getAbscissa</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> point)</code> +<div class="block">Get the abscissa of a point with respect to the line.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#getDirection()">getDirection</a></strong>()</code> +<div class="block">Get the normalized direction vector.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#getOrigin()">getOrigin</a></strong>()</code> +<div class="block">Get the line point closest to the origin.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#getTolerance()">getTolerance</a></strong>()</code> +<div class="block">Get the tolerance below which points are considered identical.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#intersection(org.apache.commons.math3.geometry.euclidean.threed.Line)">intersection</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</code> +<div class="block">Get the intersection point of the instance and another line.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#isSimilarTo(org.apache.commons.math3.geometry.euclidean.threed.Line)">isSimilarTo</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</code> +<div class="block">Check if the instance is similar to another line.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#pointAt(double)">pointAt</a></strong>(double abscissa)</code> +<div class="block">Get one point from the line.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#reset(org.apache.commons.math3.geometry.euclidean.threed.Vector3D,%20org.apache.commons.math3.geometry.euclidean.threed.Vector3D)">reset</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p1, + <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p2)</code> +<div class="block">Reset the instance as if built from two points.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#revert()">revert</a></strong>()</code> +<div class="block">Get a line with reversed direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#toSpace(org.apache.commons.math3.geometry.Point)">toSpace</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Euclidean1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Euclidean1D</a>> point)</code> +<div class="block">Transform a sub-space point into a space point.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#toSpace(org.apache.commons.math3.geometry.Vector)">toSpace</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Euclidean1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Euclidean1D</a>> vector)</code> +<div class="block">Transform a sub-space point into a space point.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Vector1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Vector1D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#toSubSpace(org.apache.commons.math3.geometry.Point)">toSubSpace</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Euclidean3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Euclidean3D</a>> point)</code> +<div class="block">Transform a space point into a sub-space point.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Vector1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Vector1D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#toSubSpace(org.apache.commons.math3.geometry.Vector)">toSubSpace</a></strong>(<a href="../../../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Euclidean3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Euclidean3D</a>> vector)</code> +<div class="block">Transform a space point into a sub-space point.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/SubLine.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">SubLine</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#wholeLine()">wholeLine</a></strong>()</code> +<div class="block">Build a sub-line covering the whole line.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Line(org.apache.commons.math3.geometry.euclidean.threed.Vector3D, org.apache.commons.math3.geometry.euclidean.threed.Vector3D, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Line</h4> +<pre>public Line(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p1, + <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p2, + double tolerance) + throws <a href="../../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">Build a line from two points.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p1</code> - first point belonging to the line (this can be any point)</dd><dd><code>p2</code> - second point belonging to the line (this can be any point, different from p1)</dd><dd><code>tolerance</code> - tolerance below which points are considered identical</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the points are equal</dd><dt><span class="strong">Since:</span></dt> + <dd>3.3</dd></dl> +</li> +</ul> +<a name="Line(org.apache.commons.math3.geometry.euclidean.threed.Line)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Line</h4> +<pre>public Line(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</pre> +<div class="block">Copy constructor. + <p>The created instance is completely independent from the + original instance, it is a deep copy.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>line</code> - line to copy</dd></dl> +</li> +</ul> +<a name="Line(org.apache.commons.math3.geometry.euclidean.threed.Vector3D, org.apache.commons.math3.geometry.euclidean.threed.Vector3D)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Line</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public Line(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p1, + <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p2) + throws <a href="../../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> <i>as of 3.3, replaced with <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#Line(org.apache.commons.math3.geometry.euclidean.threed.Vector3D,%20org.apache.commons.math3.geometry.euclidean.threed.Vector3D,%20double)"><code>Line(Vector3D, Vector3D, double)</code></a></i></div> +<div class="block">Build a line from two points.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p1</code> - first point belonging to the line (this can be any point)</dd><dd><code>p2</code> - second point belonging to the line (this can be any point, different from p1)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the points are equal</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="reset(org.apache.commons.math3.geometry.euclidean.threed.Vector3D, org.apache.commons.math3.geometry.euclidean.threed.Vector3D)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre>public void reset(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p1, + <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p2) + throws <a href="../../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre> +<div class="block">Reset the instance as if built from two points.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p1</code> - first point belonging to the line (this can be any point)</dd><dd><code>p2</code> - second point belonging to the line (this can be any point, different from p1)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the points are equal</dd></dl> +</li> +</ul> +<a name="getTolerance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTolerance</h4> +<pre>public double getTolerance()</pre> +<div class="block">Get the tolerance below which points are considered identical.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>tolerance below which points are considered identical</dd><dt><span class="strong">Since:</span></dt> + <dd>3.3</dd></dl> +</li> +</ul> +<a name="revert()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>revert</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> revert()</pre> +<div class="block">Get a line with reversed direction.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a new instance, with reversed direction</dd></dl> +</li> +</ul> +<a name="getDirection()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDirection</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> getDirection()</pre> +<div class="block">Get the normalized direction vector.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>normalized direction vector</dd></dl> +</li> +</ul> +<a name="getOrigin()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrigin</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> getOrigin()</pre> +<div class="block">Get the line point closest to the origin.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>line point closest to the origin</dd></dl> +</li> +</ul> +<a name="getAbscissa(org.apache.commons.math3.geometry.euclidean.threed.Vector3D)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAbscissa</h4> +<pre>public double getAbscissa(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> point)</pre> +<div class="block">Get the abscissa of a point with respect to the line. + <p>The abscissa is 0 if the projection of the point and the + projection of the frame origin on the line are the same + point.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>point</code> - point to check</dd> +<dt><span class="strong">Returns:</span></dt><dd>abscissa of the point</dd></dl> +</li> +</ul> +<a name="pointAt(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pointAt</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> pointAt(double abscissa)</pre> +<div class="block">Get one point from the line.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>abscissa</code> - desired abscissa for the point</dd> +<dt><span class="strong">Returns:</span></dt><dd>one point belonging to the line, at specified abscissa</dd></dl> +</li> +</ul> +<a name="toSubSpace(org.apache.commons.math3.geometry.Vector)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toSubSpace</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Vector1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Vector1D</a> toSubSpace(<a href="../../../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Euclidean3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Euclidean3D</a>> vector)</pre> +<div class="block">Transform a space point into a sub-space point.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>vector</code> - n-dimension point of the space</dd> +<dt><span class="strong">Returns:</span></dt><dd>(n-1)-dimension point of the sub-space corresponding to + the specified space point</dd></dl> +</li> +</ul> +<a name="toSpace(org.apache.commons.math3.geometry.Vector)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toSpace</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> toSpace(<a href="../../../../../../../org/apache/commons/math3/geometry/Vector.html" title="interface in org.apache.commons.math3.geometry">Vector</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Euclidean1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Euclidean1D</a>> vector)</pre> +<div class="block">Transform a sub-space point into a space point.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>vector</code> - (n-1)-dimension point of the sub-space</dd> +<dt><span class="strong">Returns:</span></dt><dd>n-dimension point of the space corresponding to the + specified sub-space point</dd></dl> +</li> +</ul> +<a name="toSubSpace(org.apache.commons.math3.geometry.Point)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toSubSpace</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Vector1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Vector1D</a> toSubSpace(<a href="../../../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Euclidean3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Euclidean3D</a>> point)</pre> +<div class="block">Transform a space point into a sub-space point.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Embedding.html#toSubSpace(org.apache.commons.math3.geometry.Point)">toSubSpace</a></code> in interface <code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Embedding.html" title="interface in org.apache.commons.math3.geometry.partitioning">Embedding</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Euclidean3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Euclidean3D</a>,<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Euclidean1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Euclidean1D</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>point</code> - n-dimension point of the space</dd> +<dt><span class="strong">Returns:</span></dt><dd>(n-1)-dimension point of the sub-space corresponding to + the specified space point</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#getAbscissa(org.apache.commons.math3.geometry.euclidean.threed.Vector3D)"><code>getAbscissa(Vector3D)</code></a></dd></dl> +</li> +</ul> +<a name="toSpace(org.apache.commons.math3.geometry.Point)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toSpace</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> toSpace(<a href="../../../../../../../org/apache/commons/math3/geometry/Point.html" title="interface in org.apache.commons.math3.geometry">Point</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Euclidean1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Euclidean1D</a>> point)</pre> +<div class="block">Transform a sub-space point into a space point.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Embedding.html#toSpace(org.apache.commons.math3.geometry.Point)">toSpace</a></code> in interface <code><a href="../../../../../../../org/apache/commons/math3/geometry/partitioning/Embedding.html" title="interface in org.apache.commons.math3.geometry.partitioning">Embedding</a><<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Euclidean3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Euclidean3D</a>,<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/oned/Euclidean1D.html" title="class in org.apache.commons.math3.geometry.euclidean.oned">Euclidean1D</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>point</code> - (n-1)-dimension point of the sub-space</dd> +<dt><span class="strong">Returns:</span></dt><dd>n-dimension point of the space corresponding to the + specified sub-space point</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html#pointAt(double)"><code>pointAt(double)</code></a></dd></dl> +</li> +</ul> +<a name="isSimilarTo(org.apache.commons.math3.geometry.euclidean.threed.Line)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSimilarTo</h4> +<pre>public boolean isSimilarTo(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</pre> +<div class="block">Check if the instance is similar to another line. + <p>Lines are considered similar if they contain the same + points. This does not mean they are equal since they can have + opposite directions.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>line</code> - line to which instance should be compared</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the lines are similar</dd></dl> +</li> +</ul> +<a name="contains(org.apache.commons.math3.geometry.euclidean.threed.Vector3D)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p)</pre> +<div class="block">Check if the instance contains a point.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - point to check</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if p belongs to the line</dd></dl> +</li> +</ul> +<a name="distance(org.apache.commons.math3.geometry.euclidean.threed.Vector3D)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>distance</h4> +<pre>public double distance(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> p)</pre> +<div class="block">Compute the distance between the instance and a point.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - to check</dd> +<dt><span class="strong">Returns:</span></dt><dd>distance between the instance and the point</dd></dl> +</li> +</ul> +<a name="distance(org.apache.commons.math3.geometry.euclidean.threed.Line)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>distance</h4> +<pre>public double distance(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</pre> +<div class="block">Compute the shortest distance between the instance and another line.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>line</code> - line to check against the instance</dd> +<dt><span class="strong">Returns:</span></dt><dd>shortest distance between the instance and the line</dd></dl> +</li> +</ul> +<a name="closestPoint(org.apache.commons.math3.geometry.euclidean.threed.Line)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>closestPoint</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> closestPoint(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</pre> +<div class="block">Compute the point of the instance closest to another line.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>line</code> - line to check against the instance</dd> +<dt><span class="strong">Returns:</span></dt><dd>point of the instance closest to another line</dd></dl> +</li> +</ul> +<a name="intersection(org.apache.commons.math3.geometry.euclidean.threed.Line)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>intersection</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Vector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Vector3D</a> intersection(<a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/Line.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">Line</a> line)</pre> +<div class="block">Get the intersection point of the instance and another line.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>line</code> - other line</dd> +<dt><span class="strong">Returns:</span></dt><dd>intersection point of the instance and the other line + or null if there are no intersection points</dd></dl> +</li> +</ul> +<a name="wholeLine()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>wholeLine</h4> +<pre>public <a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/SubLine.html" title="class in org.apache.commons.math3.geometry.euclidean.threed">SubLine</a> wholeLine()</pre> +<div class="block">Build a sub-line covering the whole line.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a sub-line covering the whole line</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Line.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/FieldVector3D.html" title="class in org.apache.commons.math3.geometry.euclidean.threed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../../org/apache/commons/math3/geometry/euclidean/threed/NotARotationMatrixException.html" title="class in org.apache.commons.math3.geometry.euclidean.threed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/commons/math3/geometry/euclidean/threed/Line.html" target="_top">Frames</a></li> +<li><a href="Line.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2003–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |