doc/JavaDoc/ch/epfl/sdp/peakar/map/OSMMap.html
<!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_242-release) on Fri Jun 04 18:15:41 CEST 2021 -->
<title>OSMMap</title>
<meta name="date" content="2021-06-04">
<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="OSMMap";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../ch/epfl/sdp/peakar/map/CustomInfoWindow.html" title="class in ch.epfl.sdp.peakar.map"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/map/OSMMap.html" target="_top">Frames</a></li>
<li><a href="OSMMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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">ch.epfl.sdp.peakar.map</div>
<h2 title="Class OSMMap" class="title">Class OSMMap</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ch.epfl.sdp.peakar.map.OSMMap</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">OSMMap</span>
extends java.lang.Object</pre>
<div class="block">Class used to create an OSMMap</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/map/OSMMap.html#OSMMap-android.content.Context-org.osmdroid.views.MapView-">OSMMap</a></span>(android.content.Context context,
org.osmdroid.views.MapView view)</code>
<div class="block">Class constructor</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/map/OSMMap.html#changeMapTileSource-android.widget.ImageButton-android.widget.ImageButton-">changeMapTileSource</a></span>(android.widget.ImageButton zoomOnUserLocationButton,
android.widget.ImageButton changeMapTileSourceButton)</code>
<div class="block">Zoom on user Location</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/map/OSMMap.html#displayUserLocation--">displayUserLocation</a></span>()</code>
<div class="block">Display user location on map</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.osmdroid.views.overlay.Polygon</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/map/OSMMap.html#drawBoundingBox-ch.epfl.sdp.peakar.points.Point-org.osmdroid.views.MapView-org.osmdroid.views.overlay.Polygon-">drawBoundingBox</a></span>(<a href="../../../../../ch/epfl/sdp/peakar/points/Point.html" title="class in ch.epfl.sdp.peakar.points">Point</a> selectedPoint,
org.osmdroid.views.MapView mapView,
org.osmdroid.views.overlay.Polygon boundingBoxPolygon)</code>
<div class="block">Allows to draw a bounding box on the map around the selectedPoint.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/map/OSMMap.html#enablePinOnClick-java.lang.Runnable-java.util.function.Consumer-">enablePinOnClick</a></span>(java.lang.Runnable listener,
java.util.function.Consumer<<a href="../../../../../ch/epfl/sdp/peakar/points/Point.html" title="class in ch.epfl.sdp.peakar.points">Point</a>> pointUpdater)</code>
<div class="block">This method allows to select a point on the map.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.osmdroid.views.MapView</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/map/OSMMap.html#getMapView--">getMapView</a></span>()</code>
<div class="block">MapView getter</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/map/OSMMap.html#setMarkersForDiscoveredPeaks-boolean-">setMarkersForDiscoveredPeaks</a></span>(boolean isSignedIn)</code>
<div class="block">Scan the list of discovered POIs and add a marker on the map for each of them
if the user account is invalid, no peaks are displayed</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/map/OSMMap.html#updateMarkers-boolean-">updateMarkers</a></span>(boolean isSignedIn)</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/map/OSMMap.html#zoomOnUserLocation--">zoomOnUserLocation</a></span>()</code>
<div class="block">Zoom on user Location</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="OSMMap-android.content.Context-org.osmdroid.views.MapView-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OSMMap</h4>
<pre>public OSMMap(android.content.Context context,
org.osmdroid.views.MapView view)</pre>
<div class="block">Class constructor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - context</dd>
<dd><code>view</code> - mapView</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMapView--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMapView</h4>
<pre>public org.osmdroid.views.MapView getMapView()</pre>
<div class="block">MapView getter</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>mapView object</dd>
</dl>
</li>
</ul>
<a name="displayUserLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>displayUserLocation</h4>
<pre>public void displayUserLocation()</pre>
<div class="block">Display user location on map</div>
</li>
</ul>
<a name="zoomOnUserLocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>zoomOnUserLocation</h4>
<pre>public void zoomOnUserLocation()</pre>
<div class="block">Zoom on user Location</div>
</li>
</ul>
<a name="changeMapTileSource-android.widget.ImageButton-android.widget.ImageButton-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeMapTileSource</h4>
<pre>public void changeMapTileSource(android.widget.ImageButton zoomOnUserLocationButton,
android.widget.ImageButton changeMapTileSourceButton)</pre>
<div class="block">Zoom on user Location</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>zoomOnUserLocationButton</code> - button used to zoom on user location</dd>
<dd><code>changeMapTileSourceButton</code> - button used to change the map tiles</dd>
</dl>
</li>
</ul>
<a name="setMarkersForDiscoveredPeaks-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMarkersForDiscoveredPeaks</h4>
<pre>public void setMarkersForDiscoveredPeaks(boolean isSignedIn)</pre>
<div class="block">Scan the list of discovered POIs and add a marker on the map for each of them
if the user account is invalid, no peaks are displayed</div>
</li>
</ul>
<a name="enablePinOnClick-java.lang.Runnable-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enablePinOnClick</h4>
<pre>public void enablePinOnClick(java.lang.Runnable listener,
java.util.function.Consumer<<a href="../../../../../ch/epfl/sdp/peakar/points/Point.html" title="class in ch.epfl.sdp.peakar.points">Point</a>> pointUpdater)</pre>
<div class="block">This method allows to select a point on the map. It allows to pass to the caller
the coordinates of the selected point and it will display a PushPint on the selected
point.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - listener for the long press.</dd>
<dd><code>pointUpdater</code> - used to pass the selected point to the caller.</dd>
</dl>
</li>
</ul>
<a name="drawBoundingBox-ch.epfl.sdp.peakar.points.Point-org.osmdroid.views.MapView-org.osmdroid.views.overlay.Polygon-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drawBoundingBox</h4>
<pre>public org.osmdroid.views.overlay.Polygon drawBoundingBox(<a href="../../../../../ch/epfl/sdp/peakar/points/Point.html" title="class in ch.epfl.sdp.peakar.points">Point</a> selectedPoint,
org.osmdroid.views.MapView mapView,
org.osmdroid.views.overlay.Polygon boundingBoxPolygon)</pre>
<div class="block">Allows to draw a bounding box on the map around the selectedPoint.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>selectedPoint</code> - point around which drawing the bounding box.</dd>
<dd><code>mapView</code> - mapView to draw the boundingBox polygon.</dd>
<dd><code>boundingBoxPolygon</code> - boundingBoxPolygon already in the overlays.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new Polygon that is drawn on the map.</dd>
</dl>
</li>
</ul>
<a name="updateMarkers-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>updateMarkers</h4>
<pre>public void updateMarkers(boolean isSignedIn)</pre>
</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="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../ch/epfl/sdp/peakar/map/CustomInfoWindow.html" title="class in ch.epfl.sdp.peakar.map"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/map/OSMMap.html" target="_top">Frames</a></li>
<li><a href="OSMMap.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>