677 lines
14 KiB
HTML
677 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
|
<meta name="generator" content="JsDoc Toolkit" />
|
|
|
|
<title>JsDoc Reference - mxn.BoundingBox</title>
|
|
|
|
<style type="text/css">
|
|
/* default.css */
|
|
body
|
|
{
|
|
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
|
|
width: 800px;
|
|
}
|
|
|
|
.header
|
|
{
|
|
clear: both;
|
|
background-color: #ccc;
|
|
padding: 8px;
|
|
}
|
|
|
|
h1
|
|
{
|
|
font-size: 150%;
|
|
font-weight: bold;
|
|
padding: 0;
|
|
margin: 1em 0 0 .3em;
|
|
}
|
|
|
|
hr
|
|
{
|
|
border: none 0;
|
|
border-top: 1px solid #7F8FB1;
|
|
height: 1px;
|
|
}
|
|
|
|
pre.code
|
|
{
|
|
display: block;
|
|
padding: 8px;
|
|
border: 1px dashed #ccc;
|
|
}
|
|
|
|
#index
|
|
{
|
|
margin-top: 24px;
|
|
float: left;
|
|
width: 160px;
|
|
position: absolute;
|
|
left: 8px;
|
|
background-color: #F3F3F3;
|
|
padding: 8px;
|
|
}
|
|
|
|
#content
|
|
{
|
|
margin-left: 190px;
|
|
width: 600px;
|
|
}
|
|
|
|
.classList
|
|
{
|
|
list-style-type: none;
|
|
padding: 0;
|
|
margin: 0 0 0 8px;
|
|
font-family: arial, sans-serif;
|
|
font-size: 1em;
|
|
overflow: auto;
|
|
}
|
|
|
|
.classList li
|
|
{
|
|
padding: 0;
|
|
margin: 0 0 8px 0;
|
|
}
|
|
|
|
.summaryTable { width: 100%; }
|
|
|
|
h1.classTitle
|
|
{
|
|
font-size:170%;
|
|
line-height:130%;
|
|
}
|
|
|
|
h2 { font-size: 110%; }
|
|
caption, div.sectionTitle
|
|
{
|
|
background-color: #7F8FB1;
|
|
color: #fff;
|
|
font-size:130%;
|
|
text-align: left;
|
|
padding: 2px 6px 2px 6px;
|
|
border: 1px #7F8FB1 solid;
|
|
}
|
|
|
|
div.sectionTitle { margin-bottom: 8px; }
|
|
.summaryTable thead { display: none; }
|
|
|
|
.summaryTable td
|
|
{
|
|
vertical-align: top;
|
|
padding: 4px;
|
|
border-bottom: 1px #7F8FB1 solid;
|
|
border-right: 1px #7F8FB1 solid;
|
|
}
|
|
|
|
/*col#summaryAttributes {}*/
|
|
.summaryTable td.attributes
|
|
{
|
|
border-left: 1px #7F8FB1 solid;
|
|
width: 140px;
|
|
text-align: right;
|
|
}
|
|
|
|
td.attributes, .fixedFont
|
|
{
|
|
line-height: 15px;
|
|
color: #002EBE;
|
|
font-family: "Courier New",Courier,monospace;
|
|
font-size: 13px;
|
|
}
|
|
|
|
.summaryTable td.nameDescription
|
|
{
|
|
text-align: left;
|
|
font-size: 13px;
|
|
line-height: 15px;
|
|
}
|
|
|
|
.summaryTable td.nameDescription, .description
|
|
{
|
|
line-height: 15px;
|
|
padding: 4px;
|
|
padding-left: 4px;
|
|
}
|
|
|
|
.summaryTable { margin-bottom: 8px; }
|
|
|
|
ul.inheritsList
|
|
{
|
|
list-style: square;
|
|
margin-left: 20px;
|
|
padding-left: 0;
|
|
}
|
|
|
|
.detailList {
|
|
margin-left: 20px;
|
|
line-height: 15px;
|
|
}
|
|
.detailList dt { margin-left: 20px; }
|
|
|
|
.detailList .heading
|
|
{
|
|
font-weight: bold;
|
|
padding-bottom: 6px;
|
|
margin-left: 0;
|
|
}
|
|
|
|
.light, td.attributes, .light a:link, .light a:visited
|
|
{
|
|
color: #777;
|
|
font-style: italic;
|
|
}
|
|
|
|
.fineprint
|
|
{
|
|
text-align: right;
|
|
font-size: 10px;
|
|
}
|
|
</style>
|
|
</head>
|
|
|
|
<body>
|
|
<!-- ============================== header ================================= -->
|
|
<!-- begin static/header.html -->
|
|
<div id="header">
|
|
</div>
|
|
<!-- end static/header.html -->
|
|
|
|
<!-- ============================== classes index ============================ -->
|
|
<div id="index">
|
|
<!-- begin publish.classesIndex -->
|
|
<div align="center"><a href="../index.html">Class Index</a>
|
|
| <a href="../files.html">File Index</a></div>
|
|
<hr />
|
|
<h2>Classes</h2>
|
|
<ul class="classList">
|
|
|
|
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
|
|
|
|
<li><a href="../symbols/mxn.html">mxn</a></li>
|
|
|
|
<li><a href="../symbols/mxn.BoundingBox.html">mxn.BoundingBox</a></li>
|
|
|
|
<li><a href="../symbols/mxn.Event.html">mxn.Event</a></li>
|
|
|
|
<li><a href="../symbols/mxn.Geocoder.html">mxn.Geocoder</a></li>
|
|
|
|
<li><a href="../symbols/mxn.Invoker.html">mxn.Invoker</a></li>
|
|
|
|
<li><a href="../symbols/mxn.LatLonPoint.html">mxn.LatLonPoint</a></li>
|
|
|
|
<li><a href="../symbols/mxn.Mapstraction.html">mxn.Mapstraction</a></li>
|
|
|
|
<li><a href="../symbols/mxn.Marker.html">mxn.Marker</a></li>
|
|
|
|
<li><a href="../symbols/mxn.Polyline.html">mxn.Polyline</a></li>
|
|
|
|
<li><a href="../symbols/mxn.Radius.html">mxn.Radius</a></li>
|
|
|
|
<li><a href="../symbols/mxn.util.html">mxn.util</a></li>
|
|
|
|
<li><a href="../symbols/mxn.util.Color.html">mxn.util.Color</a></li>
|
|
|
|
</ul>
|
|
<hr />
|
|
<!-- end publish.classesIndex -->
|
|
</div>
|
|
|
|
<div id="content">
|
|
<!-- ============================== class title ============================ -->
|
|
<h1 class="classTitle">
|
|
|
|
Class mxn.BoundingBox
|
|
</h1>
|
|
|
|
<!-- ============================== class summary ========================== -->
|
|
<p class="description">
|
|
|
|
|
|
|
|
|
|
|
|
<br /><i>Defined in: </i> <a href="../symbols/src/C__Users_nick_Documents_timemap_mxn_build_timemap_mxn.core.js.html">mxn.core.js</a>.
|
|
|
|
</p>
|
|
|
|
<!-- ============================== constructor summary ==================== -->
|
|
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class mxn.BoundingBox.">
|
|
<caption>Class Summary</caption>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Constructor Attributes</th>
|
|
<th scope="col">Constructor Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription" >
|
|
<div class="fixedFont">
|
|
<b><a href="../symbols/mxn.BoundingBox.html">mxn.BoundingBox</a></b>(swlat, swlon, nelat, nelon)
|
|
</div>
|
|
<div class="description">BoundingBox creates a new bounding box object</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<!-- ============================== properties summary ===================== -->
|
|
|
|
|
|
<!-- ============================== methods summary ======================== -->
|
|
|
|
|
|
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class mxn.BoundingBox.">
|
|
<caption>Method Summary</caption>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Method Attributes</th>
|
|
<th scope="col">Method Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/mxn.BoundingBox.html#contains">contains</a></b>(point)
|
|
</div>
|
|
<div class="description">contains finds whether a given point is within a bounding box</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/mxn.BoundingBox.html#extend">extend</a></b>(point)
|
|
</div>
|
|
<div class="description">extend extends the bounding box to include the new point</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/mxn.BoundingBox.html#getCenter">getCenter</a></b>()
|
|
</div>
|
|
<div class="description">getCenter calculates the center of a bounding box.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/mxn.BoundingBox.html#getNorthEast">getNorthEast</a></b>()
|
|
</div>
|
|
<div class="description">getNorthEast returns a LatLonPoint of the north-east point of the bounding box</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/mxn.BoundingBox.html#getSouthWest">getSouthWest</a></b>()
|
|
</div>
|
|
<div class="description">getSouthWest returns a LatLonPoint of the south-west point of the bounding box</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/mxn.BoundingBox.html#isEmpty">isEmpty</a></b>()
|
|
</div>
|
|
<div class="description">isEmpty finds if this bounding box has zero area</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont"><b><a href="../symbols/mxn.BoundingBox.html#toSpan">toSpan</a></b>()
|
|
</div>
|
|
<div class="description">toSpan returns a LatLonPoint with the lat and lon as the height and width of the bounding box</div>
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<!-- ============================== events summary ======================== -->
|
|
|
|
|
|
<!-- ============================== constructor details ==================== -->
|
|
|
|
<div class="details"><a name="constructor"> </a>
|
|
<div class="sectionTitle">
|
|
Class Detail
|
|
</div>
|
|
|
|
<div class="fixedFont">
|
|
<b>mxn.BoundingBox</b>(swlat, swlon, nelat, nelon)
|
|
</div>
|
|
|
|
<div class="description">
|
|
BoundingBox creates a new bounding box object
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{double}</span> <b>swlat</b>
|
|
|
|
</dt>
|
|
<dd>the latitude of the south-west point</dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{double}</span> <b>swlon</b>
|
|
|
|
</dt>
|
|
<dd>the longitude of the south-west point</dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{double}</span> <b>nelat</b>
|
|
|
|
</dt>
|
|
<dd>the latitude of the north-east point</dd>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{double}</span> <b>nelon</b>
|
|
|
|
</dt>
|
|
<dd>the longitude of the north-east point</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<!-- ============================== field details ========================== -->
|
|
|
|
|
|
<!-- ============================== method details ========================= -->
|
|
|
|
<div class="sectionTitle">
|
|
Method Detail
|
|
</div>
|
|
|
|
<a name="contains"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{boolean}</span>
|
|
<b>contains</b>(point)
|
|
|
|
</div>
|
|
<div class="description">
|
|
contains finds whether a given point is within a bounding box
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{LatLonPoint}</span> <b>point</b>
|
|
|
|
</dt>
|
|
<dd>the point to test with</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd>whether point is within this bounding box</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="extend"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>extend</b>(point)
|
|
|
|
</div>
|
|
<div class="description">
|
|
extend extends the bounding box to include the new point
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<b>point</b>
|
|
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="getCenter"> </a>
|
|
<div class="fixedFont">
|
|
|
|
|
|
<b>getCenter</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
getCenter calculates the center of a bounding box.
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd>a LatLonPoint at the center of this bounding box.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="getNorthEast"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{LatLonPoint}</span>
|
|
<b>getNorthEast</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
getNorthEast returns a LatLonPoint of the north-east point of the bounding box
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd>the north-east point of the bounding box</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="getSouthWest"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{LatLonPoint}</span>
|
|
<b>getSouthWest</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
getSouthWest returns a LatLonPoint of the south-west point of the bounding box
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd>the south-west point of the bounding box</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="isEmpty"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{boolean}</span>
|
|
<b>isEmpty</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
isEmpty finds if this bounding box has zero area
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd>whether the north-east and south-west points of the bounding box are the same point</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<a name="toSpan"> </a>
|
|
<div class="fixedFont">
|
|
|
|
<span class="light">{LatLonPoint}</span>
|
|
<b>toSpan</b>()
|
|
|
|
</div>
|
|
<div class="description">
|
|
toSpan returns a LatLonPoint with the lat and lon as the height and width of the bounding box
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList">
|
|
<dt class="heading">Returns:</dt>
|
|
|
|
<dd>a LatLonPoint containing the height and width of this bounding box</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ============================== event details ========================= -->
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
<!-- ============================== footer ================================= -->
|
|
<div class="fineprint" style="clear:both">
|
|
©2009<br />
|
|
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.1.1 on Sat Aug 06 2011 13:39:41 GMT-0700 (PDT)
|
|
</div>
|
|
</body>
|
|
</html>
|