blob: ba3b6ba06e4dd9be2ae1c0071d06e7717793a8e0 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_262) on Wed Mar 10 21:50:06 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Circle (Eclipse MOSAIC Parent 21.0 API)</title>
<meta name="date" content="2021-03-10">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Circle (Eclipse MOSAIC Parent 21.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":18,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Circle.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">
<li><a href="../../../../../org/eclipse/mosaic/lib/geo/CartesianRectangle.html" title="class in org.eclipse.mosaic.lib.geo"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/mosaic/lib/geo/GeoArea.html" title="interface in org.eclipse.mosaic.lib.geo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/lib/geo/Circle.html" target="_top">Frames</a></li>
<li><a href="Circle.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.mosaic.lib.geo</div>
<h2 title="Interface Circle" class="title">Interface Circle&lt;T extends <a href="../../../../../org/eclipse/mosaic/lib/geo/Point.html" title="interface in org.eclipse.mosaic.lib.geo">Point</a>&lt;T&gt;&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/eclipse/mosaic/lib/geo/Area.html" title="interface in org.eclipse.mosaic.lib.geo">Area</a>&lt;T&gt;, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/eclipse/mosaic/lib/geo/CartesianCircle.html" title="class in org.eclipse.mosaic.lib.geo">CartesianCircle</a>, <a href="../../../../../org/eclipse/mosaic/lib/geo/GeoCircle.html" title="class in org.eclipse.mosaic.lib.geo">GeoCircle</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Circle&lt;T extends <a href="../../../../../org/eclipse/mosaic/lib/geo/Point.html" title="interface in org.eclipse.mosaic.lib.geo">Point</a>&lt;T&gt;&gt;</span>
extends <a href="../../../../../org/eclipse/mosaic/lib/geo/Area.html" title="interface in org.eclipse.mosaic.lib.geo">Area</a>&lt;T&gt;</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html#contains-T-">contains</a></span>(<a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a>&nbsp;point)</code>
<div class="block">Checks whether the coordinate located in a circular area.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html#getArea--">getArea</a></span>()</code>
<div class="block">Calculates the size of this area in square meters.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html#getCenter--">getCenter</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html#getRadius--">getRadius</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/mosaic/lib/geo/Polygon.html" title="interface in org.eclipse.mosaic.lib.geo">Polygon</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html#toPolygon--">toPolygon</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.lib.geo.Area">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.mosaic.lib.geo.<a href="../../../../../org/eclipse/mosaic/lib/geo/Area.html" title="interface in org.eclipse.mosaic.lib.geo">Area</a></h3>
<code><a href="../../../../../org/eclipse/mosaic/lib/geo/Area.html#getBounds--">getBounds</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCenter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCenter</h4>
<pre><a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a>&nbsp;getCenter()</pre>
</li>
</ul>
<a name="getRadius--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRadius</h4>
<pre>double&nbsp;getRadius()</pre>
</li>
</ul>
<a name="toPolygon--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPolygon</h4>
<pre><a href="../../../../../org/eclipse/mosaic/lib/geo/Polygon.html" title="interface in org.eclipse.mosaic.lib.geo">Polygon</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a>&gt;&nbsp;toPolygon()</pre>
</li>
</ul>
<a name="contains-org.eclipse.mosaic.lib.geo.Point-">
<!-- -->
</a><a name="contains-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>default&nbsp;boolean&nbsp;contains(<a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a>&nbsp;point)</pre>
<div class="block">Checks whether the coordinate located in a circular area.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/lib/geo/Area.html#contains-T-">contains</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/lib/geo/Area.html" title="interface in org.eclipse.mosaic.lib.geo">Area</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a> extends <a href="../../../../../org/eclipse/mosaic/lib/geo/Point.html" title="interface in org.eclipse.mosaic.lib.geo">Point</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a>&gt;&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>point</code> - the coordinate to check.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the coordinate is in the area, otherwise false.</dd>
</dl>
</li>
</ul>
<a name="getArea--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getArea</h4>
<pre>default&nbsp;double&nbsp;getArea()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/mosaic/lib/geo/Area.html#getArea--">Area</a></code></span></div>
<div class="block">Calculates the size of this area in square meters.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/lib/geo/Area.html#getArea--">getArea</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/mosaic/lib/geo/Area.html" title="interface in org.eclipse.mosaic.lib.geo">Area</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a> extends <a href="../../../../../org/eclipse/mosaic/lib/geo/Point.html" title="interface in org.eclipse.mosaic.lib.geo">Point</a>&lt;<a href="../../../../../org/eclipse/mosaic/lib/geo/Circle.html" title="type parameter in Circle">T</a>&gt;&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the size of this area in square meters</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Circle.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">
<li><a href="../../../../../org/eclipse/mosaic/lib/geo/CartesianRectangle.html" title="class in org.eclipse.mosaic.lib.geo"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/mosaic/lib/geo/GeoArea.html" title="interface in org.eclipse.mosaic.lib.geo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/lib/geo/Circle.html" target="_top">Frames</a></li>
<li><a href="Circle.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020&#x2013;2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>