123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482 |
- <!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 (version 1.7.0_21) on Wed Sep 25 23:19:35 KST 2013 -->
- <title>DistanceView</title>
- <meta name="date" content="2013-09-25">
- <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
- </head>
- <body>
- <script type="text/javascript"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="DistanceView";
- }
- //-->
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar_top">
- <!-- -->
- </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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-all.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li>Prev Class</li>
- <li><a href="../../../../org/ros/android/view/PanTiltView.html" title="class in org.ros.android.view"><span class="strong">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/ros/android/view/DistanceView.html" target="_top">Frames</a></li>
- <li><a href="DistanceView.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">org.ros.android.view</div>
- <h2 title="Class DistanceView" class="title">Class DistanceView</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>GLSurfaceView</li>
- <li>
- <ul class="inheritance">
- <li>org.ros.android.view.DistanceView</li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Implemented Interfaces:</dt>
- <dd>org.ros.message.MessageListener<sensor_msgs.LaserScan>, org.ros.node.NodeListener, org.ros.node.NodeMain</dd>
- </dl>
- <hr>
- <br>
- <pre>public class <span class="strong">DistanceView</span>
- extends GLSurfaceView
- implements org.ros.node.NodeMain, org.ros.message.MessageListener<sensor_msgs.LaserScan></pre>
- <div class="block">An OpenGL view that displayed data from a laser scanner (or similar sensors
- like a kinect). This view can zoom in/out based in one of three modes. The
- user can change the zoom level through a pinch/reverse-pinch, the zoom level
- can auto adjust based on the speed of the robot, and the zoom level can also
- auto adjust based on the distance to the closest object around the robot.</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="overviewSummary" 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><strong><a href="../../../../org/ros/android/view/DistanceView.html#DistanceView(Context)">DistanceView</a></strong>(Context context)</code>
- <div class="block">Initialize the rendering surface.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colOne"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#DistanceView(Context, AttributeSet)">DistanceView</a></strong>(Context context,
- AttributeSet attrs)</code> </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method_summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span>Methods</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#currentSpeed(double)">currentSpeed</a></strong>(double speed)</code>
- <div class="block">Updates the current speed in <a href="../../../../org/ros/android/view/DistanceView.html#distanceRenderer"><code>distanceRenderer</code></a> which then can
- adjust the zoom level in velocity mode.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>org.ros.namespace.GraphName</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#getDefaultNodeName()">getDefaultNodeName</a></strong>()</code> </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#lockZoom()">lockZoom</a></strong>()</code>
- <div class="block">Prevents changes to the zoom level.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#onError(org.ros.node.Node, java.lang.Throwable)">onError</a></strong>(org.ros.node.Node node,
- java.lang.Throwable throwable)</code> </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#onNewMessage(sensor_msgs.LaserScan)">onNewMessage</a></strong>(sensor_msgs.LaserScan message)</code> </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#onShutdown(org.ros.node.Node)">onShutdown</a></strong>(org.ros.node.Node node)</code> </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#onShutdownComplete(org.ros.node.Node)">onShutdownComplete</a></strong>(org.ros.node.Node node)</code> </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#onStart(org.ros.node.ConnectedNode)">onStart</a></strong>(org.ros.node.ConnectedNode connectedNode)</code> </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#onTouch(View, MotionEvent)">onTouch</a></strong>(View v,
- MotionEvent event)</code> </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#setTopicName(java.lang.String)">setTopicName</a></strong>(java.lang.String topicName)</code>
- <div class="block">Sets the topic that the distance view node should subscribe to.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#setZoomMode(org.ros.android.view.ZoomMode)">setZoomMode</a></strong>(<a href="../../../../org/ros/android/view/ZoomMode.html" title="enum in org.ros.android.view">ZoomMode</a> mode)</code>
- <div class="block">Sets the zoom mode to one of the modes in <a href="../../../../org/ros/android/view/ZoomMode.html" title="enum in org.ros.android.view"><code>ZoomMode</code></a>.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><strong><a href="../../../../org/ros/android/view/DistanceView.html#unlockZoom()">unlockZoom</a></strong>()</code>
- <div class="block">Unlocks the zoom allowing it to be changed.</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>
- <ul class="blockList">
- <li class="blockList"><a name="methods_inherited_from_class_org.ros.message.MessageListener">
- <!-- -->
- </a>
- <h3>Methods inherited from interface org.ros.message.MessageListener</h3>
- <code>onNewMessage</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="DistanceView(Context)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>DistanceView</h4>
- <pre>public DistanceView(Context context)</pre>
- <div class="block">Initialize the rendering surface.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - </dd></dl>
- </li>
- </ul>
- <a name="DistanceView(Context, AttributeSet)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>DistanceView</h4>
- <pre>public DistanceView(Context context,
- AttributeSet attrs)</pre>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method_detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="setTopicName(java.lang.String)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setTopicName</h4>
- <pre>public void setTopicName(java.lang.String topicName)</pre>
- <div class="block">Sets the topic that the distance view node should subscribe to.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>topicName</code> - Name of the ROS topic.</dd></dl>
- </li>
- </ul>
- <a name="getDefaultNodeName()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getDefaultNodeName</h4>
- <pre>public org.ros.namespace.GraphName getDefaultNodeName()</pre>
- <dl>
- <dt><strong>Specified by:</strong></dt>
- <dd><code>getDefaultNodeName</code> in interface <code>org.ros.node.NodeMain</code></dd>
- </dl>
- </li>
- </ul>
- <a name="onStart(org.ros.node.ConnectedNode)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>onStart</h4>
- <pre>public void onStart(org.ros.node.ConnectedNode connectedNode)</pre>
- <dl>
- <dt><strong>Specified by:</strong></dt>
- <dd><code>onStart</code> in interface <code>org.ros.node.NodeListener</code></dd>
- </dl>
- </li>
- </ul>
- <a name="onShutdown(org.ros.node.Node)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>onShutdown</h4>
- <pre>public void onShutdown(org.ros.node.Node node)</pre>
- <dl>
- <dt><strong>Specified by:</strong></dt>
- <dd><code>onShutdown</code> in interface <code>org.ros.node.NodeListener</code></dd>
- </dl>
- </li>
- </ul>
- <a name="onShutdownComplete(org.ros.node.Node)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>onShutdownComplete</h4>
- <pre>public void onShutdownComplete(org.ros.node.Node node)</pre>
- <dl>
- <dt><strong>Specified by:</strong></dt>
- <dd><code>onShutdownComplete</code> in interface <code>org.ros.node.NodeListener</code></dd>
- </dl>
- </li>
- </ul>
- <a name="onError(org.ros.node.Node, java.lang.Throwable)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>onError</h4>
- <pre>public void onError(org.ros.node.Node node,
- java.lang.Throwable throwable)</pre>
- <dl>
- <dt><strong>Specified by:</strong></dt>
- <dd><code>onError</code> in interface <code>org.ros.node.NodeListener</code></dd>
- </dl>
- </li>
- </ul>
- <a name="onNewMessage(sensor_msgs.LaserScan)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>onNewMessage</h4>
- <pre>public void onNewMessage(sensor_msgs.LaserScan message)</pre>
- </li>
- </ul>
- <a name="setZoomMode(org.ros.android.view.ZoomMode)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setZoomMode</h4>
- <pre>public void setZoomMode(<a href="../../../../org/ros/android/view/ZoomMode.html" title="enum in org.ros.android.view">ZoomMode</a> mode)</pre>
- <div class="block">Sets the zoom mode to one of the modes in <a href="../../../../org/ros/android/view/ZoomMode.html" title="enum in org.ros.android.view"><code>ZoomMode</code></a>.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - The zoom mode that must be set.</dd></dl>
- </li>
- </ul>
- <a name="lockZoom()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>lockZoom</h4>
- <pre>public void lockZoom()</pre>
- <div class="block">Prevents changes to the zoom level.</div>
- </li>
- </ul>
- <a name="unlockZoom()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>unlockZoom</h4>
- <pre>public void unlockZoom()</pre>
- <div class="block">Unlocks the zoom allowing it to be changed.</div>
- </li>
- </ul>
- <a name="currentSpeed(double)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>currentSpeed</h4>
- <pre>public void currentSpeed(double speed)</pre>
- <div class="block">Updates the current speed in <a href="../../../../org/ros/android/view/DistanceView.html#distanceRenderer"><code>distanceRenderer</code></a> which then can
- adjust the zoom level in velocity mode.</div>
- <dl><dt><span class="strong">Parameters:</span></dt><dd><code>speed</code> - The linear velocity of the robot.</dd></dl>
- </li>
- </ul>
- <a name="onTouch(View, MotionEvent)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>onTouch</h4>
- <pre>public boolean onTouch(View v,
- MotionEvent event)</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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-all.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li>Prev Class</li>
- <li><a href="../../../../org/ros/android/view/PanTiltView.html" title="class in org.ros.android.view"><span class="strong">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/ros/android/view/DistanceView.html" target="_top">Frames</a></li>
- <li><a href="DistanceView.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>
|