CameraControlLayer.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  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>CameraControlLayer</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="CameraControlLayer";
  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/layer/CameraControlListener.html" title="interface 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/CameraControlLayer.html" target="_top">Frames</a></li>
  43. <li><a href="CameraControlLayer.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 CameraControlLayer" class="title">Class CameraControlLayer</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>org.ros.android.view.visualization.layer.CameraControlLayer</li>
  93. </ul>
  94. </li>
  95. </ul>
  96. </li>
  97. </ul>
  98. <div class="description">
  99. <ul class="blockList">
  100. <li class="blockList">
  101. <dl>
  102. <dt>All Implemented Interfaces:</dt>
  103. <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/OpenGlDrawable.html" title="interface in org.ros.android.view.visualization">OpenGlDrawable</a></dd>
  104. </dl>
  105. <hr>
  106. <br>
  107. <pre>public class <span class="strong">CameraControlLayer</span>
  108. extends <a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">DefaultLayer</a></pre>
  109. <div class="block">Provides gesture control of the camera for translate, rotate, and zoom.</div>
  110. </li>
  111. </ul>
  112. </div>
  113. <div class="summary">
  114. <ul class="blockList">
  115. <li class="blockList">
  116. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  117. <ul class="blockList">
  118. <li class="blockList"><a name="constructor_summary">
  119. <!-- -->
  120. </a>
  121. <h3>Constructor Summary</h3>
  122. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  123. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  124. <tr>
  125. <th class="colOne" scope="col">Constructor and Description</th>
  126. </tr>
  127. <tr class="altColor">
  128. <td class="colOne"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/CameraControlLayer.html#CameraControlLayer(Context, java.util.concurrent.ExecutorService)">CameraControlLayer</a></strong>(Context&nbsp;context,
  129. java.util.concurrent.ExecutorService&nbsp;executorService)</code>
  130. <div class="block">Creates a new <a href="../../../../../../org/ros/android/view/visualization/layer/CameraControlLayer.html" title="class in org.ros.android.view.visualization.layer"><code>CameraControlLayer</code></a>.</div>
  131. </td>
  132. </tr>
  133. </table>
  134. </li>
  135. </ul>
  136. <!-- ========== METHOD SUMMARY =========== -->
  137. <ul class="blockList">
  138. <li class="blockList"><a name="method_summary">
  139. <!-- -->
  140. </a>
  141. <h3>Method Summary</h3>
  142. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  143. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  144. <tr>
  145. <th class="colFirst" scope="col">Modifier and Type</th>
  146. <th class="colLast" scope="col">Method and Description</th>
  147. </tr>
  148. <tr class="altColor">
  149. <td class="colFirst"><code>void</code></td>
  150. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/CameraControlLayer.html#addListener(org.ros.android.view.visualization.layer.CameraControlListener)">addListener</a></strong>(<a href="../../../../../../org/ros/android/view/visualization/layer/CameraControlListener.html" title="interface in org.ros.android.view.visualization.layer">CameraControlListener</a>&nbsp;listener)</code>&nbsp;</td>
  151. </tr>
  152. <tr class="rowColor">
  153. <td class="colFirst"><code>void</code></td>
  154. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/CameraControlLayer.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,
  155. Handler&nbsp;handler,
  156. org.ros.rosjava_geometry.FrameTransformTree&nbsp;frameTransformTree,
  157. <a href="../../../../../../org/ros/android/view/visualization/Camera.html" title="class in org.ros.android.view.visualization">Camera</a>&nbsp;camera)</code>
  158. <div class="block">Called when the layer is registered at the navigation view.</div>
  159. </td>
  160. </tr>
  161. <tr class="altColor">
  162. <td class="colFirst"><code>boolean</code></td>
  163. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/CameraControlLayer.html#onTouchEvent(org.ros.android.view.visualization.VisualizationView, MotionEvent)">onTouchEvent</a></strong>(<a href="../../../../../../org/ros/android/view/visualization/VisualizationView.html" title="class in org.ros.android.view.visualization">VisualizationView</a>&nbsp;view,
  164. MotionEvent&nbsp;event)</code>
  165. <div class="block">Event handler for touch events.</div>
  166. </td>
  167. </tr>
  168. </table>
  169. <ul class="blockList">
  170. <li class="blockList"><a name="methods_inherited_from_class_org.ros.android.view.visualization.layer.DefaultLayer">
  171. <!-- -->
  172. </a>
  173. <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>
  174. <code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html#draw(GL10)">draw</a>, <a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html#onShutdown(org.ros.android.view.visualization.VisualizationView, org.ros.node.Node)">onShutdown</a></code></li>
  175. </ul>
  176. <ul class="blockList">
  177. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  178. <!-- -->
  179. </a>
  180. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  181. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  182. </ul>
  183. </li>
  184. </ul>
  185. </li>
  186. </ul>
  187. </div>
  188. <div class="details">
  189. <ul class="blockList">
  190. <li class="blockList">
  191. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  192. <ul class="blockList">
  193. <li class="blockList"><a name="constructor_detail">
  194. <!-- -->
  195. </a>
  196. <h3>Constructor Detail</h3>
  197. <a name="CameraControlLayer(Context, java.util.concurrent.ExecutorService)">
  198. <!-- -->
  199. </a>
  200. <ul class="blockListLast">
  201. <li class="blockList">
  202. <h4>CameraControlLayer</h4>
  203. <pre>public&nbsp;CameraControlLayer(Context&nbsp;context,
  204. java.util.concurrent.ExecutorService&nbsp;executorService)</pre>
  205. <div class="block">Creates a new <a href="../../../../../../org/ros/android/view/visualization/layer/CameraControlLayer.html" title="class in org.ros.android.view.visualization.layer"><code>CameraControlLayer</code></a>.
  206. <p>
  207. The camera's frame will be set to <code>frame</code> once when this layer is
  208. started and always when the camera is translated.</div>
  209. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the application's <code>Context</code></dd><dd><code>executorService</code> - </dd></dl>
  210. </li>
  211. </ul>
  212. </li>
  213. </ul>
  214. <!-- ============ METHOD DETAIL ========== -->
  215. <ul class="blockList">
  216. <li class="blockList"><a name="method_detail">
  217. <!-- -->
  218. </a>
  219. <h3>Method Detail</h3>
  220. <a name="addListener(org.ros.android.view.visualization.layer.CameraControlListener)">
  221. <!-- -->
  222. </a>
  223. <ul class="blockList">
  224. <li class="blockList">
  225. <h4>addListener</h4>
  226. <pre>public&nbsp;void&nbsp;addListener(<a href="../../../../../../org/ros/android/view/visualization/layer/CameraControlListener.html" title="interface in org.ros.android.view.visualization.layer">CameraControlListener</a>&nbsp;listener)</pre>
  227. </li>
  228. </ul>
  229. <a name="onTouchEvent(org.ros.android.view.visualization.VisualizationView, MotionEvent)">
  230. <!-- -->
  231. </a>
  232. <ul class="blockList">
  233. <li class="blockList">
  234. <h4>onTouchEvent</h4>
  235. <pre>public&nbsp;boolean&nbsp;onTouchEvent(<a href="../../../../../../org/ros/android/view/visualization/VisualizationView.html" title="class in org.ros.android.view.visualization">VisualizationView</a>&nbsp;view,
  236. MotionEvent&nbsp;event)</pre>
  237. <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html#onTouchEvent(org.ros.android.view.visualization.VisualizationView, MotionEvent)">Layer</a></code></strong></div>
  238. <div class="block">Event handler for touch events.</div>
  239. <dl>
  240. <dt><strong>Specified by:</strong></dt>
  241. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html#onTouchEvent(org.ros.android.view.visualization.VisualizationView, MotionEvent)">onTouchEvent</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>
  242. <dt><strong>Overrides:</strong></dt>
  243. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html#onTouchEvent(org.ros.android.view.visualization.VisualizationView, MotionEvent)">onTouchEvent</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>
  244. <dt><span class="strong">Parameters:</span></dt><dd><code>view</code> - the view generating the event</dd><dd><code>event</code> - the touch event</dd>
  245. <dt><span class="strong">Returns:</span></dt><dd>true if the event has been handled</dd></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="blockListLast">
  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/DefaultLayer.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/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">DefaultLayer</a></code></dd>
  265. </dl>
  266. </li>
  267. </ul>
  268. </li>
  269. </ul>
  270. </li>
  271. </ul>
  272. </div>
  273. </div>
  274. <!-- ========= END OF CLASS DATA ========= -->
  275. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  276. <div class="bottomNav"><a name="navbar_bottom">
  277. <!-- -->
  278. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  279. <!-- -->
  280. </a>
  281. <ul class="navList" title="Navigation">
  282. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  283. <li><a href="package-summary.html">Package</a></li>
  284. <li class="navBarCell1Rev">Class</li>
  285. <li><a href="package-tree.html">Tree</a></li>
  286. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  287. <li><a href="../../../../../../index-all.html">Index</a></li>
  288. <li><a href="../../../../../../help-doc.html">Help</a></li>
  289. </ul>
  290. </div>
  291. <div class="subNav">
  292. <ul class="navList">
  293. <li>Prev Class</li>
  294. <li><a href="../../../../../../org/ros/android/view/visualization/layer/CameraControlListener.html" title="interface in org.ros.android.view.visualization.layer"><span class="strong">Next Class</span></a></li>
  295. </ul>
  296. <ul class="navList">
  297. <li><a href="../../../../../../index.html?org/ros/android/view/visualization/layer/CameraControlLayer.html" target="_top">Frames</a></li>
  298. <li><a href="CameraControlLayer.html" target="_top">No Frames</a></li>
  299. </ul>
  300. <ul class="navList" id="allclasses_navbar_bottom">
  301. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  302. </ul>
  303. <div>
  304. <script type="text/javascript"><!--
  305. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  306. if(window==top) {
  307. allClassesLink.style.display = "block";
  308. }
  309. else {
  310. allClassesLink.style.display = "none";
  311. }
  312. //-->
  313. </script>
  314. </div>
  315. <div>
  316. <ul class="subNavList">
  317. <li>Summary:&nbsp;</li>
  318. <li>Nested&nbsp;|&nbsp;</li>
  319. <li>Field&nbsp;|&nbsp;</li>
  320. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  321. <li><a href="#method_summary">Method</a></li>
  322. </ul>
  323. <ul class="subNavList">
  324. <li>Detail:&nbsp;</li>
  325. <li>Field&nbsp;|&nbsp;</li>
  326. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  327. <li><a href="#method_detail">Method</a></li>
  328. </ul>
  329. </div>
  330. <a name="skip-navbar_bottom">
  331. <!-- -->
  332. </a></div>
  333. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  334. </body>
  335. </html>