| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>org.apache.sis.geometry (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <meta name="keywords" content="org.apache.sis.geometry package"> |
| <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="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.sis.geometry (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.sis.geometry</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Basic geometric objects (envelopes and direct positions). Every geometry objects are associated |
| with a <a href="../referencing/crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">Coordinate Reference System</a>, |
| which may have an arbitrary number of dimensions. However a few specialized classes restrict |
| the CRS to a fixed number of dimensions only. The table below summarizes the most common |
| objects, and list the Java2D classes that are conceptually equivalent. |
| |
| <table class="sis"> |
| <caption>Java2D and geometry equivalences</caption> |
| <tr> |
| <th>Purpose</th> |
| <th>Any dimension</th> |
| <th>One dimension</th> |
| <th>Two dimensions</th> |
| <th>Java2D equivalence</th> |
| </tr><tr> |
| <td>A point in a multi-dimensional space</td> |
| <td><a href="GeneralDirectPosition.html" title="class in org.apache.sis.geometry"><code>GeneralDirectPosition</code></a></td> |
| <td><a href="DirectPosition1D.html" title="class in org.apache.sis.geometry"><code>DirectPosition1D</code></a></td> |
| <td><a href="DirectPosition2D.html" title="class in org.apache.sis.geometry"><code>DirectPosition2D</code></a></td> |
| <td><a href="https://docs.oracle.com/javase/8/docs/api/java/awt/geom/Point2D.html?is-external=true" title="class or interface in java.awt.geom" class="externalLink"><code>Point2D</code></a></td> |
| </tr><tr> |
| <td>A box in a multi-dimensional space</td> |
| <td><a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry"><code>GeneralEnvelope</code></a></td> |
| <td></td> |
| <td><a href="Envelope2D.html" title="class in org.apache.sis.geometry"><code>Envelope2D</code></a></td> |
| <td><a href="https://docs.oracle.com/javase/8/docs/api/java/awt/geom/Rectangle2D.html?is-external=true" title="class or interface in java.awt.geom" class="externalLink"><code>Rectangle2D</code></a></td> |
| </tr> |
| </table> |
| |
| <div class="section">Java2D dependency</div> |
| All classes having a name that ends with "2D" are designed for inter-operability with Java2D. |
| All other classes have no dependency to Java2D. |
| This clear separation aims to make easier to use Apache SIS on platforms that do not support Java2D |
| (for example Android) or to avoid loading Java2D classes when only JavaFX is desired. |
| |
| <div class="section">Envelopes spanning the anti-meridian of a Geographic CRS</div> |
| The Web Coverage Service (WCS) 1.1 specification uses an extended interpretation |
| of the bounding box definition. In a WCS 1.1 data structure, the |
| <a href="AbstractEnvelope.html#getLowerCorner()">lower corner</a> |
| defines the edges region in the directions of <em>decreasing</em> coordinate values in the |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getCoordinateReferenceSystem()" title="class or interface in org.opengis.geometry" class="externalLink">envelope CRS</a>, |
| while the <a href="AbstractEnvelope.html#getUpperCorner()">upper corner</a> |
| defines the edges region in the directions of <em>increasing</em> coordinate values. |
| Those lower and upper corners are usually the algebraic |
| <a href="AbstractEnvelope.html#getMinimum(int)">minimum</a> and |
| <a href="AbstractEnvelope.html#getMaximum(int)">maximum</a> coordinates respectively, |
| but not always. For example, an envelope crossing the anti-meridian could have a lower corner |
| longitude greater than the upper corner longitude, like the red box below (the green box is the |
| usual case): |
| |
| <div style="text-align:center"> |
| <img src="doc-files/AntiMeridian.png" alt="Envelope spannning the anti-meridian"> |
| </div> |
| |
| In SIS, every envelopes defined in this package support the extended bounding box interpretation: |
| for any dimension, coordinate values such that <var>upper</var> < <var>lower</var> are handled |
| in a special way. This handling is slightly different for two groups of methods: |
| |
| <ul> |
| <li>In calculation of envelopes spans and median positions (centers) — handled specially only |
| on axes having the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/RangeMeaning.html?is-external=true#WRAPAROUND" title="class or interface in org.opengis.referencing.cs" class="externalLink"><code>WRAPAROUND</code></a> |
| range meaning.</li> |
| <li>When checking for containment, intersections or unions — can be handled specially for |
| any axis, in which case the envelope represents an <em>exclusion</em> area instead |
| than an inclusion area.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../setup/GeometryLibrary.html" title="enum in org.apache.sis.setup"><code>GeometryLibrary</code></a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractDirectPosition.html" title="class in org.apache.sis.geometry">AbstractDirectPosition</a></th> |
| <td class="colLast"> |
| <div class="block">Default implementations of some <code>DirectPosition</code> methods, leaving the data storage to subclasses.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></th> |
| <td class="colLast"> |
| <div class="block">Default implementations of most <code>Envelope</code> methods, leaving the data storage to subclasses.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="CoordinateFormat.html" title="class in org.apache.sis.geometry">CoordinateFormat</a></th> |
| <td class="colLast"> |
| <div class="block">Formats spatiotemporal coordinates using number, angle and date formats inferred from the coordinate system.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DirectPosition1D.html" title="class in org.apache.sis.geometry">DirectPosition1D</a></th> |
| <td class="colLast"> |
| <div class="block">A one-dimensional position within some coordinate reference system.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DirectPosition2D.html" title="class in org.apache.sis.geometry">DirectPosition2D</a></th> |
| <td class="colLast"> |
| <div class="block">A two-dimensional position on top of Java2D point.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Envelope2D.html" title="class in org.apache.sis.geometry">Envelope2D</a></th> |
| <td class="colLast"> |
| <div class="block">A two-dimensional envelope on top of Java2D rectangle.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Envelopes.html" title="class in org.apache.sis.geometry">Envelopes</a></th> |
| <td class="colLast"> |
| <div class="block">Transforms envelopes to new Coordinate Reference Systems, and miscellaneous utilities.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="GeneralDirectPosition.html" title="class in org.apache.sis.geometry">GeneralDirectPosition</a></th> |
| <td class="colLast"> |
| <div class="block">A mutable <code>DirectPosition</code> (the coordinates of a position) of arbitrary dimension.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry">GeneralEnvelope</a></th> |
| <td class="colLast"> |
| <div class="block">A mutable <code>Envelope</code> (a minimum bounding box or rectangle) of arbitrary dimension.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ImmutableEnvelope.html" title="class in org.apache.sis.geometry">ImmutableEnvelope</a></th> |
| <td class="colLast"> |
| <div class="block">An immutable <code>Envelope</code> (a minimum bounding box or rectangle) of arbitrary dimension.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Shapes2D.html" title="class in org.apache.sis.geometry">Shapes2D</a></th> |
| <td class="colLast"> |
| <div class="block">Utility methods working on Java2D shapes.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="MismatchedReferenceSystemException.html" title="class in org.apache.sis.geometry">MismatchedReferenceSystemException</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates that an object cannot be constructed because of a mismatch in the |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">reference systems</a> of |
| geometric components.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="UnmodifiableGeometryException.html" title="class in org.apache.sis.geometry">UnmodifiableGeometryException</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates that an operation is not allowed on a geometry object |
| because it is unmodifiable.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
