sample_code.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  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. </head>
  12. <body class="article">
  13. <header class="header">
  14. <nav class="navbar">
  15. <div class="navbar-brand">
  16. <a class="navbar-item" href="https://wiki.jmonkeyengine.org">jMonkeyEngine Docs</a>
  17. <button class="navbar-burger" data-target="topbar-nav">
  18. <span></span>
  19. <span></span>
  20. <span></span>
  21. </button>
  22. </div>
  23. <div id="topbar-nav" class="navbar-menu">
  24. <div class="navbar-end">
  25. <a class="navbar-item" href="#">Home</a>
  26. <div class="navbar-item has-dropdown is-hoverable">
  27. <a class="navbar-link" href="#">Products</a>
  28. <div class="navbar-dropdown">
  29. <a class="navbar-item" href="#">Product A</a>
  30. <a class="navbar-item" href="#">Product B</a>
  31. <a class="navbar-item" href="#">Product C</a>
  32. </div>
  33. </div>
  34. <div class="navbar-item has-dropdown is-hoverable">
  35. <a class="navbar-link" href="#">Services</a>
  36. <div class="navbar-dropdown">
  37. <a class="navbar-item" href="#">Service A</a>
  38. <a class="navbar-item" href="#">Service B</a>
  39. <a class="navbar-item" href="#">Service C</a>
  40. </div>
  41. </div>
  42. <div class="navbar-item has-dropdown is-hoverable">
  43. <a class="navbar-link" href="#">Resources</a>
  44. <div class="navbar-dropdown">
  45. <a class="navbar-item" href="#">Resource A</a>
  46. <a class="navbar-item" href="#">Resource B</a>
  47. <a class="navbar-item" href="#">Resource C</a>
  48. </div>
  49. </div>
  50. <div class="navbar-item">
  51. <span class="control">
  52. <a class="button is-primary" href="#">Download</a>
  53. </span>
  54. </div>
  55. </div>
  56. </div>
  57. </nav>
  58. </header>
  59. <div class="body">
  60. <div class="nav-container" data-component="docs" data-version="master">
  61. <aside class="nav">
  62. <div class="panels">
  63. <div class="nav-panel-menu is-active" data-panel="menu">
  64. <nav class="nav-menu">
  65. <h3 class="title"><a href="../jme3.html">Docs</a></h3>
  66. <ul class="nav-list">
  67. <li class="nav-item" data-depth="0">
  68. <ul class="nav-list">
  69. <li class="nav-item" data-depth="1">
  70. <a class="nav-link" href="../documentation.html">Getting Started</a>
  71. </li>
  72. <li class="nav-item" data-depth="1">
  73. <a class="nav-link" href="https://javadoc.jmonkeyengine.org/v3.3.2-stable">JavaDoc</a>
  74. </li>
  75. <li class="nav-item" data-depth="1">
  76. <button class="nav-item-toggle"></button>
  77. <a class="nav-link" href="../jme3.html">jMonkeyEngine 3</a>
  78. <ul class="nav-list">
  79. <li class="nav-item" data-depth="2">
  80. <button class="nav-item-toggle"></button>
  81. <span class="nav-text">Beginner Tutorials</span>
  82. <ul class="nav-list">
  83. <li class="nav-item" data-depth="3">
  84. <a class="nav-link" href="../jme3/beginner/hello_simpleapplication.html">Hello SimpleApplication</a>
  85. </li>
  86. <li class="nav-item" data-depth="3">
  87. <a class="nav-link" href="../jme3/beginner/hello_node.html">Hello Node</a>
  88. </li>
  89. <li class="nav-item" data-depth="3">
  90. <a class="nav-link" href="../jme3/beginner/hello_asset.html">Hello Asset</a>
  91. </li>
  92. <li class="nav-item" data-depth="3">
  93. <a class="nav-link" href="../jme3/beginner/hello_main_event_loop.html">Hello Main Event Loop</a>
  94. </li>
  95. <li class="nav-item" data-depth="3">
  96. <a class="nav-link" href="../jme3/beginner/hello_input_system.html">Hello Input System</a>
  97. </li>
  98. <li class="nav-item" data-depth="3">
  99. <a class="nav-link" href="../jme3/beginner/hello_material.html">Hello Material</a>
  100. </li>
  101. <li class="nav-item" data-depth="3">
  102. <a class="nav-link" href="../jme3/beginner/hello_animation.html">Hello Animation</a>
  103. </li>
  104. <li class="nav-item" data-depth="3">
  105. <a class="nav-link" href="../jme3/beginner/hello_picking.html">Hello Picking</a>
  106. </li>
  107. <li class="nav-item" data-depth="3">
  108. <a class="nav-link" href="../jme3/beginner/hello_collision.html">Hello Collision</a>
  109. </li>
  110. <li class="nav-item" data-depth="3">
  111. <a class="nav-link" href="../jme3/beginner/hello_terrain.html">Hello Terrain</a>
  112. </li>
  113. <li class="nav-item" data-depth="3">
  114. <a class="nav-link" href="../jme3/beginner/hello_audio.html">Hello Audio</a>
  115. </li>
  116. <li class="nav-item" data-depth="3">
  117. <a class="nav-link" href="../jme3/beginner/hello_effects.html">Hello Effects</a>
  118. </li>
  119. <li class="nav-item" data-depth="3">
  120. <a class="nav-link" href="../jme3/beginner/hello_physics.html">Hello Physics</a>
  121. </li>
  122. </ul>
  123. </li>
  124. <li class="nav-item" data-depth="2">
  125. <button class="nav-item-toggle"></button>
  126. <span class="nav-text">Intermediate Tutorials</span>
  127. <ul class="nav-list">
  128. <li class="nav-item" data-depth="3">
  129. <button class="nav-item-toggle"></button>
  130. <span class="nav-text">Concepts</span>
  131. <ul class="nav-list">
  132. <li class="nav-item" data-depth="4">
  133. <a class="nav-link" href="../jme3/intermediate/best_practices.html">Best Practices</a>
  134. </li>
  135. <li class="nav-item" data-depth="4">
  136. <a class="nav-link" href="../jme3/intermediate/simpleapplication.html">Simple Application</a>
  137. </li>
  138. <li class="nav-item" data-depth="4">
  139. <a class="nav-link" href="../jme3/features.html">Features</a>
  140. </li>
  141. <li class="nav-item" data-depth="4">
  142. <a class="nav-link" href="../jme3/intermediate/optimization.html">Optimization</a>
  143. </li>
  144. <li class="nav-item" data-depth="4">
  145. <a class="nav-link" href="../jme3/faq.html">FAQ</a>
  146. </li>
  147. </ul>
  148. </li>
  149. <li class="nav-item" data-depth="3">
  150. <button class="nav-item-toggle"></button>
  151. <span class="nav-text">Math Concepts</span>
  152. <ul class="nav-list">
  153. <li class="nav-item" data-depth="4">
  154. <a class="nav-link" href="../jme3/math_for_dummies.html">Math For Dummies</a>
  155. </li>
  156. <li class="nav-item" data-depth="4">
  157. <a class="nav-link" href="../jme3/intermediate/math.html">Math</a>
  158. </li>
  159. <li class="nav-item" data-depth="4">
  160. <a class="nav-link" href="../jme3/math.html">More Math</a>
  161. </li>
  162. <li class="nav-item" data-depth="4">
  163. <a class="nav-link" href="../jme3/rotate.html">Rotate</a>
  164. </li>
  165. <li class="nav-item" data-depth="4">
  166. <a class="nav-link" href="../jme3/math_video_tutorials.html">Math Video Tutorials</a>
  167. </li>
  168. </ul>
  169. </li>
  170. <li class="nav-item" data-depth="3">
  171. <button class="nav-item-toggle"></button>
  172. <span class="nav-text">3D Graphics Concepts</span>
  173. <ul class="nav-list">
  174. <li class="nav-item" data-depth="4">
  175. <a class="nav-link" href="../jme3/intermediate/multi-media_asset_pipeline.html">Multi-Media Asset Pipeline</a>
  176. </li>
  177. <li class="nav-item" data-depth="4">
  178. <a class="nav-link" href="../jme3/scenegraph_for_dummies.html">Scenegraph for Dummies</a>
  179. </li>
  180. <li class="nav-item" data-depth="4">
  181. <a class="nav-link" href="../jme3/beginner/hellovector.html">Hello Vector</a>
  182. </li>
  183. <li class="nav-item" data-depth="4">
  184. <a class="nav-link" href="../jme3/terminology.html">Terminology</a>
  185. </li>
  186. <li class="nav-item" data-depth="4">
  187. <a class="nav-link" href="../jme3/intermediate/how_to_use_materials.html">How to Use Materials</a>
  188. </li>
  189. <li class="nav-item" data-depth="4">
  190. <a class="nav-link" href="../jme3/intermediate/transparency_sorting.html">Transparency and Sorting</a>
  191. </li>
  192. <li class="nav-item" data-depth="4">
  193. <a class="nav-link" href="../jme3/external/blender.html">Importing from Blender</a>
  194. </li>
  195. <li class="nav-item" data-depth="4">
  196. <a class="nav-link" href="../jme3/external/3dsmax.html">Importing from 3DS Max</a>
  197. </li>
  198. </ul>
  199. </li>
  200. </ul>
  201. </li>
  202. </ul>
  203. </li>
  204. <li class="nav-item" data-depth="1">
  205. <a class="nav-link" href="../logo.html">Logo Usage</a>
  206. </li>
  207. <li class="nav-item" data-depth="1">
  208. <a class="nav-link" href="../bsd_license.html">License</a>
  209. </li>
  210. <li class="nav-item" data-depth="1">
  211. <a class="nav-link" href="../github_tips.html">Github Tips</a>
  212. </li>
  213. </ul>
  214. </li>
  215. <li class="nav-item" data-depth="0">
  216. <button class="nav-item-toggle"></button>
  217. <span class="nav-text">SDK</span>
  218. <ul class="nav-list">
  219. <li class="nav-item" data-depth="1">
  220. <a class="nav-link" href="../sdk.html">jMonkeyEngine SDK</a>
  221. </li>
  222. </ul>
  223. </li>
  224. </ul>
  225. </nav>
  226. </div>
  227. <div class="nav-panel-explore" data-panel="explore">
  228. <div class="context">
  229. <span class="title">Docs</span>
  230. <span class="version">master</span>
  231. </div>
  232. <ul class="components">
  233. <li class="component is-current">
  234. <span class="title">Docs</span>
  235. <ul class="versions">
  236. <li class="version is-current is-latest">
  237. <a href="../jme3.html">master</a>
  238. </li>
  239. </ul>
  240. </li>
  241. <li class="component">
  242. <span class="title">Wiki UI</span>
  243. <ul class="versions">
  244. <li class="version is-latest">
  245. <a href="../../wiki-ui/index.html">master</a>
  246. </li>
  247. </ul>
  248. </li>
  249. </ul>
  250. </div>
  251. </div>
  252. </aside>
  253. </div>
  254. <main class="article">
  255. <div class="toolbar" role="navigation">
  256. <button class="nav-toggle"></button>
  257. <a href="../documentation.html" class="home-link"></a>
  258. <nav class="breadcrumbs" aria-label="breadcrumbs">
  259. <ul>
  260. <li><a href="../jme3.html">Docs</a></li>
  261. <li><a href="sample_code.html">jMonkeyEngine SDK: Sample Code</a></li>
  262. </ul>
  263. </nav>
  264. <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>
  265. </div>
  266. <div class="content">
  267. <article class="doc">
  268. <h1 class="page">jMonkeyEngine SDK: Sample Code</h1>
  269. <div id="preamble">
  270. <div class="sectionbody">
  271. <div class="paragraph">
  272. <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>
  273. </div>
  274. </div>
  275. </div>
  276. <div class="sect1">
  277. <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>
  278. <div class="sectionbody">
  279. <div class="ulist">
  280. <ul>
  281. <li>
  282. <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>
  283. </li>
  284. <li>
  285. <p><a href="code_editor.html" class="page">SDK code editor and palette</a></p>
  286. </li>
  287. </ul>
  288. </div>
  289. </div>
  290. </div>
  291. <div class="sect1">
  292. <h2 id="the-jme3tests-project-template"><a class="anchor" href="#the-jme3tests-project-template"></a>The JME3Tests Project Template</h2>
  293. <div class="sectionbody">
  294. <div class="paragraph">
  295. <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>
  296. </div>
  297. <div class="olist arabic">
  298. <ol class="arabic">
  299. <li>
  300. <p>Install and Open the jMonkeyEngine <a href="../sdk.html" class="page">SDK</a>.</p>
  301. </li>
  302. <li>
  303. <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>
  304. </li>
  305. <li>
  306. <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>
  307. </li>
  308. <li>
  309. <p>Specify a location, e.g. create a jMonkeyProjects directory in your home directory. Click <code><b class="button">Finish</b></code>.</p>
  310. </li>
  311. </ol>
  312. </div>
  313. <div class="paragraph">
  314. <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>
  315. </div>
  316. <div class="paragraph">
  317. <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>
  318. </div>
  319. <div class="ulist">
  320. <ul>
  321. <li>
  322. <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>
  323. </li>
  324. </ul>
  325. </div>
  326. <div class="paragraph">
  327. <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>
  328. </div>
  329. <div class="ulist">
  330. <ul>
  331. <li>
  332. <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>
  333. </li>
  334. </ul>
  335. </div>
  336. <div class="admonitionblock important">
  337. <table>
  338. <tr>
  339. <td class="icon">
  340. <i class="fa icon-important" title="Important"></i>
  341. </td>
  342. <td class="content">
  343. <div class="paragraph">
  344. <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>
  345. </div>
  346. </td>
  347. </tr>
  348. </table>
  349. </div>
  350. </div>
  351. </div>
  352. <div class="sect1">
  353. <h2 id="jme3testdata-assets"><a class="anchor" href="#jme3testdata-assets"></a>JME3TestData Assets</h2>
  354. <div class="sectionbody">
  355. <div class="paragraph">
  356. <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>
  357. </div>
  358. <div class="olist arabic">
  359. <ol class="arabic">
  360. <li>
  361. <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>
  362. </li>
  363. <li>
  364. <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>
  365. </li>
  366. <li>
  367. <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>
  368. </li>
  369. <li>
  370. <p>Click <b class="button">OK</b> to save and close the Properties.</p>
  371. </li>
  372. </ol>
  373. </div>
  374. <div class="paragraph">
  375. <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>
  376. </div>
  377. <div class="ulist">
  378. <ul>
  379. <li>
  380. <p>Ogre XML Models: Ninja.mesh.xml, Oto.mesh.xml, HoverTank.mesh.xml, Sinbad.mesh.xml, and many more</p>
  381. </li>
  382. <li>
  383. <p>Blender models</p>
  384. </li>
  385. <li>
  386. <p>Materials and Textures</p>
  387. <div class="ulist">
  388. <ul>
  389. <li>
  390. <p>Terrain, sky, rock, brick, pond…</p>
  391. </li>
  392. <li>
  393. <p>Particle effect textures</p>
  394. </li>
  395. </ul>
  396. </div>
  397. </li>
  398. <li>
  399. <p>Sounds</p>
  400. </li>
  401. <li>
  402. <p>And more…</p>
  403. </li>
  404. </ul>
  405. </div>
  406. </div>
  407. </div>
  408. <div class="sect1">
  409. <h2 id="assetpacks"><a class="anchor" href="#assetpacks"></a>AssetPacks</h2>
  410. <div class="sectionbody">
  411. <div class="imageblock right">
  412. <div class="content">
  413. <img src="../_images/sdk/assetpackbrowser-300x166.jpg" alt="assetpackbrowser-300x166.jpg" width="" height="">
  414. </div>
  415. </div>
  416. <div class="paragraph">
  417. <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>
  418. </div>
  419. <div class="paragraph">
  420. <p>In the SDK:</p>
  421. </div>
  422. <div class="ulist">
  423. <ul>
  424. <li>
  425. <p>Open the AssetPackBrowser from the Windows menu</p>
  426. </li>
  427. <li>
  428. <p>In the AssetPackBrowser, click the Online AssetPacks button</p>
  429. </li>
  430. <li>
  431. <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>
  432. </li>
  433. <li>
  434. <p>Click the <b class="button">View Library</b> button and open the Assets node.</p>
  435. </li>
  436. <li>
  437. <p><b class="button">RMB</b> select an asset to</p>
  438. <div class="ulist">
  439. <ul>
  440. <li>
  441. <p>Preview it</p>
  442. </li>
  443. <li>
  444. <p>Add it to the SceneComposer</p>
  445. </li>
  446. <li>
  447. <p>Add it to a game project&#8217;s assets directory</p>
  448. </li>
  449. </ul>
  450. </div>
  451. </li>
  452. </ul>
  453. </div>
  454. <div class="paragraph">
  455. <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>
  456. </div>
  457. </div>
  458. </div>
  459. </article>
  460. <aside class="toc sidebar" data-title="Contents" data-levels="2">
  461. <div class="toc-menu"></div>
  462. </aside>
  463. </div>
  464. </main>
  465. </div>
  466. <footer class="footer">
  467. <p>This page was built using the Antora default UI.</p>
  468. <p>The source code for this UI is licensed under the terms of the MPL-2.0 license.</p>
  469. </footer>
  470. <script src="../../_/js/site.js"></script>
  471. <script async src="../../_/js/vendor/highlight.js"></script>
  472. </body>
  473. </html>