PathLayer.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (version 1.7.0_21) on Wed Sep 25 23:19:36 KST 2013 -->
  6. <title>PathLayer</title>
  7. <meta name="date" content="2013-09-25">
  8. <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
  9. </head>
  10. <body>
  11. <script type="text/javascript"><!--
  12. if (location.href.indexOf('is-external=true') == -1) {
  13. parent.document.title="PathLayer";
  14. }
  15. //-->
  16. </script>
  17. <noscript>
  18. <div>JavaScript is disabled on your browser.</div>
  19. </noscript>
  20. <!-- ========= START OF TOP NAVBAR ======= -->
  21. <div class="topNav"><a name="navbar_top">
  22. <!-- -->
  23. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  24. <!-- -->
  25. </a>
  26. <ul class="navList" title="Navigation">
  27. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  28. <li><a href="package-summary.html">Package</a></li>
  29. <li class="navBarCell1Rev">Class</li>
  30. <li><a href="package-tree.html">Tree</a></li>
  31. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  32. <li><a href="../../../../../../index-all.html">Index</a></li>
  33. <li><a href="../../../../../../help-doc.html">Help</a></li>
  34. </ul>
  35. </div>
  36. <div class="subNav">
  37. <ul class="navList">
  38. <li><a href="../../../../../../org/ros/android/view/visualization/layer/OccupancyGridLayer.html" title="class in org.ros.android.view.visualization.layer"><span class="strong">Prev Class</span></a></li>
  39. <li><a href="../../../../../../org/ros/android/view/visualization/layer/PosePublisherLayer.html" title="class in org.ros.android.view.visualization.layer"><span class="strong">Next Class</span></a></li>
  40. </ul>
  41. <ul class="navList">
  42. <li><a href="../../../../../../index.html?org/ros/android/view/visualization/layer/PathLayer.html" target="_top">Frames</a></li>
  43. <li><a href="PathLayer.html" target="_top">No Frames</a></li>
  44. </ul>
  45. <ul class="navList" id="allclasses_navbar_top">
  46. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  47. </ul>
  48. <div>
  49. <script type="text/javascript"><!--
  50. allClassesLink = document.getElementById("allclasses_navbar_top");
  51. if(window==top) {
  52. allClassesLink.style.display = "block";
  53. }
  54. else {
  55. allClassesLink.style.display = "none";
  56. }
  57. //-->
  58. </script>
  59. </div>
  60. <div>
  61. <ul class="subNavList">
  62. <li>Summary:&nbsp;</li>
  63. <li>Nested&nbsp;|&nbsp;</li>
  64. <li>Field&nbsp;|&nbsp;</li>
  65. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  66. <li><a href="#method_summary">Method</a></li>
  67. </ul>
  68. <ul class="subNavList">
  69. <li>Detail:&nbsp;</li>
  70. <li>Field&nbsp;|&nbsp;</li>
  71. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  72. <li><a href="#method_detail">Method</a></li>
  73. </ul>
  74. </div>
  75. <a name="skip-navbar_top">
  76. <!-- -->
  77. </a></div>
  78. <!-- ========= END OF TOP NAVBAR ========= -->
  79. <!-- ======== START OF CLASS DATA ======== -->
  80. <div class="header">
  81. <div class="subTitle">org.ros.android.view.visualization.layer</div>
  82. <h2 title="Class PathLayer" class="title">Class PathLayer</h2>
  83. </div>
  84. <div class="contentContainer">
  85. <ul class="inheritance">
  86. <li>java.lang.Object</li>
  87. <li>
  88. <ul class="inheritance">
  89. <li><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">org.ros.android.view.visualization.layer.DefaultLayer</a></li>
  90. <li>
  91. <ul class="inheritance">
  92. <li><a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html" title="class in org.ros.android.view.visualization.layer">org.ros.android.view.visualization.layer.SubscriberLayer</a>&lt;nav_msgs.Path&gt;</li>
  93. <li>
  94. <ul class="inheritance">
  95. <li>org.ros.android.view.visualization.layer.PathLayer</li>
  96. </ul>
  97. </li>
  98. </ul>
  99. </li>
  100. </ul>
  101. </li>
  102. </ul>
  103. <div class="description">
  104. <ul class="blockList">
  105. <li class="blockList">
  106. <dl>
  107. <dt>All Implemented Interfaces:</dt>
  108. <dd><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html" title="interface in org.ros.android.view.visualization.layer">Layer</a>, <a href="../../../../../../org/ros/android/view/visualization/layer/TfLayer.html" title="interface in org.ros.android.view.visualization.layer">TfLayer</a>, <a href="../../../../../../org/ros/android/view/visualization/OpenGlDrawable.html" title="interface in org.ros.android.view.visualization">OpenGlDrawable</a></dd>
  109. </dl>
  110. <hr>
  111. <br>
  112. <pre>public class <span class="strong">PathLayer</span>
  113. extends <a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html" title="class in org.ros.android.view.visualization.layer">SubscriberLayer</a>&lt;nav_msgs.Path&gt;
  114. implements <a href="../../../../../../org/ros/android/view/visualization/layer/TfLayer.html" title="interface in org.ros.android.view.visualization.layer">TfLayer</a></pre>
  115. <div class="block">Renders a nav_msgs/Path as a dotted line.</div>
  116. </li>
  117. </ul>
  118. </div>
  119. <div class="summary">
  120. <ul class="blockList">
  121. <li class="blockList">
  122. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="constructor_summary">
  125. <!-- -->
  126. </a>
  127. <h3>Constructor Summary</h3>
  128. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  129. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  130. <tr>
  131. <th class="colOne" scope="col">Constructor and Description</th>
  132. </tr>
  133. <tr class="altColor">
  134. <td class="colOne"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/PathLayer.html#PathLayer(org.ros.namespace.GraphName)">PathLayer</a></strong>(org.ros.namespace.GraphName&nbsp;topic)</code>&nbsp;</td>
  135. </tr>
  136. <tr class="rowColor">
  137. <td class="colOne"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/PathLayer.html#PathLayer(java.lang.String)">PathLayer</a></strong>(java.lang.String&nbsp;topic)</code>&nbsp;</td>
  138. </tr>
  139. </table>
  140. </li>
  141. </ul>
  142. <!-- ========== METHOD SUMMARY =========== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="method_summary">
  145. <!-- -->
  146. </a>
  147. <h3>Method Summary</h3>
  148. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  149. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  150. <tr>
  151. <th class="colFirst" scope="col">Modifier and Type</th>
  152. <th class="colLast" scope="col">Method and Description</th>
  153. </tr>
  154. <tr class="altColor">
  155. <td class="colFirst"><code>void</code></td>
  156. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/PathLayer.html#draw(GL10)">draw</a></strong>(GL10&nbsp;gl)</code>&nbsp;</td>
  157. </tr>
  158. <tr class="rowColor">
  159. <td class="colFirst"><code>org.ros.rosjava_geometry.FrameName</code></td>
  160. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/PathLayer.html#getFrame()">getFrame</a></strong>()</code>&nbsp;</td>
  161. </tr>
  162. <tr class="altColor">
  163. <td class="colFirst"><code>void</code></td>
  164. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/PathLayer.html#onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">onStart</a></strong>(org.ros.node.ConnectedNode&nbsp;connectedNode,
  165. Handler&nbsp;handler,
  166. org.ros.rosjava_geometry.FrameTransformTree&nbsp;frameTransformTree,
  167. <a href="../../../../../../org/ros/android/view/visualization/Camera.html" title="class in org.ros.android.view.visualization">Camera</a>&nbsp;camera)</code>
  168. <div class="block">Called when the layer is registered at the navigation view.</div>
  169. </td>
  170. </tr>
  171. </table>
  172. <ul class="blockList">
  173. <li class="blockList"><a name="methods_inherited_from_class_org.ros.android.view.visualization.layer.SubscriberLayer">
  174. <!-- -->
  175. </a>
  176. <h3>Methods inherited from class&nbsp;org.ros.android.view.visualization.layer.<a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html" title="class in org.ros.android.view.visualization.layer">SubscriberLayer</a></h3>
  177. <code><a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html#getSubscriber()">getSubscriber</a>, <a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html#onShutdown(org.ros.android.view.visualization.VisualizationView, org.ros.node.Node)">onShutdown</a></code></li>
  178. </ul>
  179. <ul class="blockList">
  180. <li class="blockList"><a name="methods_inherited_from_class_org.ros.android.view.visualization.layer.DefaultLayer">
  181. <!-- -->
  182. </a>
  183. <h3>Methods inherited from class&nbsp;org.ros.android.view.visualization.layer.<a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">DefaultLayer</a></h3>
  184. <code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html#onTouchEvent(org.ros.android.view.visualization.VisualizationView, MotionEvent)">onTouchEvent</a></code></li>
  185. </ul>
  186. <ul class="blockList">
  187. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  188. <!-- -->
  189. </a>
  190. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  191. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  192. </ul>
  193. </li>
  194. </ul>
  195. </li>
  196. </ul>
  197. </div>
  198. <div class="details">
  199. <ul class="blockList">
  200. <li class="blockList">
  201. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  202. <ul class="blockList">
  203. <li class="blockList"><a name="constructor_detail">
  204. <!-- -->
  205. </a>
  206. <h3>Constructor Detail</h3>
  207. <a name="PathLayer(java.lang.String)">
  208. <!-- -->
  209. </a>
  210. <ul class="blockList">
  211. <li class="blockList">
  212. <h4>PathLayer</h4>
  213. <pre>public&nbsp;PathLayer(java.lang.String&nbsp;topic)</pre>
  214. </li>
  215. </ul>
  216. <a name="PathLayer(org.ros.namespace.GraphName)">
  217. <!-- -->
  218. </a>
  219. <ul class="blockListLast">
  220. <li class="blockList">
  221. <h4>PathLayer</h4>
  222. <pre>public&nbsp;PathLayer(org.ros.namespace.GraphName&nbsp;topic)</pre>
  223. </li>
  224. </ul>
  225. </li>
  226. </ul>
  227. <!-- ============ METHOD DETAIL ========== -->
  228. <ul class="blockList">
  229. <li class="blockList"><a name="method_detail">
  230. <!-- -->
  231. </a>
  232. <h3>Method Detail</h3>
  233. <a name="draw(GL10)">
  234. <!-- -->
  235. </a>
  236. <ul class="blockList">
  237. <li class="blockList">
  238. <h4>draw</h4>
  239. <pre>public&nbsp;void&nbsp;draw(GL10&nbsp;gl)</pre>
  240. <dl>
  241. <dt><strong>Specified by:</strong></dt>
  242. <dd><code><a href="../../../../../../org/ros/android/view/visualization/OpenGlDrawable.html#draw(GL10)">draw</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/OpenGlDrawable.html" title="interface in org.ros.android.view.visualization">OpenGlDrawable</a></code></dd>
  243. <dt><strong>Overrides:</strong></dt>
  244. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html#draw(GL10)">draw</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">DefaultLayer</a></code></dd>
  245. </dl>
  246. </li>
  247. </ul>
  248. <a name="onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">
  249. <!-- -->
  250. </a>
  251. <ul class="blockList">
  252. <li class="blockList">
  253. <h4>onStart</h4>
  254. <pre>public&nbsp;void&nbsp;onStart(org.ros.node.ConnectedNode&nbsp;connectedNode,
  255. Handler&nbsp;handler,
  256. org.ros.rosjava_geometry.FrameTransformTree&nbsp;frameTransformTree,
  257. <a href="../../../../../../org/ros/android/view/visualization/Camera.html" title="class in org.ros.android.view.visualization">Camera</a>&nbsp;camera)</pre>
  258. <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html#onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">Layer</a></code></strong></div>
  259. <div class="block">Called when the layer is registered at the navigation view.</div>
  260. <dl>
  261. <dt><strong>Specified by:</strong></dt>
  262. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html#onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">onStart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html" title="interface in org.ros.android.view.visualization.layer">Layer</a></code></dd>
  263. <dt><strong>Overrides:</strong></dt>
  264. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html#onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">onStart</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html" title="class in org.ros.android.view.visualization.layer">SubscriberLayer</a>&lt;nav_msgs.Path&gt;</code></dd>
  265. </dl>
  266. </li>
  267. </ul>
  268. <a name="getFrame()">
  269. <!-- -->
  270. </a>
  271. <ul class="blockListLast">
  272. <li class="blockList">
  273. <h4>getFrame</h4>
  274. <pre>public&nbsp;org.ros.rosjava_geometry.FrameName&nbsp;getFrame()</pre>
  275. <dl>
  276. <dt><strong>Specified by:</strong></dt>
  277. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/TfLayer.html#getFrame()">getFrame</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/TfLayer.html" title="interface in org.ros.android.view.visualization.layer">TfLayer</a></code></dd>
  278. <dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html" title="interface in org.ros.android.view.visualization.layer"><code>Layer</code></a>'s reference frame</dd></dl>
  279. </li>
  280. </ul>
  281. </li>
  282. </ul>
  283. </li>
  284. </ul>
  285. </div>
  286. </div>
  287. <!-- ========= END OF CLASS DATA ========= -->
  288. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  289. <div class="bottomNav"><a name="navbar_bottom">
  290. <!-- -->
  291. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  292. <!-- -->
  293. </a>
  294. <ul class="navList" title="Navigation">
  295. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  296. <li><a href="package-summary.html">Package</a></li>
  297. <li class="navBarCell1Rev">Class</li>
  298. <li><a href="package-tree.html">Tree</a></li>
  299. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  300. <li><a href="../../../../../../index-all.html">Index</a></li>
  301. <li><a href="../../../../../../help-doc.html">Help</a></li>
  302. </ul>
  303. </div>
  304. <div class="subNav">
  305. <ul class="navList">
  306. <li><a href="../../../../../../org/ros/android/view/visualization/layer/OccupancyGridLayer.html" title="class in org.ros.android.view.visualization.layer"><span class="strong">Prev Class</span></a></li>
  307. <li><a href="../../../../../../org/ros/android/view/visualization/layer/PosePublisherLayer.html" title="class in org.ros.android.view.visualization.layer"><span class="strong">Next Class</span></a></li>
  308. </ul>
  309. <ul class="navList">
  310. <li><a href="../../../../../../index.html?org/ros/android/view/visualization/layer/PathLayer.html" target="_top">Frames</a></li>
  311. <li><a href="PathLayer.html" target="_top">No Frames</a></li>
  312. </ul>
  313. <ul class="navList" id="allclasses_navbar_bottom">
  314. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  315. </ul>
  316. <div>
  317. <script type="text/javascript"><!--
  318. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  319. if(window==top) {
  320. allClassesLink.style.display = "block";
  321. }
  322. else {
  323. allClassesLink.style.display = "none";
  324. }
  325. //-->
  326. </script>
  327. </div>
  328. <div>
  329. <ul class="subNavList">
  330. <li>Summary:&nbsp;</li>
  331. <li>Nested&nbsp;|&nbsp;</li>
  332. <li>Field&nbsp;|&nbsp;</li>
  333. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  334. <li><a href="#method_summary">Method</a></li>
  335. </ul>
  336. <ul class="subNavList">
  337. <li>Detail:&nbsp;</li>
  338. <li>Field&nbsp;|&nbsp;</li>
  339. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  340. <li><a href="#method_detail">Method</a></li>
  341. </ul>
  342. </div>
  343. <a name="skip-navbar_bottom">
  344. <!-- -->
  345. </a></div>
  346. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  347. </body>
  348. </html>