Camera.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  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>Camera</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="Camera";
  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/Color.html" title="class in org.ros.android.view.visualization"><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/Camera.html" target="_top">Frames</a></li>
  43. <li><a href="Camera.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</div>
  82. <h2 title="Class Camera" class="title">Class Camera</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>org.ros.android.view.visualization.Camera</li>
  90. </ul>
  91. </li>
  92. </ul>
  93. <div class="description">
  94. <ul class="blockList">
  95. <li class="blockList">
  96. <hr>
  97. <br>
  98. <pre>public class <span class="strong">Camera</span>
  99. extends java.lang.Object</pre>
  100. </li>
  101. </ul>
  102. </div>
  103. <div class="summary">
  104. <ul class="blockList">
  105. <li class="blockList">
  106. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  107. <ul class="blockList">
  108. <li class="blockList"><a name="constructor_summary">
  109. <!-- -->
  110. </a>
  111. <h3>Constructor Summary</h3>
  112. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  113. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  114. <tr>
  115. <th class="colOne" scope="col">Constructor and Description</th>
  116. </tr>
  117. <tr class="altColor">
  118. <td class="colOne"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#Camera(org.ros.rosjava_geometry.FrameTransformTree)">Camera</a></strong>(org.ros.rosjava_geometry.FrameTransformTree&nbsp;frameTransformTree)</code>&nbsp;</td>
  119. </tr>
  120. </table>
  121. </li>
  122. </ul>
  123. <!-- ========== METHOD SUMMARY =========== -->
  124. <ul class="blockList">
  125. <li class="blockList"><a name="method_summary">
  126. <!-- -->
  127. </a>
  128. <h3>Method Summary</h3>
  129. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  130. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  131. <tr>
  132. <th class="colFirst" scope="col">Modifier and Type</th>
  133. <th class="colLast" scope="col">Method and Description</th>
  134. </tr>
  135. <tr class="altColor">
  136. <td class="colFirst"><code>void</code></td>
  137. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#apply(GL10)">apply</a></strong>(GL10&nbsp;gl)</code>&nbsp;</td>
  138. </tr>
  139. <tr class="rowColor">
  140. <td class="colFirst"><code>boolean</code></td>
  141. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#applyFrameTransform(GL10, org.ros.rosjava_geometry.FrameName)">applyFrameTransform</a></strong>(GL10&nbsp;gl,
  142. org.ros.rosjava_geometry.FrameName&nbsp;frame)</code>&nbsp;</td>
  143. </tr>
  144. <tr class="altColor">
  145. <td class="colFirst"><code>org.ros.rosjava_geometry.FrameName</code></td>
  146. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#getFrame()">getFrame</a></strong>()</code>&nbsp;</td>
  147. </tr>
  148. <tr class="rowColor">
  149. <td class="colFirst"><code>double</code></td>
  150. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#getZoom()">getZoom</a></strong>()</code>&nbsp;</td>
  151. </tr>
  152. <tr class="altColor">
  153. <td class="colFirst"><code>void</code></td>
  154. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#jumpToFrame(org.ros.rosjava_geometry.FrameName)">jumpToFrame</a></strong>(org.ros.rosjava_geometry.FrameName&nbsp;frame)</code>
  155. <div class="block">Changes the camera frame to the specified frame and aligns the camera with
  156. the new frame.</div>
  157. </td>
  158. </tr>
  159. <tr class="rowColor">
  160. <td class="colFirst"><code>void</code></td>
  161. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#jumpToFrame(java.lang.String)">jumpToFrame</a></strong>(java.lang.String&nbsp;frame)</code>&nbsp;</td>
  162. </tr>
  163. <tr class="altColor">
  164. <td class="colFirst"><code>void</code></td>
  165. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#rotate(double, double, double)">rotate</a></strong>(double&nbsp;focusX,
  166. double&nbsp;focusY,
  167. double&nbsp;deltaAngle)</code>
  168. <div class="block">Rotates the camera round the specified coordinates.</div>
  169. </td>
  170. </tr>
  171. <tr class="rowColor">
  172. <td class="colFirst"><code>void</code></td>
  173. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#setFrame(org.ros.rosjava_geometry.FrameName)">setFrame</a></strong>(org.ros.rosjava_geometry.FrameName&nbsp;frame)</code>
  174. <div class="block">Changes the camera frame to the specified frame.</div>
  175. </td>
  176. </tr>
  177. <tr class="altColor">
  178. <td class="colFirst"><code>void</code></td>
  179. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#setFrame(java.lang.String)">setFrame</a></strong>(java.lang.String&nbsp;frame)</code>&nbsp;</td>
  180. </tr>
  181. <tr class="rowColor">
  182. <td class="colFirst"><code>void</code></td>
  183. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#setViewport(org.ros.android.view.visualization.Viewport)">setViewport</a></strong>(<a href="../../../../../org/ros/android/view/visualization/Viewport.html" title="class in org.ros.android.view.visualization">Viewport</a>&nbsp;viewport)</code>&nbsp;</td>
  184. </tr>
  185. <tr class="altColor">
  186. <td class="colFirst"><code>org.ros.rosjava_geometry.Vector3</code></td>
  187. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#toMetricCoordinates(int, int)">toMetricCoordinates</a></strong>(int&nbsp;x,
  188. int&nbsp;y)</code>&nbsp;</td>
  189. </tr>
  190. <tr class="rowColor">
  191. <td class="colFirst"><code>void</code></td>
  192. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#translate(double, double)">translate</a></strong>(double&nbsp;deltaX,
  193. double&nbsp;deltaY)</code>
  194. <div class="block">Translates the camera.</div>
  195. </td>
  196. </tr>
  197. <tr class="altColor">
  198. <td class="colFirst"><code>void</code></td>
  199. <td class="colLast"><code><strong><a href="../../../../../org/ros/android/view/visualization/Camera.html#zoom(double, double, double)">zoom</a></strong>(double&nbsp;focusX,
  200. double&nbsp;focusY,
  201. double&nbsp;factor)</code>
  202. <div class="block">Zooms the camera around the specified focus coordinates.</div>
  203. </td>
  204. </tr>
  205. </table>
  206. <ul class="blockList">
  207. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  208. <!-- -->
  209. </a>
  210. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  211. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  212. </ul>
  213. </li>
  214. </ul>
  215. </li>
  216. </ul>
  217. </div>
  218. <div class="details">
  219. <ul class="blockList">
  220. <li class="blockList">
  221. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  222. <ul class="blockList">
  223. <li class="blockList"><a name="constructor_detail">
  224. <!-- -->
  225. </a>
  226. <h3>Constructor Detail</h3>
  227. <a name="Camera(org.ros.rosjava_geometry.FrameTransformTree)">
  228. <!-- -->
  229. </a>
  230. <ul class="blockListLast">
  231. <li class="blockList">
  232. <h4>Camera</h4>
  233. <pre>public&nbsp;Camera(org.ros.rosjava_geometry.FrameTransformTree&nbsp;frameTransformTree)</pre>
  234. </li>
  235. </ul>
  236. </li>
  237. </ul>
  238. <!-- ============ METHOD DETAIL ========== -->
  239. <ul class="blockList">
  240. <li class="blockList"><a name="method_detail">
  241. <!-- -->
  242. </a>
  243. <h3>Method Detail</h3>
  244. <a name="apply(GL10)">
  245. <!-- -->
  246. </a>
  247. <ul class="blockList">
  248. <li class="blockList">
  249. <h4>apply</h4>
  250. <pre>public&nbsp;void&nbsp;apply(GL10&nbsp;gl)</pre>
  251. </li>
  252. </ul>
  253. <a name="applyFrameTransform(GL10, org.ros.rosjava_geometry.FrameName)">
  254. <!-- -->
  255. </a>
  256. <ul class="blockList">
  257. <li class="blockList">
  258. <h4>applyFrameTransform</h4>
  259. <pre>public&nbsp;boolean&nbsp;applyFrameTransform(GL10&nbsp;gl,
  260. org.ros.rosjava_geometry.FrameName&nbsp;frame)</pre>
  261. </li>
  262. </ul>
  263. <a name="translate(double, double)">
  264. <!-- -->
  265. </a>
  266. <ul class="blockList">
  267. <li class="blockList">
  268. <h4>translate</h4>
  269. <pre>public&nbsp;void&nbsp;translate(double&nbsp;deltaX,
  270. double&nbsp;deltaY)</pre>
  271. <div class="block">Translates the camera.</div>
  272. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>deltaX</code> - distance to move in x in pixels</dd><dd><code>deltaY</code> - distance to move in y in pixels</dd></dl>
  273. </li>
  274. </ul>
  275. <a name="rotate(double, double, double)">
  276. <!-- -->
  277. </a>
  278. <ul class="blockList">
  279. <li class="blockList">
  280. <h4>rotate</h4>
  281. <pre>public&nbsp;void&nbsp;rotate(double&nbsp;focusX,
  282. double&nbsp;focusY,
  283. double&nbsp;deltaAngle)</pre>
  284. <div class="block">Rotates the camera round the specified coordinates.</div>
  285. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>focusX</code> - the x coordinate to focus on</dd><dd><code>focusY</code> - the y coordinate to focus on</dd><dd><code>deltaAngle</code> - the camera will be rotated by <code>deltaAngle</code> radians</dd></dl>
  286. </li>
  287. </ul>
  288. <a name="zoom(double, double, double)">
  289. <!-- -->
  290. </a>
  291. <ul class="blockList">
  292. <li class="blockList">
  293. <h4>zoom</h4>
  294. <pre>public&nbsp;void&nbsp;zoom(double&nbsp;focusX,
  295. double&nbsp;focusY,
  296. double&nbsp;factor)</pre>
  297. <div class="block">Zooms the camera around the specified focus coordinates.</div>
  298. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>focusX</code> - the x coordinate to focus on</dd><dd><code>focusY</code> - the y coordinate to focus on</dd><dd><code>factor</code> - the zoom will be scaled by this factor</dd></dl>
  299. </li>
  300. </ul>
  301. <a name="getZoom()">
  302. <!-- -->
  303. </a>
  304. <ul class="blockList">
  305. <li class="blockList">
  306. <h4>getZoom</h4>
  307. <pre>public&nbsp;double&nbsp;getZoom()</pre>
  308. <dl><dt><span class="strong">Returns:</span></dt><dd>the current zoom factor</dd></dl>
  309. </li>
  310. </ul>
  311. <a name="toMetricCoordinates(int, int)">
  312. <!-- -->
  313. </a>
  314. <ul class="blockList">
  315. <li class="blockList">
  316. <h4>toMetricCoordinates</h4>
  317. <pre>public&nbsp;org.ros.rosjava_geometry.Vector3&nbsp;toMetricCoordinates(int&nbsp;x,
  318. int&nbsp;y)</pre>
  319. <dl><dt><span class="strong">Returns:</span></dt><dd>the metric coordinates of the provided pixel coordinates where the
  320. origin is the top left corner of the view</dd></dl>
  321. </li>
  322. </ul>
  323. <a name="getFrame()">
  324. <!-- -->
  325. </a>
  326. <ul class="blockList">
  327. <li class="blockList">
  328. <h4>getFrame</h4>
  329. <pre>public&nbsp;org.ros.rosjava_geometry.FrameName&nbsp;getFrame()</pre>
  330. </li>
  331. </ul>
  332. <a name="setFrame(org.ros.rosjava_geometry.FrameName)">
  333. <!-- -->
  334. </a>
  335. <ul class="blockList">
  336. <li class="blockList">
  337. <h4>setFrame</h4>
  338. <pre>public&nbsp;void&nbsp;setFrame(org.ros.rosjava_geometry.FrameName&nbsp;frame)</pre>
  339. <div class="block">Changes the camera frame to the specified frame.
  340. <p>
  341. If possible, the camera will avoid jumping on the next frame.</div>
  342. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>frame</code> - the new camera frame</dd></dl>
  343. </li>
  344. </ul>
  345. <a name="setFrame(java.lang.String)">
  346. <!-- -->
  347. </a>
  348. <ul class="blockList">
  349. <li class="blockList">
  350. <h4>setFrame</h4>
  351. <pre>public&nbsp;void&nbsp;setFrame(java.lang.String&nbsp;frame)</pre>
  352. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/ros/android/view/visualization/Camera.html#setFrame(org.ros.rosjava_geometry.FrameName)"><code>setFrame(FrameName)</code></a></dd></dl>
  353. </li>
  354. </ul>
  355. <a name="jumpToFrame(org.ros.rosjava_geometry.FrameName)">
  356. <!-- -->
  357. </a>
  358. <ul class="blockList">
  359. <li class="blockList">
  360. <h4>jumpToFrame</h4>
  361. <pre>public&nbsp;void&nbsp;jumpToFrame(org.ros.rosjava_geometry.FrameName&nbsp;frame)</pre>
  362. <div class="block">Changes the camera frame to the specified frame and aligns the camera with
  363. the new frame.</div>
  364. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>frame</code> - the new camera frame</dd></dl>
  365. </li>
  366. </ul>
  367. <a name="jumpToFrame(java.lang.String)">
  368. <!-- -->
  369. </a>
  370. <ul class="blockList">
  371. <li class="blockList">
  372. <h4>jumpToFrame</h4>
  373. <pre>public&nbsp;void&nbsp;jumpToFrame(java.lang.String&nbsp;frame)</pre>
  374. <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/ros/android/view/visualization/Camera.html#jumpToFrame(org.ros.rosjava_geometry.FrameName)"><code>jumpToFrame(FrameName)</code></a></dd></dl>
  375. </li>
  376. </ul>
  377. <a name="setViewport(org.ros.android.view.visualization.Viewport)">
  378. <!-- -->
  379. </a>
  380. <ul class="blockListLast">
  381. <li class="blockList">
  382. <h4>setViewport</h4>
  383. <pre>public&nbsp;void&nbsp;setViewport(<a href="../../../../../org/ros/android/view/visualization/Viewport.html" title="class in org.ros.android.view.visualization">Viewport</a>&nbsp;viewport)</pre>
  384. </li>
  385. </ul>
  386. </li>
  387. </ul>
  388. </li>
  389. </ul>
  390. </div>
  391. </div>
  392. <!-- ========= END OF CLASS DATA ========= -->
  393. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  394. <div class="bottomNav"><a name="navbar_bottom">
  395. <!-- -->
  396. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  397. <!-- -->
  398. </a>
  399. <ul class="navList" title="Navigation">
  400. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  401. <li><a href="package-summary.html">Package</a></li>
  402. <li class="navBarCell1Rev">Class</li>
  403. <li><a href="package-tree.html">Tree</a></li>
  404. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  405. <li><a href="../../../../../index-all.html">Index</a></li>
  406. <li><a href="../../../../../help-doc.html">Help</a></li>
  407. </ul>
  408. </div>
  409. <div class="subNav">
  410. <ul class="navList">
  411. <li>Prev Class</li>
  412. <li><a href="../../../../../org/ros/android/view/visualization/Color.html" title="class in org.ros.android.view.visualization"><span class="strong">Next Class</span></a></li>
  413. </ul>
  414. <ul class="navList">
  415. <li><a href="../../../../../index.html?org/ros/android/view/visualization/Camera.html" target="_top">Frames</a></li>
  416. <li><a href="Camera.html" target="_top">No Frames</a></li>
  417. </ul>
  418. <ul class="navList" id="allclasses_navbar_bottom">
  419. <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  420. </ul>
  421. <div>
  422. <script type="text/javascript"><!--
  423. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  424. if(window==top) {
  425. allClassesLink.style.display = "block";
  426. }
  427. else {
  428. allClassesLink.style.display = "none";
  429. }
  430. //-->
  431. </script>
  432. </div>
  433. <div>
  434. <ul class="subNavList">
  435. <li>Summary:&nbsp;</li>
  436. <li>Nested&nbsp;|&nbsp;</li>
  437. <li>Field&nbsp;|&nbsp;</li>
  438. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  439. <li><a href="#method_summary">Method</a></li>
  440. </ul>
  441. <ul class="subNavList">
  442. <li>Detail:&nbsp;</li>
  443. <li>Field&nbsp;|&nbsp;</li>
  444. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  445. <li><a href="#method_detail">Method</a></li>
  446. </ul>
  447. </div>
  448. <a name="skip-navbar_bottom">
  449. <!-- -->
  450. </a></div>
  451. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  452. </body>
  453. </html>