sample_code.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <title>jMonkeyEngine SDK: Sample Code :: jMonkeyEngine Docs</title>
  7. <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs/sdk/sample_code.html">
  8. <meta name="keywords" content="documentation, sdk, asset, project">
  9. <meta name="generator" content="Antora 2.3.3">
  10. <link rel="stylesheet" href="../../_/css/site.css">
  11. <meta property="og:image" content="https://wiki.jmonkeyengine.org/_/img/iconx128.png">
  12. <meta property="og:description" content="jMonkeyEngine SDK: Sample Code">
  13. <meta property="og:title" content="jMonkeyEngine Docs">
  14. <link rel="stylesheet" href="../../_/css/site-extra.css">
  15. <link rel="stylesheet" href="../../_/css/vendor/docsearch.min.css">
  16. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css -->
  17. <link rel="icon" href="../../_/img/favicon.ico" type="image/x-icon">
  18. </head>
  19. <body class="article">
  20. <header class="header">
  21. <nav class="navbar">
  22. <div class="navbar-brand">
  23. <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
  24. <img alt="" src="../../_/img/jme-logo.png" height="32" type="image/x-icon">
  25. </a>
  26. <div class="navbar-item hide-for-print">
  27. <input id="search-input" type="text" placeholder="Search docs">
  28. </div>
  29. <button class="navbar-burger" data-target="topbar-nav">
  30. <span></span>
  31. <span></span>
  32. <span></span>
  33. </button>
  34. </div>
  35. <div id="topbar-nav" class="navbar-menu">
  36. <div class="navbar-end">
  37. <div class="navbar-item theme-switch-wrapper">
  38. <label class="theme-switch" for="checkbox">
  39. <input type="checkbox" id="checkbox" />
  40. <div class="slider round"></div>
  41. </label>
  42. </div>
  43. <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
  44. </div>
  45. </div>
  46. </nav>
  47. </header>
  48. <div class="body">
  49. <div class="nav-container" data-component="docs" data-version="master">
  50. <aside class="nav">
  51. <div class="panels">
  52. <div class="nav-panel-menu is-active" data-panel="menu">
  53. <nav class="nav-menu">
  54. <h3 class="title"><a href="../documentation.html">Docs</a></h3>
  55. <ul class="nav-list">
  56. <li class="nav-item" data-depth="0">
  57. <ul class="nav-list">
  58. <li class="nav-item" data-depth="1">
  59. <a class="nav-link" href="../documentation.html">Getting Started</a>
  60. </li>
  61. <li class="nav-item" data-depth="1">
  62. <a class="nav-link" href="https://javadoc.jmonkeyengine.org/v3.3.2-stable">JavaDoc</a>
  63. </li>
  64. <li class="nav-item" data-depth="1">
  65. <button class="nav-item-toggle"></button>
  66. <a class="nav-link" href="../jme3.html">jMonkeyEngine 3</a>
  67. <ul class="nav-list">
  68. <li class="nav-item" data-depth="2">
  69. <button class="nav-item-toggle"></button>
  70. <span class="nav-text">Beginner Tutorials</span>
  71. <ul class="nav-list">
  72. <li class="nav-item" data-depth="3">
  73. <a class="nav-link" href="../jme3/beginner/hello_simpleapplication.html">Hello SimpleApplication</a>
  74. </li>
  75. <li class="nav-item" data-depth="3">
  76. <a class="nav-link" href="../jme3/beginner/hello_node.html">Hello Node</a>
  77. </li>
  78. <li class="nav-item" data-depth="3">
  79. <a class="nav-link" href="../jme3/beginner/hello_asset.html">Hello Asset</a>
  80. </li>
  81. <li class="nav-item" data-depth="3">
  82. <a class="nav-link" href="../jme3/beginner/hello_main_event_loop.html">Hello Main Event Loop</a>
  83. </li>
  84. <li class="nav-item" data-depth="3">
  85. <a class="nav-link" href="../jme3/beginner/hello_input_system.html">Hello Input System</a>
  86. </li>
  87. <li class="nav-item" data-depth="3">
  88. <a class="nav-link" href="../jme3/beginner/hello_material.html">Hello Material</a>
  89. </li>
  90. <li class="nav-item" data-depth="3">
  91. <a class="nav-link" href="../jme3/beginner/hello_animation.html">Hello Animation</a>
  92. </li>
  93. <li class="nav-item" data-depth="3">
  94. <a class="nav-link" href="../jme3/beginner/hello_picking.html">Hello Picking</a>
  95. </li>
  96. <li class="nav-item" data-depth="3">
  97. <a class="nav-link" href="../jme3/beginner/hello_collision.html">Hello Collision</a>
  98. </li>
  99. <li class="nav-item" data-depth="3">
  100. <a class="nav-link" href="../jme3/beginner/hello_terrain.html">Hello Terrain</a>
  101. </li>
  102. <li class="nav-item" data-depth="3">
  103. <a class="nav-link" href="../jme3/beginner/hello_audio.html">Hello Audio</a>
  104. </li>
  105. <li class="nav-item" data-depth="3">
  106. <a class="nav-link" href="../jme3/beginner/hello_effects.html">Hello Effects</a>
  107. </li>
  108. <li class="nav-item" data-depth="3">
  109. <a class="nav-link" href="../jme3/beginner/hello_physics.html">Hello Physics</a>
  110. </li>
  111. </ul>
  112. </li>
  113. <li class="nav-item" data-depth="2">
  114. <button class="nav-item-toggle"></button>
  115. <span class="nav-text">Intermediate Tutorials</span>
  116. <ul class="nav-list">
  117. <li class="nav-item" data-depth="3">
  118. <button class="nav-item-toggle"></button>
  119. <span class="nav-text">Concepts</span>
  120. <ul class="nav-list">
  121. <li class="nav-item" data-depth="4">
  122. <a class="nav-link" href="../jme3/intermediate/best_practices.html">Best Practices</a>
  123. </li>
  124. <li class="nav-item" data-depth="4">
  125. <a class="nav-link" href="../jme3/intermediate/simpleapplication.html">Simple Application</a>
  126. </li>
  127. <li class="nav-item" data-depth="4">
  128. <a class="nav-link" href="../jme3/features.html">Features</a>
  129. </li>
  130. <li class="nav-item" data-depth="4">
  131. <a class="nav-link" href="../jme3/intermediate/optimization.html">Optimization</a>
  132. </li>
  133. <li class="nav-item" data-depth="4">
  134. <a class="nav-link" href="../jme3/faq.html">FAQ</a>
  135. </li>
  136. </ul>
  137. </li>
  138. <li class="nav-item" data-depth="3">
  139. <button class="nav-item-toggle"></button>
  140. <span class="nav-text">Math Concepts</span>
  141. <ul class="nav-list">
  142. <li class="nav-item" data-depth="4">
  143. <a class="nav-link" href="../jme3/math_for_dummies.html">Math For Dummies</a>
  144. </li>
  145. <li class="nav-item" data-depth="4">
  146. <a class="nav-link" href="../jme3/intermediate/math.html">Math</a>
  147. </li>
  148. <li class="nav-item" data-depth="4">
  149. <a class="nav-link" href="../jme3/math.html">More Math</a>
  150. </li>
  151. <li class="nav-item" data-depth="4">
  152. <a class="nav-link" href="../jme3/rotate.html">Rotate</a>
  153. </li>
  154. <li class="nav-item" data-depth="4">
  155. <a class="nav-link" href="../jme3/math_video_tutorials.html">Math Video Tutorials</a>
  156. </li>
  157. </ul>
  158. </li>
  159. <li class="nav-item" data-depth="3">
  160. <button class="nav-item-toggle"></button>
  161. <span class="nav-text">3D Graphics Concepts</span>
  162. <ul class="nav-list">
  163. <li class="nav-item" data-depth="4">
  164. <a class="nav-link" href="../jme3/intermediate/multi-media_asset_pipeline.html">Multi-Media Asset Pipeline</a>
  165. </li>
  166. <li class="nav-item" data-depth="4">
  167. <a class="nav-link" href="../jme3/scenegraph_for_dummies.html">Scenegraph for Dummies</a>
  168. </li>
  169. <li class="nav-item" data-depth="4">
  170. <a class="nav-link" href="../jme3/beginner/hellovector.html">Hello Vector</a>
  171. </li>
  172. <li class="nav-item" data-depth="4">
  173. <a class="nav-link" href="../jme3/terminology.html">Terminology</a>
  174. </li>
  175. <li class="nav-item" data-depth="4">
  176. <a class="nav-link" href="../jme3/intermediate/how_to_use_materials.html">How to Use Materials</a>
  177. </li>
  178. <li class="nav-item" data-depth="4">
  179. <a class="nav-link" href="../jme3/intermediate/transparency_sorting.html">Transparency and Sorting</a>
  180. </li>
  181. <li class="nav-item" data-depth="4">
  182. <a class="nav-link" href="../jme3/external/blender.html">Importing from Blender</a>
  183. </li>
  184. <li class="nav-item" data-depth="4">
  185. <a class="nav-link" href="../jme3/external/3dsmax.html">Importing from 3DS Max</a>
  186. </li>
  187. </ul>
  188. </li>
  189. </ul>
  190. </li>
  191. </ul>
  192. </li>
  193. <li class="nav-item" data-depth="1">
  194. <a class="nav-link" href="../logo.html">Logo Usage</a>
  195. </li>
  196. <li class="nav-item" data-depth="1">
  197. <a class="nav-link" href="../bsd_license.html">License</a>
  198. </li>
  199. <li class="nav-item" data-depth="1">
  200. <a class="nav-link" href="../github_tips.html">Github Tips</a>
  201. </li>
  202. </ul>
  203. </li>
  204. <li class="nav-item" data-depth="0">
  205. <button class="nav-item-toggle"></button>
  206. <span class="nav-text">SDK</span>
  207. <ul class="nav-list">
  208. <li class="nav-item" data-depth="1">
  209. <a class="nav-link" href="../sdk.html">jMonkeyEngine SDK</a>
  210. </li>
  211. </ul>
  212. </li>
  213. </ul>
  214. </nav>
  215. </div>
  216. <div class="nav-panel-explore" data-panel="explore">
  217. <div class="context">
  218. <span class="title">Docs</span>
  219. <span class="version">master</span>
  220. </div>
  221. <ul class="components">
  222. <li class="component is-current">
  223. <span class="title">Docs</span>
  224. <ul class="versions">
  225. <li class="version is-current is-latest">
  226. <a href="../documentation.html">master</a>
  227. </li>
  228. </ul>
  229. </li>
  230. <li class="component">
  231. <span class="title">Wiki UI</span>
  232. <ul class="versions">
  233. <li class="version is-latest">
  234. <a href="../../wiki-ui/index.html">master</a>
  235. </li>
  236. </ul>
  237. </li>
  238. </ul>
  239. </div>
  240. </div>
  241. </aside>
  242. </div>
  243. <main class="article">
  244. <div class="toolbar" role="navigation">
  245. <button class="nav-toggle"></button>
  246. <nav class="breadcrumbs" aria-label="breadcrumbs">
  247. <ul>
  248. <li><a href="../documentation.html">Docs</a></li>
  249. <li><a href="sample_code.html">jMonkeyEngine SDK: Sample Code</a></li>
  250. </ul>
  251. </nav>
  252. <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs/modules/ROOT/pages/sdk/sample_code.adoc">Edit this Page</a></div>
  253. </div>
  254. <div class="content">
  255. <article class="doc">
  256. <h1 class="page">jMonkeyEngine SDK: Sample Code</h1>
  257. <div id="preamble">
  258. <div class="sectionbody">
  259. <div class="paragraph">
  260. <p>You can run example code by opening an included JME3Tests project and included assets. You can also search the built-in documentation or drag and drop code snippets from the Palette in the SDK to get short code sample.</p>
  261. </div>
  262. </div>
  263. </div>
  264. <div class="sect1">
  265. <h2 id="code-palette-and-samples-in-the-sdk"><a class="anchor" href="#code-palette-and-samples-in-the-sdk"></a>Code Palette and Samples in the SDK</h2>
  266. <div class="sectionbody">
  267. <div class="ulist">
  268. <ul>
  269. <li>
  270. <p>Type a keyword into the search box in the SDK or press <kbd>F1</kbd> to search the built-in help for sample code.</p>
  271. </li>
  272. <li>
  273. <p><a href="code_editor.html" class="page">SDK code editor and palette</a></p>
  274. </li>
  275. </ul>
  276. </div>
  277. </div>
  278. </div>
  279. <div class="sect1">
  280. <h2 id="the-jme3tests-project-template"><a class="anchor" href="#the-jme3tests-project-template"></a>The JME3Tests Project Template</h2>
  281. <div class="sectionbody">
  282. <div class="paragraph">
  283. <p>The jMonkeyEngine SDK contains a Test Project with lots of sample code and assets. The Test Project is all set up and ready to run, and it&#8217;s easy to use for beginners (no need to mess with classpaths or libraries).</p>
  284. </div>
  285. <div class="olist arabic">
  286. <ol class="arabic">
  287. <li>
  288. <p>Install and Open the jMonkeyEngine <a href="../sdk.html" class="page">SDK</a>.</p>
  289. </li>
  290. <li>
  291. <p>Go to <code><span class="menuseq"><b class="menu">File</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">New Project</b></span></code>.</p>
  292. </li>
  293. <li>
  294. <p>In the New Project Wizard, select <code>JME3 Tests</code> from the <code>JME3</code> category. Click <code><b class="button">Next</b></code>.</p>
  295. </li>
  296. <li>
  297. <p>Specify a location, e.g. create a jMonkeyProjects directory in your home directory. Click <code><b class="button">Finish</b></code>.</p>
  298. </li>
  299. </ol>
  300. </div>
  301. <div class="paragraph">
  302. <p>This default project template creates a project called <code>JmeTests</code>. It contains all test classes and examples from the jme3 source repository. Feel free to modify the code samples and experiment! In the unlikely event that you should break the project, <img class="emoji" draggable="false" height="24px" width="24px" src="https://twemoji.maxcdn.com/2/svg/1f603.svg" /> you can always recreate all packaged samples by creating another project from the New Project wizard&#8217;s <code>JME3 Tests</code> template.</p>
  303. </div>
  304. <div class="paragraph">
  305. <p>If you&#8217;re using the 3.1.0-Stable+ version of the SDK, you will need to set the <code>Source/Binary Format</code> from the <code>Project Properties</code> window to Java 1.7 or later.</p>
  306. </div>
  307. <div class="ulist">
  308. <ul>
  309. <li>
  310. <p>To change the source, <code><b class="button">RMB</b></code> select the jmeTestProject and then select <code><span class="menuseq"><b class="menu">Properties</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="submenu">Sources</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Source/Binary Format</b></span></code>, or from the File menu, with the jmeTestProject selected, <code><span class="menuseq"><b class="menu">File</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="submenu">Project Properties</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="submenu">Sources</b>&#160;<i class="fa fa-angle-right caret"></i> <b class="menuitem">Source/Binary Format</b></span></code>.</p>
  311. </li>
  312. </ul>
  313. </div>
  314. <div class="paragraph">
  315. <p>You will also need to remove the <code>jme3-jbullet</code> library and add <code>jme3-bullet</code> and <code>jme3-bullet-native</code> libraries.</p>
  316. </div>
  317. <div class="ulist">
  318. <ul>
  319. <li>
  320. <p>From the <code>Project Properties</code> window select <code>Libraries</code> and then the <code>Compile</code> tab. Under <code>Compile-time Libraries</code> select <code>jme3-jbullet</code> and press <code><b class="button">Remove</b></code>. Press <code><b class="button">Add Library</b></code>, select the two libraries <code>jme3-bullet</code> and <code>jme3-bullet-native</code> while holding <kbd>Ctrl</kbd> and then press <code><b class="button">Add Library</b></code> and finally <code><b class="button">OK</b></code>.</p>
  321. </li>
  322. </ul>
  323. </div>
  324. <div class="admonitionblock important">
  325. <table>
  326. <tr>
  327. <td class="icon">
  328. <i class="fa icon-important" title="Important"></i>
  329. </td>
  330. <td class="content">
  331. <div class="paragraph">
  332. <p>Press <kbd>Shift</kbd> + <kbd>F6</kbd> to run a class that is open in the editor, or <code><b class="button">RMB</b></code> a class in the Project window and choose <code><b class="button">Run File</b></code>. You can run the <code>TestChooser</code> app by <code><b class="button">RMB</b></code> selecting the project and pressing <code><b class="button">Run</b></code>. The TestChooser app allows you to easily navigate through all the test cases.</p>
  333. </div>
  334. </td>
  335. </tr>
  336. </table>
  337. </div>
  338. </div>
  339. </div>
  340. <div class="sect1">
  341. <h2 id="jme3testdata-assets"><a class="anchor" href="#jme3testdata-assets"></a>JME3TestData Assets</h2>
  342. <div class="sectionbody">
  343. <div class="paragraph">
  344. <p>You may want access to some sample assets, such as 3D models or textures, in one of your projects. A common situation for this would be while going through the <a href="../jme3.html#tutorials-for-beginners#" class="page">beginner tutorials</a>.</p>
  345. </div>
  346. <div class="olist arabic">
  347. <ol class="arabic">
  348. <li>
  349. <p><b class="button">RMB</b> select an existing jME3 project in the <a href="../sdk.html" class="page">SDK</a>, and select Properties.</p>
  350. </li>
  351. <li>
  352. <p>In the Properties window, select the <code>Libraries</code> section. Go to the <code>Compile</code> tab, it contains <code>Compile-time Libraries</code>.</p>
  353. </li>
  354. <li>
  355. <p>Click the <b class="button">Add Library</b> button and select the pre-defined <code>jme3-test-data</code>. Click <b class="button">OK</b>.</p>
  356. </li>
  357. <li>
  358. <p>Click <b class="button">OK</b> to save and close the Properties.</p>
  359. </li>
  360. </ol>
  361. </div>
  362. <div class="paragraph">
  363. <p>The project&#8217;s assetManager now has access to sample files from the <code>jme3-test-data.jar</code> file. This JAR library contains</p>
  364. </div>
  365. <div class="ulist">
  366. <ul>
  367. <li>
  368. <p>Ogre XML Models: Ninja.mesh.xml, Oto.mesh.xml, HoverTank.mesh.xml, Sinbad.mesh.xml, and many more</p>
  369. </li>
  370. <li>
  371. <p>Blender models</p>
  372. </li>
  373. <li>
  374. <p>Materials and Textures</p>
  375. <div class="ulist">
  376. <ul>
  377. <li>
  378. <p>Terrain, sky, rock, brick, pond…</p>
  379. </li>
  380. <li>
  381. <p>Particle effect textures</p>
  382. </li>
  383. </ul>
  384. </div>
  385. </li>
  386. <li>
  387. <p>Sounds</p>
  388. </li>
  389. <li>
  390. <p>And more…</p>
  391. </li>
  392. </ul>
  393. </div>
  394. </div>
  395. </div>
  396. <div class="sect1">
  397. <h2 id="assetpacks"><a class="anchor" href="#assetpacks"></a>AssetPacks</h2>
  398. <div class="sectionbody">
  399. <div class="imageblock right">
  400. <div class="content">
  401. <img src="../_images/sdk/assetpackbrowser-300x166.jpg" alt="assetpackbrowser-300x166.jpg" width="" height="">
  402. </div>
  403. </div>
  404. <div class="paragraph">
  405. <p>If you need sample 3D models, don&#8217;t miss the opportunity to download our community-provided <a href="asset_packs.html" class="page">Asset Packs</a>!</p>
  406. </div>
  407. <div class="paragraph">
  408. <p>In the SDK:</p>
  409. </div>
  410. <div class="ulist">
  411. <ul>
  412. <li>
  413. <p>Open the AssetPackBrowser from the Windows menu</p>
  414. </li>
  415. <li>
  416. <p>In the AssetPackBrowser, click the Online AssetPacks button</p>
  417. </li>
  418. <li>
  419. <p>Click <b class="button">Install</b> on the AssetPack of your choice. The SDK downloads it and makes the assets accessible in your AssetPack Library.</p>
  420. </li>
  421. <li>
  422. <p>Click the <b class="button">View Library</b> button and open the Assets node.</p>
  423. </li>
  424. <li>
  425. <p><b class="button">RMB</b> select an asset to</p>
  426. <div class="ulist">
  427. <ul>
  428. <li>
  429. <p>Preview it</p>
  430. </li>
  431. <li>
  432. <p>Add it to the SceneComposer</p>
  433. </li>
  434. <li>
  435. <p>Add it to a game project&#8217;s assets directory</p>
  436. </li>
  437. </ul>
  438. </div>
  439. </li>
  440. </ul>
  441. </div>
  442. <div class="paragraph">
  443. <p>Read more about <a href="asset_packs.html" class="page">Asset Packs</a> and how you can share your own collection with the community.</p>
  444. </div>
  445. </div>
  446. </div>
  447. </article>
  448. <aside class="toc sidebar" data-title="Contents" data-levels="2">
  449. <div class="toc-menu"></div>
  450. </aside>
  451. </div>
  452. </main>
  453. </div>
  454. <footer class="footer">
  455. <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
  456. </footer>
  457. <script src="../../_/js/vendor/docsearch.min.js"></script>
  458. <!-- fetched from https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js -->
  459. <script>
  460. var search = docsearch({
  461. apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  462. indexName: 'jmonkeyengine',
  463. inputSelector: '#search-input',
  464. autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] },
  465. algoliaOptions: { hitsPerPage: 10 }
  466. }).autocomplete
  467. search.on('autocomplete:closed', function () { search.autocomplete.setVal() })
  468. function focusSearchInput () { document.querySelector('#search-input').focus() }
  469. if (document.querySelector('.home-link.is-current')) window.addEventListener('load', focusSearchInput)
  470. </script>
  471. <script src="../../_/js/site.js"></script>
  472. <script async src="../../_/js/vendor/highlight.js"></script>
  473. </body>
  474. </html>