| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>Shapes2D (Apache SIS 1.3 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.sis.geometry, class: Shapes2D"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.geometry.Shapes2D class"> |
| <meta name="keywords" content="intersectionPoint()"> |
| <meta name="keywords" content="nearestColinearPoint()"> |
| <meta name="keywords" content="colinearPoint()"> |
| <meta name="keywords" content="circle()"> |
| <meta name="keywords" content="intersect()"> |
| <meta name="keywords" content="transform()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Shapes2D.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#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.geometry</a></div> |
| <h1 title="Class Shapes2D" class="title">Class Shapes2D</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="../util/Static.html" title="class in org.apache.sis.util">Static</a> |
| <div class="inheritance">Shapes2D</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Shapes2D</span> |
| <span class="extends-implements">extends <a href="../util/Static.html" title="class in org.apache.sis.util">Static</a></span></div> |
| <div class="block">Utility methods working on Java2D shapes. |
| The <code>transform(…)</code> methods in this class work in the same way than the methods of the same signature |
| in <a href="Envelopes.html" title="class in org.apache.sis.geometry"><code>Envelopes</code></a>, except that they work on <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link"><code>Rectangle2D</code></a> objects instead of <code>Envelope</code>. |
| In particular, the same treatment for curvatures and poles is applied.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Ellipse2D.html" title="class or interface in java.awt.geom" class="external-link">Ellipse2D</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#circle(java.awt.geom.Point2D,java.awt.geom.Point2D,java.awt.geom.Point2D)" class="member-name-link">circle</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> P1, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> P2, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> P3)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a circle passing by the 3 given points.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#colinearPoint(java.awt.geom.Line2D,java.awt.geom.Point2D,double)" class="member-name-link">colinearPoint</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html" title="class or interface in java.awt.geom" class="external-link">Line2D</a> line, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> point, |
| double distance)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a point on the given <code>line</code> segment located at the given <code>distance</code> from that line.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#intersect(java.awt.geom.RectangularShape,org.opengis.geometry.Envelope,int,int)" class="member-name-link">intersect</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/RectangularShape.html" title="class or interface in java.awt.geom" class="external-link">RectangularShape</a> shape, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a> envelope, |
| int xdim, |
| int ydim)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Sets the given shape to the intersection of that shape with the given envelope.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#intersectionPoint(java.awt.geom.Line2D,java.awt.geom.Line2D)" class="member-name-link">intersectionPoint</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html" title="class or interface in java.awt.geom" class="external-link">Line2D</a> a, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html" title="class or interface in java.awt.geom" class="external-link">Line2D</a> b)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the intersection point between two line segments.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#nearestColinearPoint(java.awt.geom.Line2D,java.awt.geom.Point2D)" class="member-name-link">nearestColinearPoint</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html" title="class or interface in java.awt.geom" class="external-link">Line2D</a> segment, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> point)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the point on the given <code>line</code> segment which is closest to the given <code>point</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#transform(org.opengis.referencing.operation.CoordinateOperation,java.awt.geom.Rectangle2D,java.awt.geom.Rectangle2D)" class="member-name-link">transform</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a> operation, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a> envelope, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a> destination)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Transforms a rectangular envelope using the given coordinate operation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#transform(org.opengis.referencing.operation.MathTransform2D,java.awt.geom.Rectangle2D,java.awt.geom.Rectangle2D)" class="member-name-link">transform</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform2D.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform2D</a> transform, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a> envelope, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a> destination)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Transforms a rectangular envelope using the given math transform.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="intersectionPoint(java.awt.geom.Line2D,java.awt.geom.Line2D)"> |
| <h3>intersectionPoint</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a></span> <span class="element-name">intersectionPoint</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html" title="class or interface in java.awt.geom" class="external-link">Line2D</a> a, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html" title="class or interface in java.awt.geom" class="external-link">Line2D</a> b)</span></div> |
| <div class="block">Returns the intersection point between two line segments. The lines do not continue to infinity; |
| if the intersection does not occur between the ending points <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html#getP1()" title="class or interface in java.awt.geom" class="external-link">P1</a> and |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html#getP2()" title="class or interface in java.awt.geom" class="external-link">P2</a> of the two line segments, then this method returns <code>null</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>a</code> - the first line segment.</dd> |
| <dd><code>b</code> - the second line segment.</dd> |
| <dt>Returns:</dt> |
| <dd>the intersection point, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nearestColinearPoint(java.awt.geom.Line2D,java.awt.geom.Point2D)"> |
| <h3>nearestColinearPoint</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a></span> <span class="element-name">nearestColinearPoint</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html" title="class or interface in java.awt.geom" class="external-link">Line2D</a> segment, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> point)</span></div> |
| <div class="block">Returns the point on the given <code>line</code> segment which is closest to the given <code>point</code>. |
| Let <code>result</code> be the returned point. This method guarantees (except for rounding errors) that: |
| |
| <ul> |
| <li><code>result</code> is a point on the <code>line</code> segment. It is located between |
| the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html#getP1()" title="class or interface in java.awt.geom" class="external-link">P1</a> and <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html#getP2()" title="class or interface in java.awt.geom" class="external-link">P2</a> ending |
| points of that line segment.</li> |
| <li>The distance between the <code>result</code> point and the given <code>point</code> is |
| the shortest distance among the set of points meeting the previous condition. |
| This distance can be obtained with <code>point.distance(result)</code>.</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>segment</code> - the line on which to search for a point.</dd> |
| <dd><code>point</code> - a point close to the given line.</dd> |
| <dt>Returns:</dt> |
| <dd>the nearest point on the given line.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#colinearPoint(java.awt.geom.Line2D,java.awt.geom.Point2D,double)"><code>colinearPoint(Line2D, Point2D, double)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="colinearPoint(java.awt.geom.Line2D,java.awt.geom.Point2D,double)"> |
| <h3>colinearPoint</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a></span> <span class="element-name">colinearPoint</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html" title="class or interface in java.awt.geom" class="external-link">Line2D</a> line, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> point, |
| double distance)</span></div> |
| <div class="block">Returns a point on the given <code>line</code> segment located at the given <code>distance</code> from that line. |
| Let <code>result</code> be the returned point. If <code>result</code> is not null, then this method guarantees |
| (except for rounding error) that: |
| |
| <ul> |
| <li><code>result</code> is a point on the <code>line</code> segment. It is located between |
| the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html#getP1()" title="class or interface in java.awt.geom" class="external-link">P1</a> and <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html#getP2()" title="class or interface in java.awt.geom" class="external-link">P2</a> ending |
| points of that line segment.</li> |
| <li>The distance between the <code>result</code> and the given <code>point</code> is exactly |
| equal to <code>distance</code>.</li> |
| </ul> |
| |
| If no result point meets those conditions, then this method returns <code>null</code>. |
| If two result points met those conditions, then this method returns the point |
| which is the closest to <code>line.getP1()</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>line</code> - the line on which to search for a point.</dd> |
| <dd><code>point</code> - a point close to the given line.</dd> |
| <dd><code>distance</code> - the distance between the given point and the point to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>a point on the given line located at the given distance from the given point.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#nearestColinearPoint(java.awt.geom.Line2D,java.awt.geom.Point2D)"><code>nearestColinearPoint(Line2D, Point2D)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="circle(java.awt.geom.Point2D,java.awt.geom.Point2D,java.awt.geom.Point2D)"> |
| <h3>circle</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Ellipse2D.html" title="class or interface in java.awt.geom" class="external-link">Ellipse2D</a></span> <span class="element-name">circle</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> P1, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> P2, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Point2D.html" title="class or interface in java.awt.geom" class="external-link">Point2D</a> P3)</span></div> |
| <div class="block">Returns a circle passing by the 3 given points.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>P1</code> - the first point.</dd> |
| <dd><code>P2</code> - the second point.</dd> |
| <dd><code>P3</code> - the third point.</dd> |
| <dt>Returns:</dt> |
| <dd>a circle passing by the given points.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="intersect(java.awt.geom.RectangularShape,org.opengis.geometry.Envelope,int,int)"> |
| <h3>intersect</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">intersect</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/RectangularShape.html" title="class or interface in java.awt.geom" class="external-link">RectangularShape</a> shape, |
| <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Envelope.html" title="class or interface in org.opengis.geometry" class="external-link">Envelope</a> envelope, |
| int xdim, |
| int ydim)</span></div> |
| <div class="block">Sets the given shape to the intersection of that shape with the given envelope.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>shape</code> - the shape to intersect. Will be modified in-place.</dd> |
| <dd><code>envelope</code> - the envelope to intersect with the given shape.</dd> |
| <dd><code>xdim</code> - dimension of <var>x</var> coordinates in the envelope. This is usually 0.</dd> |
| <dd><code>ydim</code> - dimension of <var>y</var> coordinates in the envelope. This is usually 1.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="transform(org.opengis.referencing.operation.MathTransform2D,java.awt.geom.Rectangle2D,java.awt.geom.Rectangle2D)"> |
| <h3>transform</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a></span> <span class="element-name">transform</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/MathTransform2D.html" title="class or interface in org.opengis.referencing.operation" class="external-link">MathTransform2D</a> transform, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a> envelope, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a> destination)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/TransformException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">TransformException</a></span></div> |
| <div class="block">Transforms a rectangular envelope using the given math transform. |
| The transformation is only approximated: the returned envelope may be bigger than |
| necessary, or smaller than required if the bounding box contains a pole. |
| |
| <p>Note that this method cannot handle the case where the rectangle contains the North or South pole, |
| or when it cross the ±180° longitude, because <code>MathTransform</code> does not carry sufficient information. |
| For a more robust rectangle transformation, use <a href="#transform(org.opengis.referencing.operation.CoordinateOperation,java.awt.geom.Rectangle2D,java.awt.geom.Rectangle2D)"><code>transform(CoordinateOperation, Rectangle2D, Rectangle2D)</code></a> |
| instead.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>transform</code> - the transform to use. Source and target dimension must be 2.</dd> |
| <dd><code>envelope</code> - the rectangle to transform (may be <code>null</code>).</dd> |
| <dd><code>destination</code> - the destination rectangle (may be <code>envelope</code>). |
| If <code>null</code>, a new rectangle will be created and returned.</dd> |
| <dt>Returns:</dt> |
| <dd><code>destination</code>, or a new rectangle if <code>destination</code> was null and <code>envelope</code> was non-null.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/TransformException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">TransformException</a></code> - if a transform failed.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#transform(org.opengis.referencing.operation.CoordinateOperation,java.awt.geom.Rectangle2D,java.awt.geom.Rectangle2D)"><code>transform(CoordinateOperation, Rectangle2D, Rectangle2D)</code></a></li> |
| <li><a href="Envelopes.html#transform(org.opengis.referencing.operation.MathTransform,org.opengis.geometry.Envelope)"><code>Envelopes.transform(MathTransform, Envelope)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="transform(org.opengis.referencing.operation.CoordinateOperation,java.awt.geom.Rectangle2D,java.awt.geom.Rectangle2D)"> |
| <h3>transform</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a></span> <span class="element-name">transform</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/CoordinateOperation.html" title="class or interface in org.opengis.referencing.operation" class="external-link">CoordinateOperation</a> operation, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a> envelope, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Rectangle2D.html" title="class or interface in java.awt.geom" class="external-link">Rectangle2D</a> destination)</span> |
| throws <span class="exceptions"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/TransformException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">TransformException</a></span></div> |
| <div class="block">Transforms a rectangular envelope using the given coordinate operation. |
| The transformation is only approximated: the returned envelope may be bigger |
| than the smallest possible bounding box, but should not be smaller in most cases. |
| |
| <p>This method can handle the case where the rectangle contains the North or South pole, |
| or when it cross the ±180° longitude.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>operation</code> - the operation to use. Source and target dimension must be 2.</dd> |
| <dd><code>envelope</code> - the rectangle to transform (may be <code>null</code>).</dd> |
| <dd><code>destination</code> - the destination rectangle (may be <code>envelope</code>). |
| If <code>null</code>, a new rectangle will be created and returned.</dd> |
| <dt>Returns:</dt> |
| <dd><code>destination</code>, or a new rectangle if <code>destination</code> was null and <code>envelope</code> was non-null.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/operation/TransformException.html" title="class or interface in org.opengis.referencing.operation" class="external-link">TransformException</a></code> - if a transform failed.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#transform(org.opengis.referencing.operation.MathTransform2D,java.awt.geom.Rectangle2D,java.awt.geom.Rectangle2D)"><code>transform(MathTransform2D, Rectangle2D, Rectangle2D)</code></a></li> |
| <li><a href="Envelopes.html#transform(org.opengis.referencing.operation.CoordinateOperation,org.opengis.geometry.Envelope)"><code>Envelopes.transform(CoordinateOperation, Envelope)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |