GoalShape.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  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>GoalShape</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="GoalShape";
  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>Prev Class</li>
  39. <li><a href="../../../../../../org/ros/android/view/visualization/shape/PoseShape.html" title="class in org.ros.android.view.visualization.shape"><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/shape/GoalShape.html" target="_top">Frames</a></li>
  43. <li><a href="GoalShape.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.shape</div>
  82. <h2 title="Class GoalShape" class="title">Class GoalShape</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/shape/TriangleFanShape.html" title="class in org.ros.android.view.visualization.shape">org.ros.android.view.visualization.shape.TriangleFanShape</a></li>
  90. <li>
  91. <ul class="inheritance">
  92. <li><a href="../../../../../../org/ros/android/view/visualization/shape/RobotShape.html" title="class in org.ros.android.view.visualization.shape">org.ros.android.view.visualization.shape.RobotShape</a></li>
  93. <li>
  94. <ul class="inheritance">
  95. <li>org.ros.android.view.visualization.shape.GoalShape</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/OpenGlDrawable.html" title="interface in org.ros.android.view.visualization">OpenGlDrawable</a>, <a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html" title="interface in org.ros.android.view.visualization.shape">Shape</a></dd>
  109. </dl>
  110. <dl>
  111. <dt>Direct Known Subclasses:</dt>
  112. <dd><a href="../../../../../../org/ros/android/view/visualization/shape/PoseShape.html" title="class in org.ros.android.view.visualization.shape">PoseShape</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <span class="strong">GoalShape</span>
  117. extends <a href="../../../../../../org/ros/android/view/visualization/shape/RobotShape.html" title="class in org.ros.android.view.visualization.shape">RobotShape</a></pre>
  118. <div class="block">Represents the robot's current goal pose.</div>
  119. </li>
  120. </ul>
  121. </div>
  122. <div class="summary">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  126. <ul class="blockList">
  127. <li class="blockList"><a name="constructor_summary">
  128. <!-- -->
  129. </a>
  130. <h3>Constructor Summary</h3>
  131. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  132. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  133. <tr>
  134. <th class="colOne" scope="col">Constructor and Description</th>
  135. </tr>
  136. <tr class="altColor">
  137. <td class="colOne"><code><strong><a href="../../../../../../org/ros/android/view/visualization/shape/GoalShape.html#GoalShape()">GoalShape</a></strong>()</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><a href="../../../../../../org/ros/android/view/visualization/Color.html" title="class in org.ros.android.view.visualization">Color</a></code></td>
  156. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/shape/GoalShape.html#getColor()">getColor</a></strong>()</code>&nbsp;</td>
  157. </tr>
  158. <tr class="rowColor">
  159. <td class="colFirst"><code>org.ros.rosjava_geometry.Transform</code></td>
  160. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/shape/GoalShape.html#getTransform()">getTransform</a></strong>()</code>&nbsp;</td>
  161. </tr>
  162. <tr class="altColor">
  163. <td class="colFirst"><code>protected void</code></td>
  164. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/shape/GoalShape.html#scale(GL10)">scale</a></strong>(GL10&nbsp;gl)</code>
  165. <div class="block">Scales the coordinate system.</div>
  166. </td>
  167. </tr>
  168. <tr class="rowColor">
  169. <td class="colFirst"><code>void</code></td>
  170. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/shape/GoalShape.html#setColor(org.ros.android.view.visualization.Color)">setColor</a></strong>(<a href="../../../../../../org/ros/android/view/visualization/Color.html" title="class in org.ros.android.view.visualization">Color</a>&nbsp;color)</code>&nbsp;</td>
  171. </tr>
  172. <tr class="altColor">
  173. <td class="colFirst"><code>void</code></td>
  174. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/shape/GoalShape.html#setTransform(org.ros.rosjava_geometry.Transform)">setTransform</a></strong>(org.ros.rosjava_geometry.Transform&nbsp;pose)</code>&nbsp;</td>
  175. </tr>
  176. </table>
  177. <ul class="blockList">
  178. <li class="blockList"><a name="methods_inherited_from_class_org.ros.android.view.visualization.shape.TriangleFanShape">
  179. <!-- -->
  180. </a>
  181. <h3>Methods inherited from class&nbsp;org.ros.android.view.visualization.shape.<a href="../../../../../../org/ros/android/view/visualization/shape/TriangleFanShape.html" title="class in org.ros.android.view.visualization.shape">TriangleFanShape</a></h3>
  182. <code><a href="../../../../../../org/ros/android/view/visualization/shape/TriangleFanShape.html#draw(GL10)">draw</a></code></li>
  183. </ul>
  184. <ul class="blockList">
  185. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  186. <!-- -->
  187. </a>
  188. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  189. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  190. </ul>
  191. </li>
  192. </ul>
  193. </li>
  194. </ul>
  195. </div>
  196. <div class="details">
  197. <ul class="blockList">
  198. <li class="blockList">
  199. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  200. <ul class="blockList">
  201. <li class="blockList"><a name="constructor_detail">
  202. <!-- -->
  203. </a>
  204. <h3>Constructor Detail</h3>
  205. <a name="GoalShape()">
  206. <!-- -->
  207. </a>
  208. <ul class="blockListLast">
  209. <li class="blockList">
  210. <h4>GoalShape</h4>
  211. <pre>public&nbsp;GoalShape()</pre>
  212. </li>
  213. </ul>
  214. </li>
  215. </ul>
  216. <!-- ============ METHOD DETAIL ========== -->
  217. <ul class="blockList">
  218. <li class="blockList"><a name="method_detail">
  219. <!-- -->
  220. </a>
  221. <h3>Method Detail</h3>
  222. <a name="scale(GL10)">
  223. <!-- -->
  224. </a>
  225. <ul class="blockList">
  226. <li class="blockList">
  227. <h4>scale</h4>
  228. <pre>protected&nbsp;void&nbsp;scale(GL10&nbsp;gl)</pre>
  229. <div class="block">Scales the coordinate system.
  230. <p>
  231. This is called after transforming the surface according to
  232. <a href="../../../../../../org/ros/android/view/visualization/shape/GoalShape.html#transform"><code>transform</code></a>.</div>
  233. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>gl</code> - </dd></dl>
  234. </li>
  235. </ul>
  236. <a name="getColor()">
  237. <!-- -->
  238. </a>
  239. <ul class="blockList">
  240. <li class="blockList">
  241. <h4>getColor</h4>
  242. <pre>public&nbsp;<a href="../../../../../../org/ros/android/view/visualization/Color.html" title="class in org.ros.android.view.visualization">Color</a>&nbsp;getColor()</pre>
  243. <dl>
  244. <dt><strong>Specified by:</strong></dt>
  245. <dd><code><a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html#getColor()">getColor</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html" title="interface in org.ros.android.view.visualization.shape">Shape</a></code></dd>
  246. <dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../../../org/ros/android/view/visualization/Color.html" title="class in org.ros.android.view.visualization"><code>Color</code></a> of this <a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html" title="interface in org.ros.android.view.visualization.shape"><code>Shape</code></a></dd></dl>
  247. </li>
  248. </ul>
  249. <a name="setColor(org.ros.android.view.visualization.Color)">
  250. <!-- -->
  251. </a>
  252. <ul class="blockList">
  253. <li class="blockList">
  254. <h4>setColor</h4>
  255. <pre>public&nbsp;void&nbsp;setColor(<a href="../../../../../../org/ros/android/view/visualization/Color.html" title="class in org.ros.android.view.visualization">Color</a>&nbsp;color)</pre>
  256. <dl>
  257. <dt><strong>Specified by:</strong></dt>
  258. <dd><code><a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html#setColor(org.ros.android.view.visualization.Color)">setColor</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html" title="interface in org.ros.android.view.visualization.shape">Shape</a></code></dd>
  259. <dt><span class="strong">Parameters:</span></dt><dd><code>color</code> - the <a href="../../../../../../org/ros/android/view/visualization/Color.html" title="class in org.ros.android.view.visualization"><code>Color</code></a> of this <a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html" title="interface in org.ros.android.view.visualization.shape"><code>Shape</code></a></dd></dl>
  260. </li>
  261. </ul>
  262. <a name="getTransform()">
  263. <!-- -->
  264. </a>
  265. <ul class="blockList">
  266. <li class="blockList">
  267. <h4>getTransform</h4>
  268. <pre>public&nbsp;org.ros.rosjava_geometry.Transform&nbsp;getTransform()</pre>
  269. <dl>
  270. <dt><strong>Specified by:</strong></dt>
  271. <dd><code><a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html#getTransform()">getTransform</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html" title="interface in org.ros.android.view.visualization.shape">Shape</a></code></dd>
  272. <dt><span class="strong">Returns:</span></dt><dd>the <code>Transform</code> that will be applied to this <a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html" title="interface in org.ros.android.view.visualization.shape"><code>Shape</code></a>
  273. before it is drawn</dd></dl>
  274. </li>
  275. </ul>
  276. <a name="setTransform(org.ros.rosjava_geometry.Transform)">
  277. <!-- -->
  278. </a>
  279. <ul class="blockListLast">
  280. <li class="blockList">
  281. <h4>setTransform</h4>
  282. <pre>public&nbsp;void&nbsp;setTransform(org.ros.rosjava_geometry.Transform&nbsp;pose)</pre>
  283. <dl>
  284. <dt><strong>Specified by:</strong></dt>
  285. <dd><code><a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html#setTransform(org.ros.rosjava_geometry.Transform)">setTransform</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html" title="interface in org.ros.android.view.visualization.shape">Shape</a></code></dd>
  286. <dt><span class="strong">Parameters:</span></dt><dd><code>pose</code> - the <code>Transform</code> that will be applied to this <a href="../../../../../../org/ros/android/view/visualization/shape/Shape.html" title="interface in org.ros.android.view.visualization.shape"><code>Shape</code></a>
  287. before it is drawn</dd></dl>
  288. </li>
  289. </ul>
  290. </li>
  291. </ul>
  292. </li>
  293. </ul>
  294. </div>
  295. </div>
  296. <!-- ========= END OF CLASS DATA ========= -->
  297. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  298. <div class="bottomNav"><a name="navbar_bottom">
  299. <!-- -->
  300. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  301. <!-- -->
  302. </a>
  303. <ul class="navList" title="Navigation">
  304. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  305. <li><a href="package-summary.html">Package</a></li>
  306. <li class="navBarCell1Rev">Class</li>
  307. <li><a href="package-tree.html">Tree</a></li>
  308. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  309. <li><a href="../../../../../../index-all.html">Index</a></li>
  310. <li><a href="../../../../../../help-doc.html">Help</a></li>
  311. </ul>
  312. </div>
  313. <div class="subNav">
  314. <ul class="navList">
  315. <li>Prev Class</li>
  316. <li><a href="../../../../../../org/ros/android/view/visualization/shape/PoseShape.html" title="class in org.ros.android.view.visualization.shape"><span class="strong">Next Class</span></a></li>
  317. </ul>
  318. <ul class="navList">
  319. <li><a href="../../../../../../index.html?org/ros/android/view/visualization/shape/GoalShape.html" target="_top">Frames</a></li>
  320. <li><a href="GoalShape.html" target="_top">No Frames</a></li>
  321. </ul>
  322. <ul class="navList" id="allclasses_navbar_bottom">
  323. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  324. </ul>
  325. <div>
  326. <script type="text/javascript"><!--
  327. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  328. if(window==top) {
  329. allClassesLink.style.display = "block";
  330. }
  331. else {
  332. allClassesLink.style.display = "none";
  333. }
  334. //-->
  335. </script>
  336. </div>
  337. <div>
  338. <ul class="subNavList">
  339. <li>Summary:&nbsp;</li>
  340. <li>Nested&nbsp;|&nbsp;</li>
  341. <li>Field&nbsp;|&nbsp;</li>
  342. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  343. <li><a href="#method_summary">Method</a></li>
  344. </ul>
  345. <ul class="subNavList">
  346. <li>Detail:&nbsp;</li>
  347. <li>Field&nbsp;|&nbsp;</li>
  348. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  349. <li><a href="#method_detail">Method</a></li>
  350. </ul>
  351. </div>
  352. <a name="skip-navbar_bottom">
  353. <!-- -->
  354. </a></div>
  355. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  356. </body>
  357. </html>