| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>Envelopes (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.Envelopes class"> |
| <meta name="keywords" content="compound()"> |
| <meta name="keywords" content="union()"> |
| <meta name="keywords" content="findOperation()"> |
| <meta name="keywords" content="intersect()"> |
| <meta name="keywords" content="transform()"> |
| <meta name="keywords" content="fromWKT()"> |
| <meta name="keywords" content="toString()"> |
| <meta name="keywords" content="toPolygonWKT()"> |
| <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="Envelopes (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Envelopes.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.geometry</a></div> |
| <h2 title="Class Envelopes" class="title">Class Envelopes</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../util/Static.html" title="class in org.apache.sis.util">Static</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>Envelopes</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">Envelopes</span> |
| extends <a href="../util/Static.html" title="class in org.apache.sis.util">Static</a></pre> |
| <div class="block">Transforms envelopes to new Coordinate Reference Systems, and miscellaneous utilities. |
| |
| <div class="section">Envelope transformations</div> |
| All <code>transform(…)</code> methods in this class take in account the curvature of the transformed shape. |
| For example the shape of a geographic envelope (figure below on the left side) is not rectangular in a |
| conic projection (figure below on the right side). In order to get the envelope represented by the red |
| rectangle, projecting the four corners of the geographic envelope is not sufficient since we would miss |
| the southerner part. |
| |
| <table class="sis"> |
| <caption>Example of curvature induced by a map projection</caption> |
| <tr> |
| <th>Envelope before map projection</th> |
| <th>Shape of the projected envelope</th> |
| </tr><tr> |
| <td><img src="doc-files/GeographicArea.png" alt="Envelope in a geographic CRS"></td> |
| <td><img src="doc-files/ConicArea.png" alt="Shape of the envelope transformed in a conic projection"></td> |
| </tr> |
| </table> |
| |
| Apache SIS tries to detect the curvature by transforming intermediate points in addition to the corners. |
| While optional, it is strongly recommended that all <code>MathTransform</code> implementations involved in the |
| operation (directly or indirectly) support <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true#derivative(org.opengis.geometry.DirectPosition)" title="class or interface in org.opengis.referencing.operation" class="externalLink">derivative</a>, |
| for more accurate calculation of curve extremum. This is the case of most Apache SIS implementations. |
| |
| <p>The <code>transform(…)</code> methods in this class expect an arbitrary <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink"><code>Envelope</code></a> with <strong>one</strong> |
| of the following arguments: <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>MathTransform</code></a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>CoordinateOperation</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink"><code>CoordinateReferenceSystem</code></a>. |
| The recommended method is the one expecting a <code>CoordinateOperation</code> object, |
| since it contains sufficient information for handling the cases of envelopes that encompass a pole. |
| The method expecting a <code>CoordinateReferenceSystem</code> object is merely a convenience method that |
| infers the coordinate operation itself, but at the cost of performance if the same operation needs |
| to be applied on many envelopes.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../metadata/iso/extent/Extents.html" title="class in org.apache.sis.metadata.iso.extent"><code>Extents</code></a>, |
| <a href="../referencing/CRS.html" title="class in org.apache.sis.referencing"><code>CRS</code></a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compound(org.opengis.geometry.Envelope...)">compound</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>... components)</code></th> |
| <td class="colLast"> |
| <div class="block">Puts together a list of envelopes, each of them using an independent coordinate reference system.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">CoordinateOperation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findOperation(org.opengis.geometry.Envelope,org.opengis.geometry.Envelope)">findOperation</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> source, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> target)</code></th> |
| <td class="colLast"> |
| <div class="block">Finds a mathematical operation from the CRS of the given source envelope to the CRS of the given target envelope.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromWKT(java.lang.CharSequence)">fromWKT</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a> wkt)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the bounding box of a geometry defined in <cite>Well Known Text</cite> (WKT) format.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry">GeneralEnvelope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#intersect(org.opengis.geometry.Envelope...)">intersect</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>... envelopes)</code></th> |
| <td class="colLast"> |
| <div class="block">Computes the intersection of all given envelopes, transforming them to a common CRS if necessary.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toPolygonWKT(org.opengis.geometry.Envelope)">toPolygonWKT</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Formats the given envelope as a <code>POLYGON</code> element in the <cite>Well Known Text</cite> |
| (WKT) format.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString(org.opengis.geometry.Envelope)">toString</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Formats the given envelope as a <code>BOX</code> element.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transform(org.opengis.geometry.Envelope,org.opengis.referencing.crs.CoordinateReferenceSystem)">transform</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a> targetCRS)</code></th> |
| <td class="colLast"> |
| <div class="block">Transforms the given envelope to the specified CRS.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry">GeneralEnvelope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transform(org.opengis.referencing.operation.CoordinateOperation,org.opengis.geometry.Envelope)">transform</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">CoordinateOperation</a> operation, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Transforms an envelope using the given coordinate operation.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry">GeneralEnvelope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transform(org.opengis.referencing.operation.MathTransform,org.opengis.geometry.Envelope)">transform</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a> transform, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope)</code></th> |
| <td class="colLast"> |
| <div class="block">Transforms an envelope using the given math transform.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry">GeneralEnvelope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#union(org.opengis.geometry.Envelope...)">union</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>... envelopes)</code></th> |
| <td class="colLast"> |
| <div class="block">Computes the union of all given envelopes, transforming them to a common CRS if necessary.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="compound(org.opengis.geometry.Envelope...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compound</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> compound​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>... components) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/FactoryException.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">FactoryException</a></pre> |
| <div class="block">Puts together a list of envelopes, each of them using an independent coordinate reference system. |
| The dimension of the returned envelope is the sum of the dimension of all components. |
| If all components have a coordinate reference system, then the returned envelope will |
| have a compound coordinate reference system.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>components</code> - the envelopes to aggregate in a single envelope, in the given order.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the aggregation of all given envelopes.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/FactoryException.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">FactoryException</a></code> - if the geodetic factory failed to create the compound CRS.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../referencing/CRS.html#compound(org.opengis.referencing.crs.CoordinateReferenceSystem...)"><code>CRS.compound(CoordinateReferenceSystem...)</code></a>, |
| <a href="../referencing/operation/transform/MathTransforms.html#compound(org.opengis.referencing.operation.MathTransform...)"><code>MathTransforms.compound(MathTransform...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="union(org.opengis.geometry.Envelope...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>union</h4> |
| <pre class="methodSignature">public static <a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry">GeneralEnvelope</a> union​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>... envelopes) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></pre> |
| <div class="block">Computes the union of all given envelopes, transforming them to a common CRS if necessary. |
| If all envelopes use the same CRS (<a href="../util/ComparisonMode.html#IGNORE_METADATA"><code>ignoring metadata</code></a>) |
| or if the CRS of all envelopes is <code>null</code>, then the <a href="GeneralEnvelope.html#add(org.opengis.geometry.Envelope)">union is computed</a> without transforming any envelope. Otherwise all envelopes are transformed to a |
| <a href="../referencing/CRS.html#suggestCommonTarget(org.opengis.metadata.extent.GeographicBoundingBox,org.opengis.referencing.crs.CoordinateReferenceSystem...)">common CRS</a> before union is computed. |
| The CRS of the returned envelope may different than the CRS of all given envelopes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelopes</code> - the envelopes for which to compute union. Null elements are ignored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>union of given envelopes, or <code>null</code> if the given array does not contain non-null elements.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></code> - if this method can not determine a common CRS, or if a transformation failed.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="GeneralEnvelope.html#add(org.opengis.geometry.Envelope)"><code>GeneralEnvelope.add(Envelope)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="findOperation(org.opengis.geometry.Envelope,org.opengis.geometry.Envelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findOperation</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">CoordinateOperation</a> findOperation​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> source, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> target) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/FactoryException.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">FactoryException</a></pre> |
| <div class="block">Finds a mathematical operation from the CRS of the given source envelope to the CRS of the given target envelope. |
| For non-null georeferenced envelopes, this method is equivalent to the following code with <code>areaOfInterest</code> |
| computed as the union of the two envelopes: |
| |
| <blockquote><code>return <a href="../referencing/CRS.html#findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)">CRS.findOperation(CoordinateReferenceSystem, CoordinateReferenceSystem, |
| GeographicBoundingBox)</a> CRS.findOperation(source.getCoordinateReferenceSystem(), target.getCoordinateReferenceSystem(), |
| <var>areaOfInterest</var>)</code></blockquote> |
| |
| If at least one envelope is null or has no CRS, then this method returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the source envelope, or <code>null</code>.</dd> |
| <dd><code>target</code> - the target envelope, or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the mathematical operation from <code>source</code> CRS to <code>target</code> CRS, |
| or <code>null</code> if at least one argument is null or has no CRS.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/OperationNotFoundException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">OperationNotFoundException</a></code> - if no operation was found between the given pair of CRS.</dd> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/FactoryException.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">FactoryException</a></code> - if the operation can not be created for another reason.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../referencing/CRS.html#findOperation(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.metadata.extent.GeographicBoundingBox)"><code>CRS.findOperation(CoordinateReferenceSystem, CoordinateReferenceSystem, GeographicBoundingBox)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="intersect(org.opengis.geometry.Envelope...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>intersect</h4> |
| <pre class="methodSignature">public static <a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry">GeneralEnvelope</a> intersect​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>... envelopes) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></pre> |
| <div class="block">Computes the intersection of all given envelopes, transforming them to a common CRS if necessary. |
| If all envelopes use the same CRS (<a href="../util/ComparisonMode.html#IGNORE_METADATA"><code>ignoring metadata</code></a>) |
| or if the CRS of all envelopes is <code>null</code>, then the <a href="GeneralEnvelope.html#intersect(org.opengis.geometry.Envelope)">intersection is computed</a> without transforming any envelope. Otherwise all envelopes are transformed to a |
| <a href="../referencing/CRS.html#suggestCommonTarget(org.opengis.metadata.extent.GeographicBoundingBox,org.opengis.referencing.crs.CoordinateReferenceSystem...)">common CRS</a> before intersection is computed. |
| The CRS of the returned envelope may different than the CRS of all given envelopes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelopes</code> - the envelopes for which to compute intersection. Null elements are ignored.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>intersection of given envelopes, or <code>null</code> if the given array does not contain non-null elements.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></code> - if this method can not determine a common CRS, or if a transformation failed.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="GeneralEnvelope.html#intersect(org.opengis.geometry.Envelope)"><code>GeneralEnvelope.intersect(Envelope)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="transform(org.opengis.geometry.Envelope,org.opengis.referencing.crs.CoordinateReferenceSystem)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transform</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> transform​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a> targetCRS) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></pre> |
| <div class="block">Transforms the given envelope to the specified CRS. If any argument is null, or if 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> is null or the |
| same instance than the given target CRS, then the given envelope is returned unchanged. |
| Otherwise a new transformed envelope is returned. |
| |
| <div class="section">Performance tip</div> |
| If there is many envelopes to transform with the same source and target CRS, then it is more efficient |
| to get the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>CoordinateOperation</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>MathTransform</code></a> instance once and invoke one of the |
| others <code>transform(…)</code> methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelope</code> - the envelope to transform (may be <code>null</code>).</dd> |
| <dd><code>targetCRS</code> - the target CRS (may be <code>null</code>).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new transformed envelope, or directly <code>envelope</code> if no change was required.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></code> - if a transformation was required and failed.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="transform(org.opengis.referencing.operation.MathTransform,org.opengis.geometry.Envelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transform</h4> |
| <pre class="methodSignature">public static <a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry">GeneralEnvelope</a> transform​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">MathTransform</a> transform, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></pre> |
| <div class="block">Transforms an 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. |
| The coordinate reference system of the returned envelope will be null. |
| |
| <div class="section">Limitation</div> |
| This method can not handle the case where the envelope contains the North or South pole, |
| or when it crosses the ±180° longitude, because <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/MathTransform.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink"><code>MathTransform</code></a> does not carry sufficient information. |
| For a more robust envelope transformation, use <a href="#transform(org.opengis.referencing.operation.CoordinateOperation,org.opengis.geometry.Envelope)"><code>transform(CoordinateOperation, Envelope)</code></a> instead.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>transform</code> - the transform to use.</dd> |
| <dd><code>envelope</code> - envelope to transform, or <code>null</code>. This envelope will not be modified.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the transformed envelope, or <code>null</code> if <code>envelope</code> was null.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></code> - if a transform failed.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#transform(org.opengis.referencing.operation.CoordinateOperation,org.opengis.geometry.Envelope)"><code>transform(CoordinateOperation, Envelope)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="transform(org.opengis.referencing.operation.CoordinateOperation,org.opengis.geometry.Envelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transform</h4> |
| <pre class="methodSignature">public static <a href="GeneralEnvelope.html" title="class in org.apache.sis.geometry">GeneralEnvelope</a> transform​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/CoordinateOperation.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">CoordinateOperation</a> operation, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></pre> |
| <div class="block">Transforms an 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 envelope contains the North or South pole, |
| or when it cross the ±180° longitude.</p> |
| |
| <div class="note"><b>Note:</b> |
| If the envelope CRS is non-null, then the caller should ensure that the operation source CRS |
| is the same than the envelope CRS. In case of mismatch, this method transforms the envelope |
| to the operation source CRS before to apply the operation. This extra step may cause a lost |
| of accuracy. In order to prevent this method from performing such pre-transformation (if not desired), |
| callers can ensure that the envelope CRS is <code>null</code> before to call this method.</div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operation</code> - the operation to use.</dd> |
| <dd><code>envelope</code> - envelope to transform, or <code>null</code>. This envelope will not be modified.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the transformed envelope, or <code>null</code> if <code>envelope</code> was null.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/operation/TransformException.html?is-external=true" title="class or interface in org.opengis.referencing.operation" class="externalLink">TransformException</a></code> - if a transform failed.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#transform(org.opengis.referencing.operation.MathTransform,org.opengis.geometry.Envelope)"><code>transform(MathTransform, Envelope)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fromWKT(java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromWKT</h4> |
| <pre class="methodSignature">public static <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> fromWKT​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a> wkt) |
| throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/FactoryException.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">FactoryException</a></pre> |
| <div class="block">Returns the bounding box of a geometry defined in <cite>Well Known Text</cite> (WKT) format. |
| This method does not check the consistency of the provided WKT. For example it does not check |
| that every points in a <code>LINESTRING</code> have the same dimension. However this method |
| ensures that the parenthesis are balanced, in order to catch some malformed WKT. |
| |
| <p>Example:</p> |
| <ul> |
| <li><code>BOX(-180 -90, 180 90)</code> (not really a geometry, but understood by many software products)</li> |
| <li><code>POINT(6 10)</code></li> |
| <li><code>MULTIPOLYGON(((1 1, 5 1, 1 5, 1 1),(2 2, 3 2, 3 3, 2 2)))</code></li> |
| <li><code>GEOMETRYCOLLECTION(POINT(4 6),LINESTRING(3 8,7 10))</code></li> |
| </ul> |
| |
| See <a href="GeneralEnvelope.html#%3Cinit%3E(java.lang.CharSequence)"><code>GeneralEnvelope(CharSequence)</code></a> for more information about the |
| parsing rules.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wkt</code> - the <code>BOX</code>, <code>POLYGON</code> or other kind of element to parse.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the envelope of the given geometry.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/FactoryException.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">FactoryException</a></code> - if the given WKT can not be parsed.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#toString(org.opengis.geometry.Envelope)"><code>toString(Envelope)</code></a>, |
| <a href="../referencing/CRS.html#fromWKT(java.lang.String)"><code>CRS.fromWKT(String)</code></a>, |
| <a href="../io/wkt/package-summary.html"><code>org.apache.sis.io.wkt</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString(org.opengis.geometry.Envelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> toString​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope)</pre> |
| <div class="block">Formats the given envelope as a <code>BOX</code> element. The output is like below, |
| where <var>n</var> is the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">number of dimensions</a> |
| (omitted if equals to 2): |
| |
| <blockquote><code>BOX</code><var>n</var><code>D(</code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getLowerCorner()" title="class or interface in org.opengis.geometry" class="externalLink">lower |
| corner</a><code>,</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getUpperCorner()" title="class or interface in org.opengis.geometry" class="externalLink">upper corner</a><code>)</code></blockquote> |
| |
| <div class="note"><b>Note:</b> |
| The <code>BOX</code> element is not part of the standard <cite>Well Known Text</cite> (WKT) format. |
| However it is understood by many software libraries, for example GDAL and PostGIS.</div> |
| |
| The string returned by this method can be <a href="GeneralEnvelope.html#%3Cinit%3E(java.lang.CharSequence)">parsed</a> by the <code>GeneralEnvelope</code> constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelope</code> - the envelope to format.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this envelope as a <code>BOX</code> or <code>BOX3D</code> (most typical dimensions) element.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#fromWKT(java.lang.CharSequence)"><code>fromWKT(CharSequence)</code></a>, |
| <a href="../io/wkt/package-summary.html"><code>org.apache.sis.io.wkt</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toPolygonWKT(org.opengis.geometry.Envelope)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toPolygonWKT</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> toPolygonWKT​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a> envelope) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></pre> |
| <div class="block">Formats the given envelope as a <code>POLYGON</code> element in the <cite>Well Known Text</cite> |
| (WKT) format. <code>POLYGON</code> can be used as an alternative to <code>BOX</code> when the element |
| needs to be considered as a standard WKT geometry. |
| |
| <p>The string returned by this method can be <a href="GeneralEnvelope.html#%3Cinit%3E(java.lang.CharSequence)">parsed</a> by the <code>GeneralEnvelope</code> constructor.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>envelope</code> - the envelope to format.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the envelope as a <code>POLYGON</code> in WKT format.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the given envelope can not be formatted.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../io/wkt/package-summary.html"><code>org.apache.sis.io.wkt</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Envelopes.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |