- fix jmp internal manual git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@7735 75d07b2b-3a1a-0410-a2c5-0572b91ccdca3.0
nor..67
14 years ago
parent
a43e52a384
commit
030edabc80
@ -1,83 +1,49 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Models and Scenes</a></h1> |
name="models_and_scenes">Models and Scenes</a></h1><div |
||||||
<div> |
class="level1"><p> Like <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/advanced/shape.html">Shape</a>s, 3D models are also made up of <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/jme3/advanced/mesh.html">Mesh</a>es, but models are more complex than Shapes. While Shapes are built into jME3, you typically create models in external 3D Mesh Editors.</p></div><h2><a |
||||||
|
name="using_models_and_scenes_with_jme3">Using Models and Scenes with jME3</a></h2><div |
||||||
Like <a href="/com/jme3/gde/core/docs/jme3/advanced/shape.html">Shape</a>s, 3D models are also made up of <a href="/com/jme3/gde/core/docs/jme3/advanced/mesh.html">Mesh</a>es, but models are more complex than Shapes. While Shapes are built into jME3, you typically create models in external 3D Mesh Editors. |
class="level2"><p> To use 3D models in a jME3 application:</p><ol><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Export the 3D model in Ogre <acronym |
||||||
</div> |
title="Extensible Markup Language">XML</acronym> or Wavefront OBJ format. Export Scenes as Ogre DotScene format.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Using Models and Scenes with jME3</a></h2> |
class="li"> Save the files into a subdirectory of your jME3 project's <code>assets</code> directory.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> In your code, you use the <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/jme3/advanced/asset_manager.html">Asset Manager</a> to load models as <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/advanced/spatial.html">Spatial</a>s into a jME application.<pre>Spatial model = assetManager.loadModel( |
||||||
To use 3D models in a jME3 application: |
"Models/MonkeyHead/MonkeyHead.mesh.xml" );</pre></div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ol> |
class="li"> (For the release build:) Use the jMonkeyPlatform to convert models to .j3o format. You don't need this step as long you still develop and test the aplication within the jMonkeyPlatform.</div></li></ol></div><h2><a |
||||||
<li><div> Export the 3D model in Ogre <acronym title="Extensible Markup Language">XML</acronym> or Wavefront OBJ format. Export Scenes as Ogre DotScene format.</div> |
name="creating_models_and_scenes">Creating Models and Scenes</a></h2><div |
||||||
</li> |
class="level2"><p> To create 3D models and scenes, you need a 3D Mesh Editor such as <a |
||||||
<li><div> Save the files into a subdirectory of your jME3 project's <code>assets</code> directory.</div> |
href="http://www.blender.org/">Blender</a>, with an OgreXML Exporter plugin.</p><p> <strong>Tip:</strong> Consider creating <a |
||||||
</li> |
href="http://en.wikibooks.org/wiki/Blender_3D:_Noob_to_Pro/UV_Map_Basics">UV textures</a> for more complex models, it looks more professional.</p><p> 3D mesh editors are third-party products, so please consult their documentation for instructions how to use them. Here is an example workflow for Blender users:</p><p> To export your models as Ogre <acronym |
||||||
<li><div> In your code, you use the <a href="/com/jme3/gde/core/docs/jme3/advanced/asset_manager.html">Asset Manager</a> to load models as <a href="/com/jme3/gde/core/docs/jme3/advanced/spatial.html">Spatial</a>s into a jME application. <pre>Spatial model = assetManager.loadModel( |
title="Extensible Markup Language">XML</acronym> meshes with materials:</p><ol><li |
||||||
"Models/MonkeyHead/MonkeyHead.mesh.xml" );</pre></div> |
class="level1"><div |
||||||
</li> |
class="li"> Open the menu File > Export > OgreXML Exporter to open the exporter dialog.</div></li><li |
||||||
<li><div> (For the release build:) Use the jMonkeyPlatform to convert models to .j3o format. You don't need this step as long you still develop and test the aplication within the jMonkeyPlatform.</div> |
class="level1"><div |
||||||
</li> |
class="li"> In the Export Materials field: Give the material the same name as the model. For example, the model <code>something.mesh.xml</code> goes with <code>something.material</code>, plus (optionally) <code>something.skeleton.xml</code>, and some <acronym |
||||||
</ol> |
title="Joint Photographics Experts Group">JPG</acronym> files.</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> In the Export Meshes field: Select a target subdirectory of your <code>assets/Models/</code> directory. E.g. <code>assets/Models/something/</code>.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Creating Models and Scenes</a></h2> |
class="li"> Activate the following exporter settings:</div><ul><li |
||||||
<div> |
class="level2"><div |
||||||
|
class="li"> Copy Textures: YES</div></li><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> Rendering Materials: YES</div></li><li |
||||||
To create 3D models and scenes, you need a 3D Mesh Editor such as <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.blender.org/"><param name="text" value="<html><u>Blender</u></html>"><param name="textColor" value="blue"></object>, with an OgreXML Exporter plugin. |
class="level2"><div |
||||||
</p> |
class="li"> Flip Axis: YES</div></li><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> Require Materials: YES</div></li><li |
||||||
<strong>Tip:</strong> Consider creating <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://en.wikibooks.org/wiki/Blender_3D:_Noob_to_Pro/UV_Map_Basics"><param name="text" value="<html><u>UV textures</u></html>"><param name="textColor" value="blue"></object> for more complex models, it looks more professional. |
class="level2"><div |
||||||
</p> |
class="li"> Skeleton name follows mesh: YES</div></li></ul></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Click export.</div></li></ol><p> You can now use the <a |
||||||
3D mesh editors are third-party products, so please consult their documentation for instructions how to use them. Here is an example workflow for Blender users: |
href="/com/jme3/gde/core/docs/sdk.html">jMonkeyPlatform</a> to <a |
||||||
</p> |
href="/com/jme3/gde/core/docs/sdk/model_loader_and_viewer.html">load and view models</a>. You can <a |
||||||
|
href="/com/jme3/gde/core/docs/sdk/scene_composer.html">create scenes</a> from them and write cde that loads them into your application.</p></div> |
||||||
<p> |
|
||||||
To export your models as Ogre <acronym title="Extensible Markup Language">XML</acronym> meshes with materials: |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Open the menu File > Export > OgreXML Exporter to open the exporter dialog.</div> |
|
||||||
</li> |
|
||||||
<li><div> In the Export Materials field: Give the material the same name as the model. For example, the model <code>something.mesh.xml</code> goes with <code>something.material</code>, plus (optionally) <code>something.skeleton.xml</code>, and some <acronym title="Joint Photographics Experts Group">JPG</acronym> files.</div> |
|
||||||
</li> |
|
||||||
<li><div> In the Export Meshes field: Select a target subdirectory of your <code>assets/Models/</code> directory. E.g. <code>assets/Models/something/</code>.</div> |
|
||||||
</li> |
|
||||||
<li><div> Activate the following exporter settings: </div> |
|
||||||
<ul> |
|
||||||
<li><div> Copy Textures: YES</div> |
|
||||||
</li> |
|
||||||
<li><div> Rendering Materials: YES</div> |
|
||||||
</li> |
|
||||||
<li><div> Flip Axis: YES</div> |
|
||||||
</li> |
|
||||||
<li><div> Require Materials: YES</div> |
|
||||||
</li> |
|
||||||
<li><div> Skeleton name follows mesh: YES</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> Click export.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You can now use the <a href="/com/jme3/gde/core/docs/sdk.html">jMonkeyPlatform</a> to <a href="/com/jme3/gde/core/docs/sdk/model_loader_and_viewer.html">load and view models</a>. You can <a href="/com/jme3/gde/core/docs/sdk/scene_composer.html">create scenes</a> from them and write cde that loads them into your application. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:3d_models?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:3d_models?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,172 +1,132 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>The jME3 Camera</a></h1> |
name="the_jme3_camera">The jME3 Camera</a></h1><div |
||||||
<div> |
class="level1"></div><h2><a |
||||||
|
name="default_camera">Default Camera</a></h2><div |
||||||
</div> |
class="level2"><p> The default com.jme3.renderer.Camera object is <code>cam</code> in com.jme3.app.Application.</p><p> The camera object is created with the following defaults:</p><ul><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Default Camera</a></h2> |
class="li"> Width and height are set to the current Application's settings.getWidth() and settings.getHeight() values.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> Frustum Perspective:</div><ul><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> Frame of view angle of 45° along the Y axis</div></li><li |
||||||
The default com.jme3.renderer.Camera object is <code>cam</code> in com.jme3.app.Application. |
class="level2"><div |
||||||
</p> |
class="li"> Aspect ratio of width divided by height</div></li><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> Near view plane of 1 wu</div></li><li |
||||||
The camera object is created with the following defaults: |
class="level2"><div |
||||||
</p> |
class="li"> Far view plane of 1000 wu</div></li></ul></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Width and height are set to the current Application's settings.getWidth() and settings.getHeight() values. </div> |
class="li"> Start location at (0f, 0f, 10f).</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Frustum Perspective:</div> |
class="li"> Start direction is looking at the origin.</div></li></ul><div |
||||||
<ul> |
class="table sectionedit1"><table |
||||||
<li><div> Frame of view angle of 45° along the Y axis</div> |
class="inline"><tr |
||||||
</li> |
class="row0"><th |
||||||
<li><div> Aspect ratio of width divided by height</div> |
class="col0">Method</th><th |
||||||
</li> |
class="col1">Usage</th></tr><tr |
||||||
<li><div> Near view plane of 1 wu</div> |
class="row1"><td |
||||||
</li> |
class="col0">cam.getLocation(), setLocation()</td><td |
||||||
<li><div> Far view plane of 1000 wu</div> |
class="col1">The camera position</td></tr><tr |
||||||
</li> |
class="row2"><td |
||||||
</ul> |
class="col0">cam.getRotation(), setRotation()</td><td |
||||||
</li> |
class="col1">The camera rotation</td></tr><tr |
||||||
<li><div> Start location at (0f, 0f, 10f).</div> |
class="row3"><td |
||||||
</li> |
class="col0">cam.getLeft(), setLeft()</td><td |
||||||
<li><div> Start direction is looking at the origin.</div> |
class="col1">The left axis of the camera</td></tr><tr |
||||||
</li> |
class="row4"><td |
||||||
</ul> |
class="col0">cam.getUp(), setUp()</td><td |
||||||
<table> |
class="col1">The up axis of the camera, usually Vector3f(0,1,0)</td></tr><tr |
||||||
<tr> |
class="row5"><td |
||||||
<th>Method</th><th>Usage</th> |
class="col0">cam.getDirection(), setDirection()</td><td |
||||||
</tr> |
class="col1">The vector the camera is facing</td></tr><tr |
||||||
<tr> |
class="row6"><td |
||||||
<td>cam.getLocation(), setLocation()</td><td>The camera position</td> |
class="col0">cam.getAxes(), setAxes(left,up,dir)</td><td |
||||||
</tr> |
class="col1">One accessor for the three properties left/up/direction.</td></tr><tr |
||||||
<tr> |
class="row7"><td |
||||||
<td>cam.getRotation(), setRotation()</td><td>The camera rotation</td> |
class="col0">cam.getFrame(), setFrame(loc,left,up,dir)</td><td |
||||||
</tr> |
class="col1">One accessor for the four properties location/left/up/direction.</td></tr><tr |
||||||
<tr> |
class="row8"><td |
||||||
<td>cam.getLeft(), setLeft()</td><td>The left axis of the camera</td> |
class="col0">cam.resize(width, height, fixAspect)</td><td |
||||||
</tr> |
class="col1">Resize an existing camera object while keeping all other settings. Set fixAspect to true to adjust the aspect ratio (?)</td></tr><tr |
||||||
<tr> |
class="row9"><td |
||||||
<td>cam.getUp(), setUp()</td><td>The up axis of the camera, usually Vector3f(0,1,0)</td> |
class="col0">cam.setFrustum( near, far, left, right, top, bottom )</td><td |
||||||
</tr> |
class="col1">The frustrum is defined by the near/far plane, left/rught plane, top/bottom plane (all distances as float values)</td></tr><tr |
||||||
<tr> |
class="row10"><td |
||||||
<td>cam.getDirection(), setDirection()</td><td>The vector the camera is facing</td> |
class="col0">cam.setFrustumPerspective( fovY, aspect ratio, near, far)</td><td |
||||||
</tr> |
class="col1">The frustrum is defined by view angle along the Y axis (in degrees), aspect ratio, and the near/far plane.</td></tr><tr |
||||||
<tr> |
class="row11"><td |
||||||
<td>cam.getAxes(), setAxes(left,up,dir)</td><td>One accessor for the three properties left/up/direction.</td> |
class="col0">cam.lookAt(target,up)</td><td |
||||||
</tr> |
class="col1">Turn the camera to look at Coordinate target, and rotate it around the up axis.</td></tr><tr |
||||||
<tr> |
class="row12"><td |
||||||
<td>cam.getFrame(), setFrame(loc,left,up,dir)</td><td>One accessor for the four properties location/left/up/direction.</td> |
class="col0">cam.setParallelProjection(false)</td><td |
||||||
</tr> |
class="col1">Normal perspective</td></tr><tr |
||||||
<tr> |
class="row13"><td |
||||||
<td>cam.resize(width, height, fixAspect)</td><td>Resize an existing camera object while keeping all other settings. Set fixAspect to true to adjust the aspect ratio (?)</td> |
class="col0">cam.setParallelProjection(true)</td><td |
||||||
</tr> |
class="col1">Parallel projection perspective</td></tr><tr |
||||||
<tr> |
class="row14"><td |
||||||
<td>cam.setFrustum( near, far, left, right, top, bottom )</td><td>The frustrum is defined by the near/far plane, left/rught plane, top/bottom plane (all distances as float values)</td> |
class="col0">cam.getScreenCoordinates()</td><td |
||||||
</tr> |
class="col1">?</td></tr></table></div><p> <strong>Tip:</strong> After you change view port, frustrum, or frame, call <code>cam.update();</code></p></div><h2><a |
||||||
<tr> |
name="flyby_camera">FlyBy Camera</a></h2><div |
||||||
<td>cam.setFrustumPerspective( fovY, aspect ratio, near, far)</td><td>The frustrum is defined by view angle along the Y axis (in degrees), aspect ratio, and the near/far plane.</td> |
class="level2"><p> The flyby camera is an extension of the default camera in com.jme3.app.SimpleApplication. It is preconfigured to respond to the WASD keys for walking forwards and backwards, and for strafing to the sides. Move the mouse to rotate the camera, scroll the mouse wheel for zooming in or out. The QZ keys raise or lower the camera.</p><div |
||||||
</tr> |
class="table sectionedit2"><table |
||||||
<tr> |
class="inline"><tr |
||||||
<td>cam.lookAt(target,up)</td><td>Turn the camera to look at Coordinate target, and rotate it around the up axis.</td> |
class="row0"><th |
||||||
</tr> |
class="col0">Method</th><th |
||||||
<tr> |
class="col1">Usage</th></tr><tr |
||||||
<td>cam.setParallelProjection(false)</td><td>Normal perspective</td> |
class="row1"><td |
||||||
</tr> |
class="col0">flyCam.setEnabled(true);</td><td |
||||||
<tr> |
class="col1">Activate the flyby cam</td></tr><tr |
||||||
<td>cam.setParallelProjection(true)</td><td>Parallel projection perspective</td> |
class="row2"><td |
||||||
</tr> |
class="col0">flyCam.setMoveSpeed(10);</td><td |
||||||
<tr> |
class="col1">Control the move speed</td></tr><tr |
||||||
<td>cam.getScreenCoordinates()</td><td>?</td> |
class="row3"><td |
||||||
</tr> |
class="col0">flyCam.setRotationSpeed(10);</td><td |
||||||
</table> |
class="col1">Control the rotation speed</td></tr><tr |
||||||
|
class="row4"><td |
||||||
<p> |
class="col0">flyCam.setDragToRotate(true)</td><td |
||||||
<strong>Tip:</strong> After you change view port, frustrum, or frame, call <code>cam.update();</code> |
class="col1">Must keep mouse button pressed to rotate camera. Used e.g. for Applets. if false, all mouse movement will be captured and interpreted as rotations.</td></tr></table></div></div><h2><a |
||||||
</p> |
name="chase_camera">Chase Camera</a></h2><div |
||||||
|
class="level2"><p> jME3 also supports a Chase Cam that can follow a moving target Spatial (<code>com.jme3.input.ChaseCamera</code>). Click and hold the mouse button to rotate around the target.</p><pre>flyCam.setEnabled(false); |
||||||
</div> |
ChaseCamera chaseCam = new ChaseCamera(cam, target, inputManager);</pre><div |
||||||
|
class="table sectionedit3"><table |
||||||
<h2><a>FlyBy Camera</a></h2> |
class="inline"><tr |
||||||
<div> |
class="row0"><th |
||||||
|
class="col0">Method</th><th |
||||||
<p> |
class="col1">Usage</th></tr><tr |
||||||
|
class="row1"><td |
||||||
The flyby camera is an extension of the default camera in com.jme3.app.SimpleApplication. It is preconfigured to respond to the WASD keys for walking forwards and backwards, and for strafing to the sides. Move the mouse to rotate the camera, scroll the mouse wheel for zooming in or out. The QZ keys raise or lower the camera. |
class="col0">chaseCam.setSmoothMotion(true);</td><td |
||||||
|
class="col1">Interpolates a smoother acceleration/deceleration when the camera moves.</td></tr><tr |
||||||
</p> |
class="row2"><td |
||||||
<table> |
class="col0">chaseCam.setChasingSensitivity(5f)</td><td |
||||||
<tr> |
class="col1">The lower the chasing sensitivity, the slower the camera will follow the target when it moves.</td></tr><tr |
||||||
<th>Method</th><th>Usage</th> |
class="row3"><td |
||||||
</tr> |
class="col0">chaseCam.setTrailingSensitivity(0.5f)</td><td |
||||||
<tr> |
class="col1">The lower the traling sensitivity, the slower the camera will begin to go after the target when it moves. Default is 0.5;</td></tr><tr |
||||||
<td>flyCam.setEnabled(true);</td><td>Activate the flyby cam</td> |
class="row4"><td |
||||||
</tr> |
class="col0">chaseCam.setRotationSensitivity(5f)</td><td |
||||||
<tr> |
class="col1">The lower the sensitivity, the slower the camera will rotate around the target when the mosue is dragged. Default is 5.</td></tr><tr |
||||||
<td>flyCam.setMoveSpeed(10);</td><td>Control the move speed</td> |
class="row5"><td |
||||||
</tr> |
class="col0">chaseCam.setTrailingRotationInertia(0.1f)</td><td |
||||||
<tr> |
class="col1">This prevents the camera to stop too abruptly when the target stops rotating before the camera has reached the target's trailing position. Default is 0.1f.</td></tr><tr |
||||||
<td>flyCam.setRotationSpeed(10);</td><td>Control the rotation speed</td> |
class="row6"><td |
||||||
</tr> |
class="col0">chaseCam.setDefaultDistance(40);</td><td |
||||||
<tr> |
class="col1">The default distance to the target at the start of the application.</td></tr><tr |
||||||
<td>flyCam.setDragToRotate(true)</td><td>Must keep mouse button pressed to rotate camera. Used e.g. for Applets. if false, all mouse movement will be captured and interpreted as rotations.</td> |
class="row7"><td |
||||||
</tr> |
class="col0">chaseCam.setMaxDistance(40);</td><td |
||||||
</table> |
class="col1">The maximum zoom distance. Default is 40f.</td></tr><tr |
||||||
|
class="row8"><td |
||||||
</div> |
class="col0">chaseCam.setMinDistance(1);</td><td |
||||||
|
class="col1">The minimum zoom distance. Default is 1f.</td></tr><tr |
||||||
<h2><a>Chase Camera</a></h2> |
class="row9"><td |
||||||
<div> |
class="col0">chaseCam.setMinVerticalRotation(-FastMath.PI/2);</td><td |
||||||
|
class="col1">The minimal vertical rotation angle of the camera around the target. Default is 0.</td></tr><tr |
||||||
<p> |
class="row10"><td |
||||||
|
class="col0">chaseCam.setDefaultVerticalRotation(-FastMath.PI/2);</td><td |
||||||
jME3 also supports a Chase Cam that can follow a moving target Spatial (<code>com.jme3.input.ChaseCamera</code>). Click and hold the mouse button to rotate around the target. |
class="col1">The default vertical rotation angle of the camera around the target at the start of the application.</td></tr><tr |
||||||
</p> |
class="row11"><td |
||||||
<pre>flyCam.setEnabled(false); |
class="col0">chaseCam.setDefaultHorizontalRotation(-FastMath.PI/2);</td><td |
||||||
ChaseCamera chaseCam = new ChaseCamera(cam, target, inputManager);</pre><table> |
class="col1">The default horizontal rotation angle of the camera around the target at the start of the application.</td></tr></table></div><div |
||||||
<tr> |
class="tags"><span> <a |
||||||
<th>Method</th><th>Usage</th> |
href="/wiki/doku.php/tag:camera?do=showtag&tag=tag%3Acamera">camera</a>, <a |
||||||
</tr> |
href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a> </span></div></div> |
||||||
<tr> |
|
||||||
<td>chaseCam.setSmoothMotion(true);</td><td>Interpolates a smoother acceleration/deceleration when the camera moves.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setChasingSensitivity(5f)</td><td>The lower the chasing sensitivity, the slower the camera will follow the target when it moves.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setTrailingSensitivity(0.5f)</td><td>The lower the traling sensitivity, the slower the camera will begin to go after the target when it moves. Default is 0.5;</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setRotationSensitivity(5f)</td><td>The lower the sensitivity, the slower the camera will rotate around the target when the mosue is dragged. Default is 5.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setTrailingRotationInertia(0.1f)</td><td>This prevents the camera to stop too abruptly when the target stops rotating before the camera has reached the target's trailing position. Default is 0.1f.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setDefaultDistance(40);</td><td>The default distance to the target at the start of the application.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setMaxDistance(40);</td><td>The maximum zoom distance. Default is 40f.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setMinDistance(1);</td><td>The minimum zoom distance. Default is 1f.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setMinVerticalRotation(-FastMath.PI/2);</td><td>The minimal vertical rotation angle of the camera around the target. Default is 0.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setDefaultVerticalRotation(-FastMath.PI/2);</td><td>The default vertical rotation angle of the camera around the target at the start of the application.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>chaseCam.setDefaultHorizontalRotation(-FastMath.PI/2);</td><td>The default horizontal rotation angle of the camera around the target at the start of the application.</td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
<div><span> |
|
||||||
<a href="/wiki/doku.php/tag:camera?do=showtag&tag=tag%3Acamera">camera</a>, |
|
||||||
<a href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a> |
|
||||||
</span></div> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:camera?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:camera?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,266 +1,92 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jME3 Effects -- Overview</a></h1> |
name="jme3_effects_--_overview">jME3 Effects -- Overview</a></h1><div |
||||||
<div> |
class="level1"><p> <br/></p><p> jME3 supports various post-rendering and particle effects. This list contains screenshots and sample code that demonstrates how to add the effect to a scene.</p><p> <br/></p></div><h2><a |
||||||
|
name="d_filter_effects">2D Filter Effects</a></h2><div |
||||||
<p> |
class="level2"></div><h3><a |
||||||
|
name="screen_space_ambient_occlusion">Screen Space Ambient Occlusion</a></h3><div |
||||||
<br/> |
class="level3"><p> <a |
||||||
|
href="/wiki/lib/exe/fetch.php?hash=500208&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F08%2Fssao-article.png"><img |
||||||
</p> |
src="/wiki/lib/exe/fetch.php?hash=500208&w=150&h=100&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F08%2Fssao-article.png" class="mediaright" align="right" alt="" width="150" height="100" /></a></p><p> <a |
||||||
|
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestSSAO.java">jme3/src/test/jme3test/post/TestSSAO.java</a></p><p> <a |
||||||
<p> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestSSAO2.java">jme3/src/test/jme3test/post/TestSSAO2.java</a></p><p> <a |
||||||
jME3 supports various post-rendering and particle effects. This list contains screenshots and sample code that demonstrates how to add the effect to a scene. |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestTransparentSSAO.java">jme3/src/test/jme3test/post/TestTransparentSSAO.java</a></p><p> <a |
||||||
</p> |
href="http://jmonkeyengine.org/2010/08/16/screen-space-ambient-occlusion-for-jmonkeyengine-3-0/#more-321">Screen Space Ambient Occlusion for jMonkeyEngine</a> (article)</p><p> <a |
||||||
|
href="/wiki/lib/exe/detail.php/jme3:advanced:light-scattering-filter.png?id=jme3%3Aadvanced%3Aeffects_overview"><img |
||||||
<p> |
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/light-scattering-filter.png?w=150&h=100" class="mediaright" align="right" alt="" width="150" height="100" /></a></p></div><h3><a |
||||||
<br/> |
name="light_scattering">Light Scattering</a></h3><div |
||||||
|
class="level3"><p> <a |
||||||
</p> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestLightScattering.java">jme3/src/test/jme3test/post/TestLightScattering.java</a></p></div><h3><a |
||||||
|
name="bloom">Bloom</a></h3><div |
||||||
</div> |
class="level3"><p> <a |
||||||
|
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestBloom.java">jme3/src/test/jme3test/post/TestBloom.java</a></p><p> <a |
||||||
<h2><a>2D Filter Effects</a></h2> |
href="/com/jme3/gde/core/docs/jme3/advanced/bloom_and_glow.html">Bloom and Glow</a></p><p> <a |
||||||
<div> |
href="/wiki/lib/exe/detail.php/jme3:advanced:toon-dino.png?id=jme3%3Aadvanced%3Aeffects_overview"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/toon-dino.png?w=150&h=100" class="mediaright" align="right" alt="" width="150" height="100" /></a></p></div><h3><a |
||||||
</div> |
name="toon_effect">Toon Effect</a></h3><div |
||||||
|
class="level3"><p> <a |
||||||
<h3><a>Screen Space Ambient Occlusion</a></h3> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestCartoonEdge.java">jme3/src/test/jme3test/post/TestCartoonEdge.java</a></p><p> <a |
||||||
<div> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestTransparentCartoonEdge.java">jme3/src/test/jme3test/post/TestTransparentCartoonEdge.java</a></p></div><h3><a |
||||||
|
name="depth_of_field_blur">Depth of Field Blur</a></h3><div |
||||||
<p> |
class="level3"><p> <a |
||||||
|
href="/wiki/lib/exe/detail.php/jme3:advanced:dof-blur.png?id=jme3%3Aadvanced%3Aeffects_overview"><img |
||||||
<img src="/wiki/lib/exe/fetch.php"> |
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/dof-blur.png?w=150&h=100" class="mediaright" align="right" alt="" width="150" height="100" /></a></p><p> <a |
||||||
</p> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestDepthOfField.java">jme3/src/test/jme3test/post/TestDepthOfField.java</a></p></div><h3><a |
||||||
|
name="fog">Fog</a></h3><div |
||||||
<p> |
class="level3"><p> <a |
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestSSAO.java"><param name="text" value="<html><u>jme3/src/test/jme3test/post/TestSSAO.java</u></html>"><param name="textColor" value="blue"></object> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestFog.java">jme3/src/test/jme3test/post/TestFog.java</a> (temporary workaround, will be deprecated)</p><p> <a |
||||||
</p> |
href="/wiki/lib/exe/detail.php/jme3:advanced:light-sources.png?id=jme3%3Aadvanced%3Aeffects_overview"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/light-sources.png?w=150&h=100" class="mediaright" align="right" alt="" width="150" height="100" /></a></p></div><h2><a |
||||||
<p> |
name="lighting_and_shadows">Lighting and Shadows</a></h2><div |
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestSSAO2.java"><param name="text" value="<html><u>jme3/src/test/jme3test/post/TestSSAO2.java</u></html>"><param name="textColor" value="blue"></object> |
class="level2"><p> <a |
||||||
</p> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestSimpleLighting.java">jme3/src/test/jme3test/light/TestSimpleLighting.java</a></p><p> <a |
||||||
|
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestLightRadius.java">jme3/src/test/jme3test/light/TestLightRadius.java</a></p><p> <a |
||||||
<p> |
href="/wiki/lib/exe/detail.php/jme3:advanced:shadow.png?id=jme3%3Aadvanced%3Aeffects_overview"><img |
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestTransparentSSAO.java"><param name="text" value="<html><u>jme3/src/test/jme3test/post/TestTransparentSSAO.java</u></html>"><param name="textColor" value="blue"></object> |
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/shadow.png?w=150&h=100" class="mediaright" align="right" alt="" width="150" height="100" /></a></p><p> <a |
||||||
</p> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestManyLights.java">jme3/src/test/jme3test/light/TestManyLights.java</a></p><p> <a |
||||||
|
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestShadow.java">jme3/src/test/jme3test/light/TestShadow.java</a></p><p> <a |
||||||
<p> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestPssmShadow.java">jme3/src/test/jme3test/light/TestPssmShadow.java</a> = Parallel-Split Shadow Mapping (PSSM)</p></div><h2><a |
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://jmonkeyengine.org/2010/08/16/screen-space-ambient-occlusion-for-jmonkeyengine-3-0/#more-321"><param name="text" value="<html><u>Screen Space Ambient Occlusion for jMonkeyEngine</u></html>"><param name="textColor" value="blue"></object> (article) |
name="water">Water</a></h2><div |
||||||
</p> |
class="level2"><p> <a |
||||||
|
href="/wiki/lib/exe/detail.php/jme3:advanced:water.png?id=jme3%3Aadvanced%3Aeffects_overview"><img |
||||||
<p> |
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/water.png?w=150&h=100" class="mediaright" align="right" alt="" width="150" height="100" /></a></p><p> <a |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/light-scattering-filter.png"> |
href="/com/jme3/gde/core/docs/jme3/advanced/water.html">"SeaMonkey" water</a></p><ul><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
</div> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/water/TestSceneWater.java">jme3/src/test/jme3test/water/TestSceneWater.java</a></div></li></ul><ul><li |
||||||
|
class="level1"><div |
||||||
<h3><a>Light Scattering</a></h3> |
class="li"> <a |
||||||
<div> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/water/TestSimpleWater.java">jme3/src/test/jme3test/water/TestSimpleWater.java</a></div></li></ul><p> <a |
||||||
|
href="http://jmonkeyengine.org/2011/01/15/new-advanced-water-effect-for-jmonkeyengine-3/#comment-609">Rendering Water as Post-Process Effect</a></p><p> <a |
||||||
<p> |
href="/wiki/lib/exe/detail.php/jme3:advanced:water-post.png?id=jme3%3Aadvanced%3Aeffects_overview"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/water-post.png?w=150&h=100" class="mediaright" align="right" alt="" width="150" height="100" /></a></p><ul><li |
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestLightScattering.java"><param name="text" value="<html><u>jme3/src/test/jme3test/post/TestLightScattering.java</u></html>"><param name="textColor" value="blue"></object> |
class="level1"><div |
||||||
</p> |
class="li"> <a |
||||||
|
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/water/TestPostWater.java">jme3/src/test/jme3test/water/TestPostWater.java</a></div></li></ul><ul><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
<h3><a>Bloom</a></h3> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/water/TestPostWaterLake.java">jme3/src/test/jme3test/water/TestPostWaterLake.java</a></div></li></ul><p> <br/></p><p> <br/></p></div><h2><a |
||||||
<div> |
name="special_effects">Special Effects</a></h2><div |
||||||
|
class="level2"><p> <a |
||||||
<p> |
href="/wiki/lib/exe/detail.php/jme3:advanced:explosion-5.png?id=jme3%3Aadvanced%3Aeffects_overview"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/explosion-5.png?w=150&h=100" class="mediaright" align="right" alt="" width="150" height="100" /></a> <a |
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestBloom.java"><param name="text" value="<html><u>jme3/src/test/jme3test/post/TestBloom.java</u></html>"><param name="textColor" value="blue"></object> |
href="/com/jme3/gde/core/docs/jme3/advanced/particle_emitters.html">Particle Emitters</a></p></div><h3><a |
||||||
</p> |
name="particlesexplosions_fire">Particles: Explosions, Fire</a></h3><div |
||||||
|
class="level3"><p> <a |
||||||
<p> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/effect/TestExplosionEffect.java">jme3/src/test/jme3test/effect/TestExplosionEffect.java</a> – debris, flame, flash, shockwave, smoke, sparks</p><p> <a |
||||||
<a href="/com/jme3/gde/core/docs/jme3/advanced/bloom_and_glow.html">Bloom and Glow</a> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/effect/TestParticleEmitter.java">jme3/src/test/jme3test/effect/TestParticleEmitter.java</a></p><p> <a |
||||||
</p> |
href="/wiki/lib/exe/detail.php/jme3:advanced:particle.png?id=jme3%3Aadvanced%3Aeffects_overview"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/particle.png?w=150&h=100" class="mediaright" align="right" alt="" width="150" height="100" /></a></p></div><h3><a |
||||||
<p> |
name="particlessmoke">Particles: Smoke</a></h3><div |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/toon-dino.png"> |
class="level3"><p> <a |
||||||
</p> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/effect/TestMovingParticle.java">jme3/src/test/jme3test/effect/TestMovingParticle.java</a></p><p> Particles can have any texture, e.g. fog, leaves, meteors, snowflakes, mosquitos</p><hr |
||||||
|
/><p> See also:</p><ul><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
<h3><a>Toon Effect</a></h3> |
href="/com/jme3/gde/core/docs/jme3/advanced/particle_emitters.html">Particle Emitters</a></div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/jme3/advanced/bloom_and_glow.html">Bloom and Glow</a></div></li><li |
||||||
|
class="level1"><div |
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestCartoonEdge.java"><param name="text" value="<html><u>jme3/src/test/jme3test/post/TestCartoonEdge.java</u></html>"><param name="textColor" value="blue"></object> |
class="li"> <a |
||||||
</p> |
href="http://www.smashingmagazine.com/2008/08/07/50-photoshop-tutorials-for-sky-and-space-effects/">http://www.smashingmagazine.com/2008/08/07/50-photoshop-tutorials-for-sky-and-space-effects/</a></div></li></ul></div> |
||||||
|
|
||||||
<p> |
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestTransparentCartoonEdge.java"><param name="text" value="<html><u>jme3/src/test/jme3test/post/TestTransparentCartoonEdge.java</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Depth of Field Blur</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/dof-blur.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestDepthOfField.java"><param name="text" value="<html><u>jme3/src/test/jme3test/post/TestDepthOfField.java</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Fog</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/post/TestFog.java"><param name="text" value="<html><u>jme3/src/test/jme3test/post/TestFog.java</u></html>"><param name="textColor" value="blue"></object> (temporary workaround, will be deprecated) |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/light-sources.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Lighting and Shadows</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestSimpleLighting.java"><param name="text" value="<html><u>jme3/src/test/jme3test/light/TestSimpleLighting.java</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestLightRadius.java"><param name="text" value="<html><u>jme3/src/test/jme3test/light/TestLightRadius.java</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/shadow.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestManyLights.java"><param name="text" value="<html><u>jme3/src/test/jme3test/light/TestManyLights.java</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestShadow.java"><param name="text" value="<html><u>jme3/src/test/jme3test/light/TestShadow.java</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/light/TestPssmShadow.java"><param name="text" value="<html><u>jme3/src/test/jme3test/light/TestPssmShadow.java</u></html>"><param name="textColor" value="blue"></object> = Parallel-Split Shadow Mapping (PSSM) |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Water</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/water.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<a href="/com/jme3/gde/core/docs/jme3/advanced/water.html">"SeaMonkey" water</a> |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/water/TestSceneWater.java"><param name="text" value="<html><u>jme3/src/test/jme3test/water/TestSceneWater.java</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/water/TestSimpleWater.java"><param name="text" value="<html><u>jme3/src/test/jme3test/water/TestSimpleWater.java</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://jmonkeyengine.org/2011/01/15/new-advanced-water-effect-for-jmonkeyengine-3/#comment-609"><param name="text" value="<html><u>Rendering Water as Post-Process Effect</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/water-post.png"> |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/water/TestPostWater.java"><param name="text" value="<html><u>jme3/src/test/jme3test/water/TestPostWater.java</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/water/TestPostWaterLake.java"><param name="text" value="<html><u>jme3/src/test/jme3test/water/TestPostWaterLake.java</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<br/> |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<br/> |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Special Effects</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/explosion-5.png"> |
|
||||||
<a href="/com/jme3/gde/core/docs/jme3/advanced/particle_emitters.html">Particle Emitters</a> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Particles: Explosions, Fire</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/effect/TestExplosionEffect.java"><param name="text" value="<html><u>jme3/src/test/jme3test/effect/TestExplosionEffect.java</u></html>"><param name="textColor" value="blue"></object> – debris, flame, flash, shockwave, smoke, sparks |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/effect/TestParticleEmitter.java"><param name="text" value="<html><u>jme3/src/test/jme3test/effect/TestParticleEmitter.java</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/particle.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Particles: Smoke</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/effect/TestMovingParticle.java"><param name="text" value="<html><u>jme3/src/test/jme3test/effect/TestMovingParticle.java</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Particles can have any texture, e.g. fog, leaves, meteors, snowflakes, mosquitos |
|
||||||
|
|
||||||
</p> |
|
||||||
<hr /> |
|
||||||
|
|
||||||
<p> |
|
||||||
See also: |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/particle_emitters.html">Particle Emitters</a></div> |
|
||||||
</li> |
|
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/bloom_and_glow.html">Bloom and Glow</a></div> |
|
||||||
</li> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.smashingmagazine.com/2008/08/07/50-photoshop-tutorials-for-sky-and-space-effects/"><param name="text" value="<html><u>http://www.smashingmagazine.com/2008/08/07/50-photoshop-tutorials-for-sky-and-space-effects/</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:effects_overview?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:effects_overview?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,185 +1,87 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Head-Up Display (HUD)</a></h1> |
name="head-up_display_hud">Head-Up Display (HUD)</a></h1><div |
||||||
<div> |
class="level1"><p> A HUD (Head-Up Display) is part of a game's visual user interface. It's an overlay that displays additional information as (typically) 2-dimensional text or icons on the screen, on top of the 3D scene.</p><p> HUDs are used to supply players with essential information about the game state.</p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Status: Score, minimap, points, stealth mode, …</div></li><li |
||||||
|
class="level1"><div |
||||||
A HUD (Head-Up Display) is part of a game's visual user interface. It's an overlay that displays additional information as (typically) 2-dimensional text or icons on the screen, on top of the 3D scene. |
class="li"> Resources: Ammunition, lives/health, time, …</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Vehicle instruments: Cockpit, speedometer, …</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
HUDs are used to supply players with essential information about the game state. |
class="li"> Navigational aides: Crosshairs, cursor, hand, …</div></li></ul><p> <a |
||||||
</p> |
href="/wiki/lib/exe/fetch.php?hash=c9f2a3&media=http%3A%2F%2Fwww.jmonkeyengine.com%2Fwp-content%2Fuploads%2F2010%2F10%2Fgrapplinghook.jpg"><img |
||||||
<ul> |
src="/wiki/lib/exe/fetch.php?hash=c9f2a3&w=256&h=192&media=http%3A%2F%2Fwww.jmonkeyengine.com%2Fwp-content%2Fuploads%2F2010%2F10%2Fgrapplinghook.jpg" class="mediaright" align="right" title="www.jmonkeyengine.com_wp-content_uploads_2010_10_grapplinghook.jpg" alt="www.jmonkeyengine.com_wp-content_uploads_2010_10_grapplinghook.jpg" width="256" height="192" /></a></p><p> Not all games have, or need a HUD. To avoid breaking the immersion and cluttering the screen, only use a HUD if it is the only way to convey certain information.</p><p> You have two options how to create HUDs.</p><ul><li |
||||||
<li><div> Status: Score, minimap, points, stealth mode, …</div> |
class="level1"><div |
||||||
</li> |
class="li"> To create full-featured user interfaces, you use Nifty <acronym |
||||||
<li><div> Resources: Ammunition, lives/health, time, …</div> |
title="Graphical User Interface">GUI</acronym>. (Recommended)</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Vehicle instruments: Cockpit, speedometer, …</div> |
class="li"> If you just quickly want to display a line of text or an icon, you use the guiNode.</div></li></ul></div><h2><a |
||||||
</li> |
name="hud_with_nifty_gui">HUD with Nifty GUI</a></h2><div |
||||||
<li><div> Navigational aides: Crosshairs, cursor, hand, …</div> |
class="level2"><p> The recommended approach to create HUDs is using Nifty <acronym |
||||||
</li> |
title="Graphical User Interface">GUI</acronym>.</p><ol><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> Lay out the <acronym |
||||||
<p> |
title="Graphical User Interface">GUI</acronym> in one or several Nifty <acronym |
||||||
|
title="Extensible Markup Language">XML</acronym> files.</div></li><li |
||||||
<img src="/wiki/lib/exe/fetch.php"> |
class="level1"><div |
||||||
</p> |
class="li"> Write the controller classes in Java.</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Load the <acronym |
||||||
Not all games have, or need a HUD. To avoid breaking the immersion and cluttering the screen, only use a HUD if it is the only way to convey certain information. |
title="Extensible Markup Language">XML</acronym> file with the controller object in your game's simpleInit() method.</div></li></ol><p> The advantage of Nifty <acronym |
||||||
</p> |
title="Graphical User Interface">GUI</acronym> is that it is well integrated into jME and the jMonkeyPlatform, and that it offers all the features that you expect from a professional modern user interface. The only small disadvantage is that you (currently still) have to lay out the interface in <acronym |
||||||
|
title="Extensible Markup Language">XML</acronym>. You can see this as an advantage too, as it enables you to edit the user interface without editing the code afterwards.</p><p> For HUDs, you Basically follow the same instructions as for creating a normal <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui.html">Nifty GUI</a>, you just don't pause the game while the HUD is up.</p></div><h2><a |
||||||
You have two options how to create HUDs. |
name="the_gui_node">The GUI Node</a></h2><div |
||||||
</p> |
class="level2"><p> Using the <acronym |
||||||
<ul> |
title="Graphical User Interface">GUI</acronym> Node is the default approach in jme3 to create very simple, static HUDs. If you just quickly want to display a line of text, or a simple icon on the screen, use this no-frills method. If you want a more advanced HUD with effects and interaction, use <a |
||||||
<li><div> To create full-featured user interfaces, you use Nifty <acronym title="Graphical User Interface">GUI</acronym>. (Recommended)</div> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui.html">Nifty GUI</a>.</p><p> Next to the rootNode for the 3-dimensional scene graph, jME3 also offers a 2-dimension (orthogonal) node, the <code>guiNode</code>. This is how you use it for HUDs:</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> If you just quickly want to display a line of text or an icon, you use the guiNode.</div> |
class="li"> Create a <acronym |
||||||
</li> |
title="Graphical User Interface">GUI</acronym> element (text or image).</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> Attach the <acronym |
||||||
</div> |
title="Graphical User Interface">GUI</acronym> element to the guiNode.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>HUD with Nifty GUI</a></h2> |
class="li"> Place the <acronym |
||||||
<div> |
title="Graphical User Interface">GUI</acronym> element in the orthogonal render queue using <code>setQueueBucket(Bucket.Gui)</code>.</div></li></ul><p> The element appears as 2-D, static element on the screen.</p><p> By default, the guiNode has some scene graph statistics attached in SimpleApplication. To clear the guiNode and attach your own <acronym |
||||||
|
title="Graphical User Interface">GUI</acronym> elements, you detach all children.</p><pre>guiNode.detachAllChildren();</pre></div><h3><a |
||||||
<p> |
name="displaying_pictures_in_the_hud">Displaying Pictures in the HUD</a></h3><div |
||||||
|
class="level3"><p> A simple image can be displayed using <code>com.jme3.ui.Picture</code>.</p><pre>Picture pic = new Picture("HUD Picture"); |
||||||
The recommended approach to create HUDs is using Nifty <acronym title="Graphical User Interface">GUI</acronym>. |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Lay out the <acronym title="Graphical User Interface">GUI</acronym> in one or several Nifty <acronym title="Extensible Markup Language">XML</acronym> files. </div> |
|
||||||
</li> |
|
||||||
<li><div> Write the controller classes in Java.</div> |
|
||||||
</li> |
|
||||||
<li><div> Load the <acronym title="Extensible Markup Language">XML</acronym> file with the controller object in your game's simpleInit() method.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The advantage of Nifty <acronym title="Graphical User Interface">GUI</acronym> is that it is well integrated into jME and the jMonkeyPlatform, and that it offers all the features that you expect from a professional modern user interface. The only small disadvantage is that you (currently still) have to lay out the interface in <acronym title="Extensible Markup Language">XML</acronym>. You can see this as an advantage too, as it enables you to edit the user interface without editing the code afterwards. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
For HUDs, you Basically follow the same instructions as for creating a normal <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui.html">Nifty GUI</a>, you just don't pause the game while the HUD is up. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>The GUI Node</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Using the <acronym title="Graphical User Interface">GUI</acronym> Node is the default approach in jme3 to create very simple, static HUDs. If you just quickly want to display a line of text, or a simple icon on the screen, use this no-frills method. If you want a more advanced HUD with effects and interaction, use <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui.html">Nifty GUI</a>. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Next to the rootNode for the 3-dimensional scene graph, jME3 also offers a 2-dimension (orthogonal) node, the <code>guiNode</code>. This is how you use it for HUDs: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Create a <acronym title="Graphical User Interface">GUI</acronym> element (text or image).</div> |
|
||||||
</li> |
|
||||||
<li><div> Attach the <acronym title="Graphical User Interface">GUI</acronym> element to the guiNode. </div> |
|
||||||
</li> |
|
||||||
<li><div> Place the <acronym title="Graphical User Interface">GUI</acronym> element in the orthogonal render queue using <code>setQueueBucket(Bucket.Gui)</code>. </div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
The element appears as 2-D, static element on the screen. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
By default, the guiNode has some scene graph statistics attached in SimpleApplication. To clear the guiNode and attach your own <acronym title="Graphical User Interface">GUI</acronym> elements, you detach all children. |
|
||||||
</p> |
|
||||||
<pre>guiNode.detachAllChildren();</pre> |
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Displaying Pictures in the HUD</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A simple image can be displayed using <code>com.jme3.ui.Picture</code>. |
|
||||||
</p> |
|
||||||
<pre>Picture pic = new Picture("HUD Picture"); |
|
||||||
pic.setImage(assetManager, "Textures/ColoredTex/Monkey.png", true); |
pic.setImage(assetManager, "Textures/ColoredTex/Monkey.png", true); |
||||||
pic.setWidth(settings.getWidth()/2); |
pic.setWidth(settings.getWidth()/2); |
||||||
pic.setHeight(settings.getHeight()/2); |
pic.setHeight(settings.getHeight()/2); |
||||||
pic.setPosition(settings.getWidth()/4, settings.getHeight()/4); |
pic.setPosition(settings.getWidth()/4, settings.getHeight()/4); |
||||||
guiNode.attachChild(pic);</pre> |
guiNode.attachChild(pic);</pre><p> When you set the last boolean in setImage() to true, the alpha channel of your image will be rendered transparent/translucent.</p></div><h3><a |
||||||
<p> |
name="displaying_text_in_the_hud">Displaying Text in the HUD</a></h3><div |
||||||
When you set the last boolean in setImage() to true, the alpha channel of your image will be rendered transparent/translucent. |
class="level3"><p> You use <code>com.jme3.font.BitmapText</code> to display text on the screen.</p><pre>BitmapText hudText = new BitmapText(guiFont, false); |
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Displaying Text in the HUD</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You use <code>com.jme3.font.BitmapText</code> to display text on the screen. |
|
||||||
</p> |
|
||||||
<pre>BitmapText hudText = new BitmapText(guiFont, false); |
|
||||||
hudText.setSize(guiFont.getCharSet().getRenderedSize()); // font size |
hudText.setSize(guiFont.getCharSet().getRenderedSize()); // font size |
||||||
hudText.setColor(ColorRGBA.Blue); // font color |
hudText.setColor(ColorRGBA.Blue); // font color |
||||||
hudText.setText("You can write any string here"); // the text |
hudText.setText("You can write any string here"); // the text |
||||||
hudText.setLocalTranslation(300, hudText.getLineHeight(), 0); // position |
hudText.setLocalTranslation(300, hudText.getLineHeight(), 0); // position |
||||||
guiNode.attachChild(hudText);</pre> |
guiNode.attachChild(hudText);</pre><p> The BitmapFont object <code>guiFont</code> is a default font provided by SimpleApplication. Copy you own fonts as .fnt+.png files into the <code>assets/Interface/Fonts</code> directory and load them like this:</p><pre>BitmapFont myFont = assetManager.loadFont("Interface/Fonts/Console.fnt"); |
||||||
<p> |
hudText = new BitmapText(myFont, false);</pre></div><h3><a |
||||||
The BitmapFont object <code>guiFont</code> is a default font provided by SimpleApplication. Copy you own fonts as .fnt+.png files into the <code>assets/Interface/Fonts</code> directory and load them like this: |
name="displaying_geometries_in_the_hud">Displaying Geometries in the HUD</a></h3><div |
||||||
</p> |
class="level3"><p> It is technically possible to attach Quads and 3D Geometries to the HUD. They show up as flat, static <acronym |
||||||
<pre>BitmapFont myFont = assetManager.loadFont("Interface/Fonts/Console.fnt"); |
title="Graphical User Interface">GUI</acronym> elements. Note that if you use a lit Material, you must add a light to the guiNode. Also remember that size units are pixels in the HUD (a 2-wu cube is displayed 2 pixels wide).</p></div><h3><a |
||||||
hudText = new BitmapText(myFont, false);</pre> |
name="positioning_hud_elements">Positioning HUD Elements</a></h3><div |
||||||
|
class="level3"><ul><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> When positioning text and images in 2D, the bottom left corner of the screen is <code>(0f,0f)</code>, and the top right corner is at <code>(settings.getWidth(),settings.getHeight())</code>.</div></li><li |
||||||
<h3><a>Displaying Geometries in the HUD</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> If you have several 2D elements in the <acronym |
||||||
|
title="Graphical User Interface">GUI</acronym> bucket that overlap, define their depth order by specifing a Z value. You can use <code>pic.move(x, y, -2)</code> or <code>hudText.setLocalTranslation(x,y,-2)</code>.</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Size and length values in the orthogonal render queue are treated like pixels. A 20*20-wu big quad is rendered 20 pixels wide.</div></li></ul></div><h3><a |
||||||
It is technically possible to attach Quads and 3D Geometries to the HUD. They show up as flat, static <acronym title="Graphical User Interface">GUI</acronym> elements. Note that if you use a lit Material, you must add a light to the guiNode. Also remember that size units are pixels in the HUD (a 2-wu cube is displayed 2 pixels wide). |
name="keeping_the_hud_up-to-date">Keeping the HUD Up-To-Date</a></h3><div |
||||||
</p> |
class="level3"><p> Use the update loop to keep the content up-to-date.</p><pre>public void simpleUpdate(float tpf) { |
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Positioning HUD Elements</a></h3> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> When positioning text and images in 2D, the bottom left corner of the screen is <code>(0f,0f)</code>, and the top right corner is at <code>(settings.getWidth(),settings.getHeight())</code>.</div> |
|
||||||
</li> |
|
||||||
<li><div> If you have several 2D elements in the <acronym title="Graphical User Interface">GUI</acronym> bucket that overlap, define their depth order by specifing a Z value. You can use <code>pic.move(x, y, -2)</code> or <code>hudText.setLocalTranslation(x,y,-2)</code>.</div> |
|
||||||
</li> |
|
||||||
<li><div> Size and length values in the orthogonal render queue are treated like pixels. A 20*20-wu big quad is rendered 20 pixels wide.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Keeping the HUD Up-To-Date</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Use the update loop to keep the content up-to-date. |
|
||||||
</p> |
|
||||||
<pre>public void simpleUpdate(float tpf) { |
|
||||||
... |
... |
||||||
hudText.setText("Score: " + score); |
hudText.setText("Score: " + score); |
||||||
... |
... |
||||||
picture.setImage(assetManager, "Interface/statechange.png", true); |
picture.setImage(assetManager, "Interface/statechange.png", true); |
||||||
... |
... |
||||||
}</pre><div><span> |
}</pre><div |
||||||
<a href="/wiki/doku.php/tag:gui?do=showtag&tag=tag%3Agui">gui</a>, |
class="tags"><span> <a |
||||||
<a href="/wiki/doku.php/tag:display?do=showtag&tag=tag%3Adisplay">display</a>, |
href="/wiki/doku.php/tag:gui?do=showtag&tag=tag%3Agui">gui</a>, <a |
||||||
<a href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a> |
href="/wiki/doku.php/tag:display?do=showtag&tag=tag%3Adisplay">display</a>, <a |
||||||
</span></div> |
href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a> </span></div></div> |
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:hud?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:hud?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,173 +1,65 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Localizing jME 3 Games</a></h1> |
name="localizing_jme_3_games">Localizing jME 3 Games</a></h1><div |
||||||
<div> |
class="level1"></div><h2><a |
||||||
|
name="scope">Scope</a></h2><div |
||||||
</div> |
class="level2"><p> Localizing an application can mean several things:</p><ul><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Scope</a></h2> |
class="li"> At minimum you translate all messages and dialogs in the user interface to your target languages.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> You should also translate the "read me", help, and other documentation.</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Also translating web content related to the application makes sure international users find out about your localized game.</div></li><li |
||||||
Localizing an application can mean several things: |
class="level1"><div |
||||||
|
class="li"> If you go the whole way of internationalization, you also "translate" metaphors in icons or symbols used. <br/> E.g. For localizations to right-to-left languages, you must also adjust the whole flow of the UI (order of menus and buttons).</div></li></ul><p> There are tools that assist you with localizing Java Swing GUIs. jME3 applications do not typically have a Swing <acronym |
||||||
</p> |
title="Graphical User Interface">GUI</acronym>, so those tools are not of much help. Just stick to the normal Java rules about using Bundle Properties:</p></div><h2><a |
||||||
<ul> |
name="preparing_the_localization">Preparing the Localization</a></h2><div |
||||||
<li><div> At minimum you translate all messages and dialogs in the user interface to your target languages.</div> |
class="level2"><p> <strong>Tip:</strong> The jMonkeyPlatform supports opening and editing Bundle.properties files. Also note the Tools > Localization menu.</p><p> To prepare the application for localization, you have to first identify all hard-coded messages.</p><ol><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> You should also translate the “read me”, help, and other documentation.</div> |
class="li"> Find every line in your jME3 game where you hard-coded message strings, e.g. <br/><pre>System.out.print("Hello World!"); |
||||||
</li> |
UiText.setText("Score: "+score);</pre></div></li><li |
||||||
<li><div> Also translating web content related to the application makes sure international users find out about your localized game.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Create one file named <code>Bundle.properties</code> in each directory where there are Java file that contain messages.</div></li><li |
||||||
<li><div> If you go the whole way of internationalization, you also “translate” metaphors in icons or symbols used. <br/> |
class="level1"><div |
||||||
E.g. For localizations to right-to-left languages, you must also adjust the whole flow of the UI (order of menus and buttons).</div> |
class="li"> For every hard-coded message, you add one line to the <code>Bundle.properties</code> file: First specify a unique key that identifies this string; then an equal sign; and the literal string itself. <br/><pre>greeting=Hello World! |
||||||
</li> |
score.display=Score: </pre></div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> In the source code, replace every occurence of a hard-coded message with the appropriate Resource Bundle call to its unique key:<pre>ResourceBundle.getBundle("Bundle").getString("greeting")); |
||||||
<p> |
UiText.setText(ResourceBundle.getBundle("Bundle").getString("score.display")+score);</pre></div></li></ol><p> The language used in the Bundle.properties files will be the default language for your game.</p></div><h2><a |
||||||
|
name="translating_the_messages">Translating the Messages</a></h2><div |
||||||
There are tools that assist you with localizing Java Swing GUIs. jME3 applications do not typically have a Swing <acronym title="Graphical User Interface">GUI</acronym>, so those tools are not of much help. Just stick to the normal Java rules about using Bundle Properties: |
class="level2"><p> Each additional language comes in a set of files that is marked with a (usually) two-letter suffix. Common locales are de for German, en for English, fr for French, ja for Japanese, pt for Portuguese, etc.</p><p> To translate the messages to another language, for example, German:</p><ol><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Make a copy of the <code>Bundle.properties</code> files.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Name the copy <code>Bundle_de.properties</code> for German. Note the added suffix _de.</div></li><li |
||||||
<h2><a>Preparing the Localization</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> Translate all strings (text on the right side of the equal sign) in the <code>Bundle_de.properties</code> to German.<pre>greeting=Hallo Welt! |
||||||
|
score.display=Spielstand: </pre><p> <strong>Important:</strong> Do not modify any of the keys (text to the left of the equal sign)!</p></div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> To test the German localization, start the application from the command line with <code>-Duser.language=de</code>. Note the parameter <code>de</code>.</div></li></ol><p> <strong>Tip:</strong> In the jMonkeyPlatform, you set this VM Option in the Project properties under Run. Here you can also save individual run configuraions for each language you want to test.</p><p> To get the full list of language suffixes use</p><pre>Locale.getISOLanguages()));</pre></div><h2><a |
||||||
<strong>Tip:</strong> The jMonkeyPlatform supports opening and editing Bundle.properties files. Also note the Tools > Localization menu. |
name="which_strings_not_to_translate">Which Strings Not to Translate</a></h2><div |
||||||
</p> |
class="level2"><p> <strong>Important:</strong> In the Bundle.properties file, do not include any strings that are asset paths, node or geometry names, input mappings, or material layers.</p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Keep material layers:<pre>mat.setTexture("ColorMap", tex);</pre></div></li><li |
||||||
To prepare the application for localization, you have to first identify all hard-coded messages. |
class="level1"><div |
||||||
|
class="li"> Keep paths:<pre>teapot = assetManager.loadModel("Models/Teapot/Teapot.obj");</pre></div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ol> |
class="li"> Keep geometry and node names:<pre>Geometry thing=new Geometry("A thing", mesh); |
||||||
<li><div> Find every line in your jME3 game where you hard-coded message strings, e.g. <br/> |
Node vehicle = new Node("Vehicle");</pre></div></li><li |
||||||
<pre>System.out.print("Hello World!"); |
class="level1"><div |
||||||
UiText.setText("Score: "+score);</pre></div> |
class="li"> Keep mappings:<pre>inputManager.addMapping("Shoot", trigger); |
||||||
</li> |
inputManager.addListener(actionListener, "Shoot");</pre></div></li></ul><p> Only localize messages and UI text!</p></div><h2><a |
||||||
<li><div> Create one file named <code>Bundle.properties</code> in each directory where there are Java file that contain messages.</div> |
name="common_localization_problems">Common Localization Problems</a></h2><div |
||||||
</li> |
class="level2"><p> Typical problems include:</p><ul><li |
||||||
<li><div> For every hard-coded message, you add one line to the <code>Bundle.properties</code> file: First specify a unique key that identifies this string; then an equal sign; and the literal string itself. <br/> |
class="level1"><div |
||||||
<pre>greeting=Hello World! |
class="li"> Localized strings will be of vastly different lengths and will totally break your UI layout. ⇒ Test every localization</div></li><li |
||||||
score.display=Score: </pre> |
class="level1"><div |
||||||
</div> |
class="li"> Strings with variable text or numbers don't work the same in different languages. ⇒ Either work in grammatical cases/numbers/gender for each language, or find a work-around.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> In the source code, replace every occurence of a hard-coded message with the appropriate Resource Bundle call to its unique key: <pre>ResourceBundle.getBundle("Bundle").getString("greeting")); |
class="li"> The localizer only sees the strings, without any context. E.g. does "Search History" mean "display the history of searches", or "search through the history"? ⇒ Use clear key labels and work closely with the localizers if they require extra info.</div></li><li |
||||||
UiText.setText(ResourceBundle.getBundle("Bundle").getString("score.display")+score);</pre></div> |
class="level1"><div |
||||||
</li> |
class="li"> Broken international characters ⇒ Make sure the files are saved with the right character encoding for the language.</div></li></ul></div><h2><a |
||||||
</ol> |
name="more_documentation">More Documentation</a></h2><div |
||||||
|
class="level2"><p> <a |
||||||
<p> |
href="http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/">http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/</a></p><p> <a |
||||||
|
href="http://sourceforge.net/apps/mediawiki/nifty-gui/index.php?title=Localisation">http://sourceforge.net/apps/mediawiki/nifty-gui/index.php?title=Localisation</a></p></div> |
||||||
The language used in the Bundle.properties files will be the default language for your game. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Translating the Messages</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Each additional language comes in a set of files that is marked with a (usually) two-letter suffix. Common locales are de for German, en for English, fr for French, ja for Japanese, pt for Portuguese, etc. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
To translate the messages to another language, for example, German: |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Make a copy of the <code>Bundle.properties</code> files.</div> |
|
||||||
</li> |
|
||||||
<li><div> Name the copy <code>Bundle_de.properties</code> for German. Note the added suffix _de.</div> |
|
||||||
</li> |
|
||||||
<li><div> Translate all strings (text on the right side of the equal sign) in the <code>Bundle_de.properties</code> to German. <pre>greeting=Hallo Welt! |
|
||||||
score.display=Spielstand: </pre> |
|
||||||
|
|
||||||
<p> |
|
||||||
<strong>Important:</strong> Do not modify any of the keys (text to the left of the equal sign)! |
|
||||||
</p> |
|
||||||
</div> |
|
||||||
</li> |
|
||||||
<li><div> To test the German localization, start the application from the command line with <code>-Duser.language=de</code>. Note the parameter <code>de</code>.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<strong>Tip:</strong> In the jMonkeyPlatform, you set this VM Option in the Project properties under Run. Here you can also save individual run configuraions for each language you want to test. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
To get the full list of language suffixes use |
|
||||||
|
|
||||||
</p> |
|
||||||
<pre>Locale.getISOLanguages()));</pre> |
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Which Strings Not to Translate</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<strong>Important:</strong> In the Bundle.properties file, do not include any strings that are asset paths, node or geometry names, input mappings, or material layers. |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Keep material layers: <pre>mat.setTexture("m_ColorMap", tex);</pre></div> |
|
||||||
</li> |
|
||||||
<li><div> Keep paths: <pre>teapot = assetManager.loadModel("Models/Teapot/Teapot.obj");</pre></div> |
|
||||||
</li> |
|
||||||
<li><div> Keep geometry and node names: <pre>Geometry thing=new Geometry("A thing", mesh); |
|
||||||
Node vehicle = new Node("Vehicle");</pre></div> |
|
||||||
</li> |
|
||||||
<li><div> Keep mappings: <pre>inputManager.addMapping("Shoot", trigger); |
|
||||||
inputManager.addListener(actionListener, "Shoot");</pre></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Only localize messages and UI text! |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Common Localization Problems</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Typical problems include: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Localized strings will be of vastly different lengths and will totally break your UI layout. ⇒ Test every localization</div> |
|
||||||
</li> |
|
||||||
<li><div> Strings with variable text or numbers don't work the same in different languages. ⇒ Either work in grammatical cases/numbers/gender for each language, or find a work-around.</div> |
|
||||||
</li> |
|
||||||
<li><div> The localizer only sees the strings, without any context. E.g. does “Search History” mean “display the history of searches”, or “search through the history”? ⇒ Use clear key labels and work closely with the localizers if they require extra info.</div> |
|
||||||
</li> |
|
||||||
<li><div> Broken international characters ⇒ Make sure the files are saved with the right character encoding for the language.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>More Documentation</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/"><param name="text" value="<html><u>http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://sourceforge.net/apps/mediawiki/nifty-gui/index.php?title=Localisation"><param name="text" value="<html><u>http://sourceforge.net/apps/mediawiki/nifty-gui/index.php?title=Localisation</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:localization?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:localization?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,127 +1,33 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Logging and Monitoring</a></h1> |
name="logging_and_monitoring">Logging and Monitoring</a></h1><div |
||||||
<div> |
class="level1"></div><h2><a |
||||||
|
name="development_phase_log_output">Development Phase Log Output</a></h2><div |
||||||
</div> |
class="level2"><p> Many developers just use System.out.println() to print diagnostic strings to the terminal. The problem with that is that before the release, you'd have to go through all your code and make certain you removed all these println() calls. You do not want your users to see them and worry about ominous strings babbling about old development diagnostics.</p><p> Instead of println(), you use the standard Java logger from <code>java.util.logging</code>. It has many advantages for professional game development:</p><ul><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Development Phase Log Output</a></h2> |
class="li"> You "tag" each message with a log level: Severe error, informative warning, etc.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> You can switch off printing of all messages up to certain log level with just one line of code.</div><ul><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> During development, you would set the log level to fine, because you want all warnings printed.</div></li><li |
||||||
Many developers just use System.out.println() to print diagnostic strings to the terminal. The problem with that is that before the release, you'd have to go through all your code and make certain you removed all these println() calls. You do not want your users to see them and worry about ominous strings babbling about old development diagnostics. |
class="level2"><div |
||||||
</p> |
class="li"> For the release, you set the log level to only report severe errors, and no informative diagnostics.</div></li></ul></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> The logger string is localizable, since it contains variables. You may want to localize all errors.</div></li></ul><p> So to print comments like a pro, you use the following logger syntax. The variables a, b, c, can be any printable Java object, e.g. <code>Vector3f a = cam.getLocation()</code>. They are numbered {0},{1},{2},etc for use in the string, in the order you put them in the Object array.</p><pre>private static final Logger logger = Logger.getLogger(HelloWorld.class.getName());</pre><p> Replace HelloWorld by the name of the class where you are using this line.</p><pre>logger.log(Level.WARNING, "ok seriously wtf somebody check why {0} is {1} again?!", |
||||||
Instead of println(), you use the standard Java logger from <code>java.util.logging</code>. It has many advantages for professional game development: |
new Object[]{a , b});</pre><p> or</p><pre>logger.log(Level.SEVERE, "Game error: {0} must not be {1} after {2}! Please check your flux generator.", |
||||||
</p> |
new Object[]{a , b , c});</pre><p> As you see in the example, you should phrase potentially "customer facing" errors in a neutral way and offer a reason and a solution. If you use WARNINGs as replacement for casual printlns, make sure you deactivate them for the release.</p><p> More details about <a |
||||||
<ul> |
href="http://download.oracle.com/javase/6/docs/api/java/util/logging/Level.html">Java log levels</a> here.</p></div><h3><a |
||||||
<li><div> You “tag” each message with a log level: Severe error, informative warning, etc.</div> |
name="switching_the_logger_on_and_off">Switching the Logger on and off</a></h3><div |
||||||
</li> |
class="level3"><p> In the release version you will deactivate the logging output to the terminal.</p><p> To deactivate the default logger, you set the log level to only report severe messages:</p><pre>Logger.getLogger(””).setLevel(Level.SEVERE);</pre><p> To reactivate it:</p><pre>Logger.getLogger(””).setLevel(Level.FINE);</pre></div><h2><a |
||||||
<li><div> You can switch off printing of all messages up to certain log level with just one line of code.</div> |
name="jmonkeyplatform_log_files">jMonkeyPlatform Log Files</a></h2><div |
||||||
<ul> |
class="level2"><p> You find the jMonkeyPlatform log file in /dev/var/log/messages.log in the jMonkeyPlatform preferences folder. You can learn the location of the preferences folder in the “About” screen of the jMonkeyPlatform under the label <strong>Userdir</strong>.</p><ul><li |
||||||
<li><div> During development, you would set the log level to fine, because you want all warnings printed.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Windows: C:\Documents and Settings\YOUR_NAME\.jmonkeyplatform\"</div></li><li |
||||||
<li><div> For the release, you set the log level to only report severe errors, and no informative diagnostics.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Linux: /home/YOUR_NAME/.jmonkeyplatform/"</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
</li> |
class="li"> Mac <acronym |
||||||
<li><div> The logger string is localizable, since it contains variables. You may want to localize all errors.</div> |
title="Operating System">OS</acronym>: <code>/Users/YOUR_NAME/Library/Application Support/jmonkeyplatform/</code></div></li></ul></div><h2><a |
||||||
</li> |
name="read_graphic_card_capabilites">Read Graphic Card Capabilites</a></h2><div |
||||||
</ul> |
class="level2"><p> You can read the graphic card's capabilities using the <code>com.jme3.renderer.Caps</code> class:</p><pre>Collection<Caps> caps = renderer.getCaps(); |
||||||
|
Logger.getLogger(HelloWorld.class.getName()).log(Level.INFO, “Caps: {0}” + caps.toString()); </pre><p> Replace HelloWorld by the name of the class where you are using this line.</p><p> The result looks like the following example:</p><pre>Caps: [FrameBuffer, FrameBufferMRT, FrameBufferMultisample, OpenGL20, ARBprogram, GLSL100, GLSL110, GLSL120, VertexTextureFetch, FloatTexture, TextureCompressionLATC]</pre><p> This would tell you that this user's graphic card only supports OpenGL 2.0 and cannot handle newer OpenGL features.</p></div> |
||||||
<p> |
|
||||||
|
|
||||||
So to print comments like a pro, you use the following logger syntax. The variables a, b, c, can be any printable Java object, e.g. <code>Vector3f a = cam.getLocation()</code>. They are numbered {0},{1},{2},etc for use in the string, in the order you put them in the Object array. |
|
||||||
</p> |
|
||||||
<pre>private static final Logger logger = Logger.getLogger(HelloWorld.class.getName());</pre> |
|
||||||
<p> |
|
||||||
|
|
||||||
Replace HelloWorld by the name of the class where you are using this line. |
|
||||||
|
|
||||||
</p> |
|
||||||
<pre>logger.log(Level.WARNING, "ok seriously wtf somebody check why {0} is {1} again?!", |
|
||||||
new Object[]{a , b});</pre> |
|
||||||
<p> |
|
||||||
|
|
||||||
or |
|
||||||
|
|
||||||
</p> |
|
||||||
<pre>logger.log(Level.SEVERE, "Game error: {0} must not be {1} after {2}! Please check your flux generator.", |
|
||||||
new Object[]{a , b , c});</pre> |
|
||||||
<p> |
|
||||||
As you see in the example, you should phrase potentially “customer facing” errors in a neutral way and offer a reason and a solution. If you use WARNINGs as replacement for casual printlns, make sure you deactivate them for the release. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
More details about <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://download.oracle.com/javase/6/docs/api/java/util/logging/Level.html"><param name="text" value="<html><u>Java log levels</u></html>"><param name="textColor" value="blue"></object> here. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Switching the Logger on and off</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
In the release version you will deactivate the logging output to the terminal. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
To deactivate the default logger, you set the log level to only report severe messages: |
|
||||||
|
|
||||||
</p> |
|
||||||
<pre>Logger.getLogger(””).setLevel(Level.SEVERE);</pre> |
|
||||||
<p> |
|
||||||
To reactivate it: |
|
||||||
|
|
||||||
</p> |
|
||||||
<pre>Logger.getLogger(””).setLevel(Level.FINE);</pre> |
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>jMonkeyPlatform Log Files</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You find the jMonkeyPlatform log file in /dev/var/log/messages.log in the jMonkeyPlatform preferences folder. You can learn the location of the preferences folder in the “About” screen of the jMonkeyPlatform under the label <strong>Userdir</strong>. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Windows: C:\Documents and Settings\YOUR_NAME\.jmonkeyplatform\”</div> |
|
||||||
</li> |
|
||||||
<li><div> Linux: /home/YOUR_NAME/.jmonkeyplatform/”</div> |
|
||||||
</li> |
|
||||||
<li><div> Mac <acronym title="Operating System">OS</acronym>: <code>/Users/YOUR_NAME/Library/Application Support/jmonkeyplatform/</code></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Read Graphic Card Capabilites</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You can read the graphic card's capabilities using the <code>com.jme3.renderer.Caps</code> class: |
|
||||||
</p> |
|
||||||
<pre>Collection<Caps> caps = renderer.getCaps(); |
|
||||||
Logger.getLogger(HelloWorld.class.getName()).log(Level.INFO, “Caps: {0}” + caps.toString()); </pre> |
|
||||||
<p> |
|
||||||
Replace HelloWorld by the name of the class where you are using this line. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
The result looks like the following example: |
|
||||||
</p> |
|
||||||
<pre> |
|
||||||
Caps: [FrameBuffer, FrameBufferMRT, FrameBufferMultisample, OpenGL20, ARBprogram, GLSL100, GLSL110, GLSL120, VertexTextureFetch, FloatTexture, TextureCompressionLATC] |
|
||||||
</pre> |
|
||||||
|
|
||||||
<p> |
|
||||||
This would tell you that this user's graphic card only supports OpenGL 2.0 and cannot handle newer OpenGL features. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:logging?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:logging?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,107 +1,56 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>How to Use Material Definitions (.j3md)</a></h1> |
name="how_to_use_material_definitions_j3md">How to Use Material Definitions (.j3md)</a></h1><div |
||||||
<div> |
class="level1"><p> Typically, you create a set of custom materials, and use them throughout the game. For example, you can initialize and configure your materials objects in the <code>initSimpleApp()</code> method, and then load 3D models (Geometries) and use setMaterial() on them.</p><p> <strong>Tip:</strong> If you use one custom material very often, additionally read about storing material configurations in user-friendly <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/advanced/j3m_material_files.html">j3m Material Files</a>.</p></div><h2><a |
||||||
<p> |
name="preparing_a_material">Preparing a Material</a></h2><div |
||||||
|
class="level2"><ol><li |
||||||
Typically, you create a set of custom materials, and use them throughout the game. For example, you can initialize and configure your materials objects in the <code>initSimpleApp()</code> method, and then load 3D models (Geometries) and use setMaterial() on them. |
class="level1"><div |
||||||
</p> |
class="li"> Choose a Material Definition from the <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a> list that has the features that you need.</div><ul><li |
||||||
<p> |
class="level2"><div |
||||||
<strong>Tip:</strong> If you use one custom material very often, additionally read about storing material configurations in user-friendly <a href="/com/jme3/gde/core/docs/jme3/advanced/j3m_material_files.html">j3m Material Files</a>. |
class="li"> Tip: If you don't know, you can always start with <code>Unshaded.j3md</code>.</div></li></ul></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Look at the applicable parameters of the Material Definition and determine which ones you need to achieve the desired effect. Most parameters are optional.</div><ol><li |
||||||
</div> |
class="level2"><div |
||||||
|
class="li"> Create and save the necessary Texture files to the assets directory.</div><ul><li |
||||||
<h2><a>Preparing a Material</a></h2> |
class="level3"><div |
||||||
<div> |
class="li"> E.g. ColorMap; DiffuseMap, NormalMap, AlphaMap, etc…</div></li></ul></li><li |
||||||
<ol> |
class="level2"><div |
||||||
<li><div> Choose a Material Definition from the <a href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a> list that has the features that you need. </div> |
class="li"> Determine the required values to achieve the effect that you want.</div><ul><li |
||||||
<ul> |
class="level3"><div |
||||||
<li><div> Tip: If you don't know, you can always start with <code>Unshaded.j3md</code>.</div> |
class="li"> E.g. Colors, floats, booleans, etc…</div></li></ul></li></ol></li></ol></div><h2><a |
||||||
</li> |
name="using_a_material">Using a Material</a></h2><div |
||||||
</ul> |
class="level2"><ol><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Look at the applicable parameters of the Material Definition and determine which ones you need to achieve the desired effect. Most parameters are optional.</div> |
class="li"> In you Java code, create a Material object based on the .j3md file: e.g.<pre>Material mat = new Material(assetManager, "Common/MatDefs/Misc/Unshaded.j3md");</pre></div></li><li |
||||||
<ol> |
class="level1"><div |
||||||
<li><div> Create and save the necessary Texture files to the assets directory.</div> |
class="li"> Configure your Material by setting the appropriate values listed in the <a |
||||||
<ul> |
href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a> table. Here are examples of the methods that set the different data types:</div><ul><li |
||||||
<li><div> E.g. ColorMap; DiffuseMap, NormalMap, AlphaMap, etc…</div> |
class="level2"><div |
||||||
</li> |
class="li"> <code>mat.setColor( "Color", ColorRGBA.White );</code></div></li><li |
||||||
</ul> |
class="level2"><div |
||||||
</li> |
class="li"> <code>mat.setTexture( "ColorMap", assetManager.loadTexture("Interface/Logo/Monkey.png" ));</code></div></li><li |
||||||
<li><div> Determine the required values to achieve the effect that you want.</div> |
class="level2"><div |
||||||
<ul> |
class="li"> <code>mat.setFloat( "Shininess", 5f);</code></div></li><li |
||||||
<li><div> E.g. Colors, floats, booleans, etc… </div> |
class="level2"><div |
||||||
</li> |
class="li"> <code>mat.setBoolean( "SphereMap", true);</code></div></li><li |
||||||
</ul> |
class="level2"><div |
||||||
</li> |
class="li"> <code>mat.setVector3( "NormalScale", new Vector3f(1f,1f,1f));</code></div></li></ul></li><li |
||||||
</ol> |
class="level1"><div |
||||||
</li> |
class="li"> Use your prepared material on a Geometry:<pre>myGeometry.setMaterial(mat);</pre></div></li><li |
||||||
</ol> |
class="level1"><div |
||||||
|
class="li"> (Optional) Adjust the texture scale:<pre>geometry.scaleTextureCoordinates(new Vector2f(1f, .5f));</pre></div></li></ol></div><h2><a |
||||||
</div> |
name="examples">Examples</a></h2><div |
||||||
|
class="level2"><p> A simpled textured material.</p><pre>Material mat = new Material(assetManager, |
||||||
<h2><a>Using a Material</a></h2> |
|
||||||
<div> |
|
||||||
<ol> |
|
||||||
<li><div> In you Java code, create a Material object based on the .j3md file: e.g. <pre>Material mat = new Material(assetManager, "Common/MatDefs/Misc/Unshaded.j3md");</pre></div> |
|
||||||
</li> |
|
||||||
<li><div> Configure your Material by setting the appropriate values listed in the <a href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a> table. Here are examples of the methods that set the different data types:</div> |
|
||||||
<ul> |
|
||||||
<li><div> <code>mat.setColor( “Color”, ColorRGBA.White );</code></div> |
|
||||||
</li> |
|
||||||
<li><div> <code>mat.setTexture( “ColorMap”, assetManager.loadTexture(“Interface/Logo/Monkey.png” ));</code></div> |
|
||||||
</li> |
|
||||||
<li><div> <code>mat.setFloat( “Shininess”, 5f);</code></div> |
|
||||||
</li> |
|
||||||
<li><div> <code>mat.setBoolean( “SphereMap”, true);</code></div> |
|
||||||
</li> |
|
||||||
<li><div> <code>mat.setVector3( “NormalScale”, new Vector3f(1f,1f,1f));</code></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> Use your prepared material on a Geometry: <pre>myGeometry.setMaterial(mat);</pre></div> |
|
||||||
</li> |
|
||||||
<li><div> (Optional) Adjust the texture scale: <pre>geometry.scaleTextureCoordinates(new Vector2f(1f, .5f));</pre></div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Examples</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A simpled textured material. |
|
||||||
|
|
||||||
</p> |
|
||||||
<pre>Material mat = new Material(assetManager, |
|
||||||
"Common/MatDefs/Misc/Unshaded.j3md"); |
"Common/MatDefs/Misc/Unshaded.j3md"); |
||||||
mat.setTexture("ColorMap", assetManager.loadTexture( |
mat.setTexture("ColorMap", assetManager.loadTexture( |
||||||
"Interface/Logo/Monkey.jpg"));</pre> |
"Interface/Logo/Monkey.jpg"));</pre><p> A textured material with a color bleeding through transparent areas.</p><pre>Material mat = new Material(assetManager, |
||||||
<p> |
|
||||||
A textured material with a color bleeding through transparent areas. |
|
||||||
|
|
||||||
</p> |
|
||||||
<pre>Material mat = new Material(assetManager, |
|
||||||
"Common/MatDefs/Misc/Unshaded.j3md"); |
"Common/MatDefs/Misc/Unshaded.j3md"); |
||||||
mat.setTexture("ColorMap", assetManager.loadTexture( |
mat.setTexture("ColorMap", assetManager.loadTexture( |
||||||
"Textures/ColoredTex/Monkey.png")); |
"Textures/ColoredTex/Monkey.png")); |
||||||
mat.setColor("Color", ColorRGBA.Blue);</pre> |
mat.setColor("Color", ColorRGBA.Blue);</pre><p> You can test these examples within the following code snippet. It creates a box and applies the material:</p><pre> Box(Vector3f.ZERO, 1, 1, 1); |
||||||
<p> |
|
||||||
You can test these examples within the following code snippet. It creates a box and applies the material: |
|
||||||
</p> |
|
||||||
<pre> Box(Vector3f.ZERO, 1, 1, 1); |
|
||||||
Geometry geom = new Geometry("Box", b); |
Geometry geom = new Geometry("Box", b); |
||||||
// ... insert Material definition... |
// ... insert Material definition... |
||||||
geom.setMaterial(mat); |
geom.setMaterial(mat); |
||||||
rootNode.attachChild(geom);</pre> |
rootNode.attachChild(geom);</pre><p> <strong>Tip:</strong> You can find these and other common code snippets in the jMonkeyPlatform Code Palette. Drag and drop them into your source code.</p></div> |
||||||
<p> |
|
||||||
<strong>Tip:</strong> You can find these and other common code snippets in the jMonkeyPlatform Code Palette. Drag and drop them into your source code. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:material_definitions?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:material_definitions?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,303 +1,146 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Materials Overview</a></h1> |
name="materials_overview">Materials Overview</a></h1><div |
||||||
<div> |
class="level1"><p> This table shows you which material definitions jME supplies by default, and how to make the most of your designer's 3D models by using material parameters. |
||||||
|
If you are looking for information about how to use these materials in code, look at <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/jme3/advanced/material_definitions.html">Material Definitions</a> and <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/advanced/j3m_material_files.html">j3M Material Files</a>. <br/> <strong>Tip:</strong> The two most commonly used materials are Lighting.j3md and Unshaded.j3md (standard materials with and without Phong illumination, respectively).</p></div><h2><a |
||||||
This table shows you which material definitions jME supplies by default, and how to make the most of your designer's 3D models by using material parameters. |
name="table_of_material_definitions">Table of Material Definitions</a></h2><div |
||||||
</p> |
class="level2"><p> Some parameters are "optional" because they are somewhat advanced. If you don't know what an option means, chances are that you are not using this feature in your textures – and you don't need to specify it. (E.g. YCoCg and LATC are image compression formats; Minnaert and WardIso are shader types.) |
||||||
|
Also note that many other parameters are optional, even if they are not explicitly marked optional. For example, it's okay to specify solely the <code>DiffuseMap</code> and <code>NormalMap</code> when using <code>Lighting.j3md</code>. You are only using a subset of what is possible, but if that's what you want, you can do that. The developer should be in contact with the designer regarding what jME features individual Materials/Textures require.</p></div><h3><a |
||||||
<p> |
name="coloring_and_standard_textures">Coloring and Standard Textures</a></h3><div |
||||||
If you are looking for information about how to use these materials in code, look at <a href="/com/jme3/gde/core/docs/jme3/advanced/material_definitions.html">Material Definitions</a> and <a href="/com/jme3/gde/core/docs/jme3/advanced/j3m_material_files.html">j3M Material Files</a>. |
class="level3"><div |
||||||
</p> |
class="table sectionedit1"><table |
||||||
|
class="inline"><tr |
||||||
</div> |
class="row0"><th |
||||||
|
class="col0 leftalign"> Material Definition</th><th |
||||||
<h2><a>Table of Material Definitions</a></h2> |
class="col1"> Usage</th><th |
||||||
<div> |
class="col2 leftalign"> Parameter : Type</th></tr><tr |
||||||
|
class="row1"><td |
||||||
<p> |
class="col0"> Common/MatDefs/Misc/Unshaded.j3md</td><td |
||||||
|
class="col1"> Standard unlit Material. Use this for simple coloring, simple texturing, simple glow, simple transparency. <br/> See also: <a |
||||||
Some parameters are “optional” because they are somewhat advanced. If you don't know what an option means, chances are that you are not using this feature in your textures – and you don't need to specify it. (E.g. YCoCg and LATC are image compression formats; Minnaert and WardIso are shader types.) |
href="/com/jme3/gde/core/docs/jme3/beginner/hello_material.html">Hello Material</a></td><td |
||||||
</p> |
class="col2"> ColorMap : Texture <br/> LightMap : Texture <br/> Color : Color <br/> VertexColor : Boolean <br/> SeparateTexCoord : Boolean <br/> GlowMap : Texture <br/> GlowColor: Color</td></tr><tr |
||||||
|
class="row2"><td |
||||||
<p> |
class="col0 leftalign"> Common/MatDefs/Misc/Sky.j3md</td><td |
||||||
Also note that many other parameters are optional, even if they are not explicitly marked optional. For example, it's okay to specify solely the <code>DiffuseMap</code> and <code>NormalMap</code> when using <code>Lighting.j3md</code>. You are only using a subset of what is possible, but if that's what you want, you can do that. The developer should be in contact with the designer regarding what jME features individual Materials/Textures require. |
class="col1"> A solid skyblue, or use with a custom SkyDome texture. <br/> See also: <a |
||||||
</p> |
href="/com/jme3/gde/core/docs/jme3/advanced/sky.html">Sky</a></td><td |
||||||
|
class="col2"> Texture : TextureCubeMap <br/> SphereMap : Boolean <br/> NormalScale : Vector3</td></tr><tr |
||||||
</div> |
class="row3"><td |
||||||
|
class="col0"> Common/MatDefs/Terrain/Terrain.j3md</td><td |
||||||
<h3><a>Coloring and Standard Textures</a></h3> |
class="col1"> Splat textures for e.g. terrains. <br/> See also: <a |
||||||
<div> |
href="/com/jme3/gde/core/docs/jme3/beginner/hello_terrain.html">Hello Terrain</a></td><td |
||||||
<table> |
class="col2"> Texture1 : Texture (red) <br/> Texture1Scale : Float <br/> Texture2 : Texture (green) <br/> Texture2Scale : Float <br/> Texture3 : Texture (blue) <br/> Texture3Scale : Float <br/> Alpha : Texture</td></tr><tr |
||||||
<tr> |
class="row4"><td |
||||||
<th> Material Definition </th><th> Usage </th><th> Parameter : Type </th> |
class="col0 leftalign"> Common/MatDefs/Misc/Particle.j3md</td><td |
||||||
</tr> |
class="col1"> Used with texture masks for particle effects, or for point sprites. <br/> The Quadratic value scales the particle for perspective view (<a |
||||||
<tr> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/core/com/jme3/effect/ParticleEmitter.java">formula</a>). <br/> Does support an optional colored glow effect. <br/> See also: <a |
||||||
<td> Common/MatDefs/Misc/Unshaded.j3md </td><td> Standard unlit Material. </td><td> ColorMap : Texture <br/> |
href="/com/jme3/gde/core/docs/jme3/beginner/hello_effects.html">Hello Effects</a></td><td |
||||||
LightMap : Texture <br/> |
class="col2"> Texture : Texture <br/> GlowMap : Texture <br/> GlowColor : Color <br/> Quadratic : Float <br/> PointSprite : Boolean</td></tr></table></div><p> <br/></p></div><h3><a |
||||||
Color : Color <br/> |
name="light_and_shadow">Light and Shadow</a></h3><div |
||||||
VertexColor : Boolean <br/> |
class="level3"><div |
||||||
SeperateTexCoord : Boolean <br/> |
class="table sectionedit2"><table |
||||||
GlowMap : Texture <br/> |
class="inline"><tr |
||||||
GlowColor: Color </td> |
class="row0"><th |
||||||
</tr> |
class="col0 leftalign"> Material Definition</th><th |
||||||
<tr> |
class="col1"> Usage</th><th |
||||||
<td> Common/MatDefs/Misc/Sky.j3md </td><td> A solid skyblue, or use with a custom SkyDome texture. <br/> |
class="col2 leftalign"> Parameters</th></tr><tr |
||||||
See also: <a href="/com/jme3/gde/core/docs/jme3/advanced/sky.html">Sky</a> </td><td> Texture : TextureCubeMap <br/> |
class="row1"><td |
||||||
SphereMap : Boolean <br/> |
class="col0 leftalign"> Common/MatDefs/Light/Lighting.j3md</td><td |
||||||
NormalScale : Vector3 </td> |
class="col1"> Standard lit material with Phong Illumination. Use this material together with DiffuseMap, SpecularMap, BumpMap (NormalMaps, ParalaxMap) textures. Supports shininess, transparency, and plain material colors (Diffuse, Ambient, Specular colors). <br/> See also: <a |
||||||
</tr> |
href="/com/jme3/gde/core/docs/jme3/beginner/hello_material.html">Hello Material</a> <br/> <strong>Note:</strong> Lit materials require a <a |
||||||
<tr> |
href="/com/jme3/gde/core/docs/jme3/advanced/light_and_shadow.html">light source</a>! Glowing materials require a <a |
||||||
<td> Common/MatDefs/Terrain/Terrain.j3md </td><td> Splat textures for e.g. terrains. <br/> |
href="/com/jme3/gde/core/docs/jme3/advanced/bloom_and_glow.html">FilterPostProcessor</a>!</td><td |
||||||
See also: <a href="/com/jme3/gde/core/docs/jme3/beginner/hello_terrain.html">Hello Terrain</a> </td><td> Texture1 : Texture (red) <br/> |
class="col2"> DiffuseMap : Texture <br/> UseAlpha<sup><a |
||||||
Texture1Scale : Float <br/> |
href="#fn__1">1)</a></sup> : Boolean <br/> NormalMap : Texture <br/> LATC<sup><a |
||||||
Texture2 : Texture (green) <br/> |
href="#fn__2">2)</a></sup> : Boolean <br/> SpecularMap : Texture <br/> Shininess : Float <br/> ParallaxMap : Texture <br/> AlphaMap : Texture <br/> AlphaDiscardThreshold: Float <br/> ColorRamp : Texture <br/> <strong>Glow (optional)</strong> <br/> GlowMap : Texture <br/> GlowColor : Color <br/> <strong>Performance and quality (optional)</strong> <br/> VertexLighting : Boolean <br/> UseVertexColor : Boolean <br/> LowQuality : Boolean <br/> HighQuality : Boolean <br/> <strong>Material Colors (optional)</strong> <br/> UseMaterialColors : Boolean <br/> Diffuse : Color <br/> Ambient : Color <br/> Specular : Color <br/> <strong>Tangent shading (optional):</strong> <br/> VTangent : Boolean <br/> Minnaert<sup><a |
||||||
Texture2Scale : Float <br/> |
href="#fn__3">3)</a></sup> : Boolean <br/> WardIso<sup><a |
||||||
Texture3 : Texture (blue) <br/> |
href="#fn__4">4)</a></sup> : Boolean</td></tr><tr |
||||||
Texture3Scale : Float <br/> |
class="row2"><td |
||||||
Alpha : Texture </td> |
class="col0">Common/MatDefs/Terrain/TerrainLighting.j3md</td><td |
||||||
</tr> |
class="col1">Same kind of splat texture as Terrain.j3md, but with shading. <br/> Requires a light source.</td><td |
||||||
<tr> |
class="col2">Color Diffuse : Color <br/> Ambient : Color <br/> Shininess : Float <br/> Specular : Color <br/> SpecularMap : Texture <br/> WardIso : Boolean <br/> useTriPlanarMapping : Boolean <br/> <strong>Texture Splat Maps</strong> <br/> DiffuseMap : Texture <br/> DiffuseMap_0_scale : Float <br/> NormalMap : Texture <br/> DiffuseMap_1 : Texture <br/> DiffuseMap_1_scale : Float <br/> NormalMap_1 : Texture <br/> DiffuseMap_2 : Texture <br/> DiffuseMap_2_scale : Float <br/> NormalMap_2 : Texture <br/> DiffuseMap_3 : Texture <br/> DiffuseMap_3_scale : Float <br/> NormalMap_3 : Texture <br/> <strong>Alpha Maps</strong> <br/> AlphaMap : Texture <br/> AlphaMap_1 : Texture <br/> AlphaMap_2 : Texture <br/> <strong>Glowing</strong> <br/> GlowMap : Texture <br/> GlowColor : Color</td></tr><tr |
||||||
<td> Common/MatDefs/Misc/Particle.j3md </td><td> Used with texture masks for particle effects, or for point sprites. <br/> |
class="row3"><td |
||||||
The Quadratic value scales the particle for perspective view (<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/core/com/jme3/effect/ParticleEmitter.java"><param name="text" value="<html><u>formula</u></html>"><param name="textColor" value="blue"></object>). <br/> |
class="col0 leftalign"> Common/MatDefs/Light/Reflection.j3md</td><td |
||||||
Does support an optional colored glow effect. <br/> |
class="col1"> Reflective glass material with environment map (CubeMap/SphereMap). <br/> Requires light source. <br/> See also: <a |
||||||
See also: <a href="/com/jme3/gde/core/docs/jme3/beginner/hello_effects.html">Hello Effects</a> </td><td> Texture : Texture <br/> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/texture/TestCubeMap.java">TestCubeMap.java</a></td><td |
||||||
GlowMap : Texture <br/> |
class="col2"> Texture : Texture <br/> SphereMap: Boolean</td></tr></table></div></div><h3><a |
||||||
GlowColor : Color <br/> |
name="testing_and_debugging">Testing and Debugging</a></h3><div |
||||||
Quadratic : Float <br/> |
class="level3"><div |
||||||
PointSprite : Boolean </td> |
class="table sectionedit3"><table |
||||||
</tr> |
class="inline"><tr |
||||||
</table> |
class="row0"><th |
||||||
<table> |
class="col0 leftalign"> Material Definition</th><th |
||||||
<tr> |
class="col1"> Usage</th><th |
||||||
<th> Deprecated Material Definition </th><th> Usage </th><th> Parameter : Type </th> |
class="col2 leftalign"> Parameters</th></tr><tr |
||||||
</tr> |
class="row1"><td |
||||||
<tr> |
class="col0 leftalign"> Common/MatDefs/Misc/ShowNormals.j3md</td><td |
||||||
<td> <em>Deprecated: use Unshaded.j3md instead</em> <br/> |
class="col1"> A color gradient calculated from the model's surface normals. You can use this built-in material to test models that have no material, or as fall-back default material.</td><td |
||||||
Common/MatDefs/Misc/SimpleTextured.j3md </td><td> Standard unlit textured Material. </td><td> ColorMap : Texture <br/> |
class="col2"> –</td></tr></table></div><p> <br/> <strong>Note:</strong> Common/MatDefs/Misc/SimpleTextured.j3md, ColoredTextured.j3md, VertexColor.j3md, Wireframe.j3md have been deprecated. Use equivalent features of Unshaded.j3md instead.</p></div><h2><a |
||||||
ShowAlpha : Boolean (optional) <br/> |
name="transparency">Transparency</a></h2><div |
||||||
Normalize : Boolean (optional) <br/> |
class="level2"><p> Most Material Definitions support an alpha channel for transparency. In an RGBA color, the last float is the alpha channel: 0.0f is transparent, 1.0f is opaque. <br/> For example: <code>mat.setColor("Color", new ColorRGBA(1,0,0,0.5f));</code> is a half-opaque red. <br/> Additionally, you must specify a blendmode:</p><div |
||||||
YCoCg<sup><a href="#fn__1">1)</a></sup> : Boolean (optional) <br/> |
class="table sectionedit4"><table |
||||||
LATC<sup><a href="#fn__2">2)</a></sup> : Boolean (optional) </td> |
class="inline"><tr |
||||||
</tr> |
class="row0"><th |
||||||
<tr> |
class="col0">Option</th><th |
||||||
<td> <em>Deprecated: use Unshaded.j3md instead</em> <br/> |
class="col1">Usage</th></tr><tr |
||||||
Common/MatDefs/Misc/ColoredTextured.j3md</td><td> Transparent texture with one solid color bleeding through transparent areas. </td><td> ColorMap : Texture <br/> |
class="row1"><td |
||||||
Color : Color </td> |
class="col0">mat.getAdditionalRenderState().setBlendMode(BlendMode.Off);</td><td |
||||||
</tr> |
class="col1">Opaque</td></tr><tr |
||||||
</table> |
class="row2"><td |
||||||
|
class="col0">mat.getAdditionalRenderState().setBlendMode(BlendMode.Alpha);</td><td |
||||||
</div> |
class="col1">Use this for normal transparency. Interpolates the background pixel with the current by using the current pixel's alpha. E.g. alpha-blended vegetation.</td></tr><tr |
||||||
|
class="row3"><td |
||||||
<h3><a>Light and Shadow</a></h3> |
class="col0">mat.getAdditionalRenderState().setBlendMode(BlendMode.Additive);</td><td |
||||||
<div> |
class="col1">Additive alpha blending adds colors in a commutative way, i.e. the result does not depend on the order of transparent layers. Adds the background pixel color with the current pixel color. E.g. particle effects that have black color as background.</td></tr><tr |
||||||
<table> |
class="row4"><td |
||||||
<tr> |
class="col0">mat.getAdditionalRenderState().setBlendMode(BlendMode.AlphaAdditive);</td><td |
||||||
<th> Material Definition </th><th> Usage </th><th> Parameters </th> |
class="col1">Same as "Additive", except first it multiplies the current pixel color by the pixel alpha. E.g. used for particle effects that have alpha as background.</td></tr><tr |
||||||
</tr> |
class="row5"><td |
||||||
<tr> |
class="col0">mat.getAdditionalRenderState().setBlendMode(BlendMode.Color);</td><td |
||||||
<td> Common/MatDefs/Light/Lighting.j3md </td><td> Standard lit material with Phong Lighting. Use with SpecularMap, BumpMap, NormalMaps textures, Shininess, etc. <br/> |
class="col1">Blends by color. Generally useless.</td></tr><tr |
||||||
Requires light source! </td><td> DiffuseMap : Texture <br/> |
class="row6"><td |
||||||
UseAlpha<sup><a href="#fn__3">3)</a></sup> : Boolean <br/> |
class="col0">mat.getAdditionalRenderState().setBlendMode(BlendMode.Modulate);</td><td |
||||||
NormalMap : Texture <br/> |
class="col1">Multiplies the background pixel by the current pixel.</td></tr><tr |
||||||
LATC<sup><a href="#fn__4">4)</a></sup> : Boolean <br/> |
class="row7"><td |
||||||
SpecularMap : Texture <br/> |
class="col0">mat.getAdditionalRenderState().setBlendMode(BlendMode.ModulateX2);</td><td |
||||||
Shininess : Float <br/> |
class="col1">Same as "Modulate", except the result is doubled.</td></tr><tr |
||||||
ParallaxMap : Texture <br/> |
class="row8"><td |
||||||
AlphaMap : Texture <br/> |
class="col0">mat.getAdditionalRenderState().setBlendMode(BlendMode.PremultAlpha);</td><td |
||||||
AlphaDiscardThreshold: Float <br/> |
class="col1">Pre-multiplied alpha blending. E.g. if the color of the object has already been multiplied by its alpha, this is used instead of "Alpha" blend mode.</td></tr><tr |
||||||
ColorRamp : Texture <br/> |
class="row9"><td |
||||||
<strong>Glow (optional)</strong> <br/> |
class="col0">mat.getAdditionalRenderState().setDepthWrite(false);</td><td |
||||||
GlowMap : Texture <br/> |
class="col1">Use this if you have several transparent objects obscuring one another. Disables writing of the pixel's depth value to the depth buffer.</td></tr><tr |
||||||
GlowColor : Color <br/> |
class="row10"><td |
||||||
<strong>Performance and quality (optional)</strong> <br/> |
class="col0">mat.getAdditionalRenderState().setAlphaFallOff(0.5f); <br/> mat.getAdditionalRenderState().setAlphaTest(true)</td><td |
||||||
VertexLighting : Boolean <br/> |
class="col1">Enables alpha test, generally used for vegetation. Works the same way as "AlphaDiscardThreshold".</td></tr></table></div><p> <br/> Also note the AlphaDiscardThreshold value for materials based on Lighting.j3md. The renderer does not render pixels whose transparancy is below the threshold.</p></div><h2><a |
||||||
UseVertexColor : Boolean <br/> |
name="material_options">Material Options</a></h2><div |
||||||
LowQuality : Boolean <br/> |
class="level2"><div |
||||||
HighQuality : Boolean <br/> |
class="table sectionedit5"><table |
||||||
<strong>Material Colors (optional)</strong> <br/> |
class="inline"><tr |
||||||
UseMaterialColors : Boolean <br/> |
class="row0"><td |
||||||
Diffuse : Color <br/> |
class="col0">mat.getAdditionalRenderState().setWireframe(true);</td><td |
||||||
Ambient : Color <br/> |
class="col1">Switch to showing the (textured) Material in wireframe mode</td></tr><tr |
||||||
Specular : Color <br/> |
class="row1"><td |
||||||
<strong>Tangent shading (optional):</strong> <br/> |
class="col0">mat.getAdditionalRenderState().setFaceCullMode(FaceCullMode.Off); <br/> mat.getAdditionalRenderState().setFaceCullMode(FaceCullMode.Front); <br/> mat.getAdditionalRenderState().setFaceCullMode(FaceCullMode.Back); <br/> mat.getAdditionalRenderState().setFaceCullMode(FaceCullMode.FrontAndBack)</td><td |
||||||
VTangent : Boolean <br/> |
class="col1">Activate back- or frontface culling, both (=invisible), or off. Backface culling is activated by default as an optimization.</td></tr><tr |
||||||
Minnaert<sup><a href="#fn__5">5)</a></sup> : Boolean <br/> |
class="row2"><td |
||||||
WardIso<sup><a href="#fn__6">6)</a></sup> : Boolean </td> |
class="col0">mat.getAdditionalRenderState().setColorWrite(false);</td><td |
||||||
</tr> |
class="col1">Disable writing the color of pixels. Use this together with setDepthWrite(true) to write pixels only to the depth buffer for example.</td></tr><tr |
||||||
<tr> |
class="row3"><td |
||||||
<td>Common/MatDefs/Terrain/TerrainLighting.j3md</td><td>Same kind of splat texture as Terrain.j3md, but with shading. <br/> |
class="col0">mat.getAdditionalRenderState().setPointSprite(true);</td><td |
||||||
Requires a light source.</td><td>Color Diffuse : Color <br/> |
class="col1">Enables point-sprite mode, so meshes with "Mode.Points" will be rendered as textured sprites. Note that gl_PointCoord must be set in the shader. Point sprites are used for hardware accelerated particle effects.</td></tr><tr |
||||||
Ambient : Color <br/> |
class="row4"><td |
||||||
Shininess : Float <br/> |
class="col0">mat.getAdditionalRenderState().setPolyOffset();</td><td |
||||||
Specular : Color <br/> |
class="col1">Enable polygon offset. Use this when you have meshes that have triangles really close to each over (e.g. <a |
||||||
SpecularMap : Texture <br/> |
href="http://en.wikipedia.org/wiki/Coplanarity">Coplanar</a>), it will shift the depth values to prevent <a |
||||||
WardIso : Boolean <br/> |
href="http://en.wikipedia.org/wiki/Z-fighting">Z-fighting</a>.</td></tr></table></div></div><div |
||||||
useTriPlanarMapping : Boolean <br/> |
class="footnotes"><div |
||||||
<strong>Texture Splat Maps</strong> <br/> |
class="fn"><sup><a |
||||||
DiffuseMap : Texture <br/> |
href="#fnt__1">1)</a></sup> UseAlpha specifies whether DiffuseMap uses the alpha channel</div><div |
||||||
DiffuseMap_0_scale : Float <br/> |
class="fn"><sup><a |
||||||
NormalMap : Texture <br/> |
href="#fnt__2">2)</a></sup> LATC Specifies whether NormalMap is BC5/ATI2n/LATC/3Dc-compressed</div><div |
||||||
DiffuseMap_1 : Texture <br/> |
class="fn"><sup><a |
||||||
DiffuseMap_1_scale : Float <br/> |
href="#fnt__3">3)</a></sup> Minnaert is a shader type.</div><div |
||||||
NormalMap_1 : Texture <br/> |
class="fn"><sup><a |
||||||
DiffuseMap_2 : Texture <br/> |
href="#fnt__4">4)</a></sup> WardIso is a shader type.</div></div> |
||||||
DiffuseMap_2_scale : Float <br/> |
|
||||||
NormalMap_2 : Texture <br/> |
|
||||||
DiffuseMap_3 : Texture <br/> |
|
||||||
DiffuseMap_3_scale : Float <br/> |
|
||||||
NormalMap_3 : Texture <br/> |
|
||||||
<strong>Alpha Maps</strong> <br/> |
|
||||||
AlphaMap : Texture <br/> |
|
||||||
AlphaMap_1 : Texture <br/> |
|
||||||
AlphaMap_2 : Texture <br/> |
|
||||||
<strong>Glowing</strong> <br/> |
|
||||||
GlowMap : Texture <br/> |
|
||||||
GlowColor : Color </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td> Common/MatDefs/Light/Reflection.j3md </td><td> Reflective glass material with environment map (CubeMap/SphereMap). <br/> |
|
||||||
Requires light source. <br/> |
|
||||||
See also: <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/texture/TestCubeMap.java"><param name="text" value="<html><u>TestCubeMap.java</u></html>"><param name="textColor" value="blue"></object> </td><td> Texture : Texture <br/> |
|
||||||
SphereMap: Boolean </td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Testing and Debugging</a></h3> |
|
||||||
<div> |
|
||||||
<table> |
|
||||||
<tr> |
|
||||||
<th> Material Definition </th><th> Usage </th><th> Parameters </th> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td> Common/MatDefs/Misc/VertexColor.j3md </td><td> Every vertex gets a solid color, colors of mesh faces are interpolated. </td><td> – </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td> Common/MatDefs/Misc/ShowNormals.j3md </td><td> A color gradient calculated from surface normals. </td><td> – </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td> Common/MatDefs/Misc/Wireframe.j3md </td><td> Transparent wireframe outline. </td><td> Color : Color </td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Transparency</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Most Material Definitions support an alpha channel for transparency. In an RGBA color, the last float is the alpha value, whereas 0.0f = transparent, 1.0f = opaque. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
For example: <code>mat.setColor(“Color”, new ColorRGBA(1,0,0,0.5f));</code> is a half-opaque red. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Additionally, specify a blendmode: |
|
||||||
|
|
||||||
</p> |
|
||||||
<table> |
|
||||||
<tr> |
|
||||||
<th>Option</th><th>Usage</th> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setBlendMode(BlendMode.Off);</td><td>Opaque</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setBlendMode(BlendMode.Alpha);</td><td>Use this for normal transparency. Interpolates the background pixel with the current by using the current pixel's alpha. E.g. alpha-blended vegetation. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setBlendMode(BlendMode.Additive);</td><td>Additive alpha blending adds colors in a commutative way, i.e. the result does not depend on the order of transparent layers. Adds the background pixel color with the current pixel color. E.g. particle effects that have black color as background. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setBlendMode(BlendMode.AlphaAdditive);</td><td>Same as “Additive”, except first it multiplies the current pixel color by the pixel alpha. E.g. used for particle effects that have alpha as background. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setBlendMode(BlendMode.Color);</td><td>Blends by color. Generally useless.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setBlendMode(BlendMode.Modulate);</td><td>Multiplies the background pixel by the current pixel.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setBlendMode(BlendMode.ModulateX2);</td><td>Same as “Modulate”, except the result is doubled.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setBlendMode(BlendMode.PremultAlpha);</td><td>Pre-multiplied alpha blending. E.g. if the color of the object has already been multiplied by its alpha, this is used instead of “Alpha” blend mode. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setDepthWrite(false);</td><td>Use this if you have several transparent objects obscuring one another. Disables writing of the pixel's depth value to the depth buffer. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setAlphaFallOff(0.5f); <br/> |
|
||||||
mat.getAdditionalRenderState().setAlphaTest(true)</td><td>Enables alpha test, generally used for vegetation. Works the same way as “AlphaDiscardThreshold”.</td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Also note the AlphaDiscardThreshold value for materials based on Lighting.j3md. The renderer does not render pixels whose transparancy is below the threshold. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Material Options</a></h2> |
|
||||||
<div> |
|
||||||
<table> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setWireframe(true);</td><td>Switch to showing the (textured) Material in wireframe mode</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setFaceCullMode(FaceCullMode.Off); <br/> |
|
||||||
mat.getAdditionalRenderState().setFaceCullMode(FaceCullMode.Front); <br/> |
|
||||||
mat.getAdditionalRenderState().setFaceCullMode(FaceCullMode.Back); <br/> |
|
||||||
mat.getAdditionalRenderState().setFaceCullMode(FaceCullMode.FrontAndBack)</td><td>Activate back- or frontface culling, both (=invisible), or off. Backface culling is activated by default as an optimization.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setColorWrite(false);</td><td>Disable writing the color of pixels. Use this together with setDepthWrite(true) to write pixels only to the depth buffer for example. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setPointSprite(true);</td><td>Enables point-sprite mode, so meshes with “Mode.Points” will be rendered as textured sprites. Note that gl_PointCoord must be set in the shader. Point sprites are used for hardware accelerated particle effects. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>mat.getAdditionalRenderState().setPolyOffset();</td><td>Enable polygon offset. Use this when you have meshes that have triangles really close to each over (e.g. <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://en.wikipedia.org/wiki/Coplanarity"><param name="text" value="<html><u>Coplanar</u></html>"><param name="textColor" value="blue"></object>), it will shift the depth values to prevent <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://en.wikipedia.org/wiki/Z-fighting"><param name="text" value="<html><u>Z-fighting</u></html>"><param name="textColor" value="blue"></object>.</td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Internal Use Only</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You may also come across to mentions of the following Material Definition files, but they are only used internally. |
|
||||||
</p> |
|
||||||
<pre> |
|
||||||
Common/MatDefs/Blur/HGaussianBlur.j3md, VGaussianBlur.j3md, RadialBlur.j3md |
|
||||||
Common/MatDefs/Light/LightScattering.j3md, Deferred.j3md |
|
||||||
Common/MatDefs/Shadow/PreShadow.j3md, PostShadow.j3md, PostShadowPSSM.j3md |
|
||||||
Common/MatDefs/SSAO/normal.j3md, ssao.j3md |
|
||||||
Common/MatDefs/Gui/Gui.j3md |
|
||||||
Common/MatDefs/Hdr/LogLum.j3md, ToneMap.j3md</pre> |
|
||||||
|
|
||||||
</div> |
|
||||||
<div> |
|
||||||
<div><sup><a href="#fnt__1">1)</a></sup> |
|
||||||
YCoCg is an image compression format.</div> |
|
||||||
<div><sup><a href="#fnt__2">2)</a></sup> |
|
||||||
LATC is an image compression format.</div> |
|
||||||
<div><sup><a href="#fnt__3">3)</a></sup> |
|
||||||
UseAlpha specifies whether DiffuseMap uses the alpha channel</div> |
|
||||||
<div><sup><a href="#fnt__4">4)</a></sup> |
|
||||||
LATC Specifies whether NormalMap is BC5/ATI2n/LATC/3Dc-compressed</div> |
|
||||||
<div><sup><a href="#fnt__5">5)</a></sup> |
|
||||||
Minnaert is a shader type.</div> |
|
||||||
<div><sup><a href="#fnt__6">6)</a></sup> |
|
||||||
WardIso is a shader type.</div> |
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:materials_overview?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:materials_overview?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,163 +1,129 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Polygon Meshes</a></h1> |
name="polygon_meshes">Polygon Meshes</a></h1><div |
||||||
<div> |
class="level1"><p> <a |
||||||
|
href="/wiki/lib/exe/detail.php/jme3:dolphin-mesh.png?id=jme3%3Aadvanced%3Amesh"><img |
||||||
<p> |
src="nbdocs:/com/jme3/gde/core/docs/jme3/dolphin-mesh.png" class="mediaright" align="right" alt="" /></a></p><p> All visible game elements in a scene, whether it is a Model or a Shape, are made up of polygon meshes. JME3 has a com.jme3.scene.Mesh class that represents all meshes.</p><ul><li |
||||||
|
class="level1"><div |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/dolphin-mesh.png"> |
class="li"> Meshes are made up of triangles. <br/> <code>getTriangleCount(…)</code> and <code>getTriangle(…)</code></div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Each mesh has a unique ID <br/> <code>getId()</code></div></li><li |
||||||
<p> |
class="level1"><div |
||||||
All visible game elements in a scene, whether it is a Model or a Shape, are made up of polygon meshes. JME3 has a com.jme3.scene.Mesh class that represents all meshes. |
class="li"> Meshes have transformations: Location (local translation), rotation, scale.</div></li><li |
||||||
|
class="level1"><div |
||||||
</p> |
class="li"> Meshes have a bounding volume. jME3 can detect intersections (that is, non-physical collisions) between meshes, or between meshes and 2D elements such as rays. <br/> <code>collideWith()</code>.</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Meshes are made up of triangles. <br/> |
class="li"> Meshes are locked with <code>setStatic()</code> and unlocked with <code>setDynamic()</code>.</div><ul><li |
||||||
<code>getTriangleCount(…)</code> and <code>getTriangle(…)</code></div> |
class="level2"><div |
||||||
</li> |
class="li"> Static Meshes cannot be modified, but are more optimized and faster (they can be precalculated).</div></li><li |
||||||
<li><div> Each mesh has a unique ID <br/> |
class="level2"><div |
||||||
<code>getId()</code></div> |
class="li"> Dynamic Meshes can be modified live, but are not optimized and slower.</div></li></ul></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Meshes have transformations: Location (local translation), rotation, scale.</div> |
class="li"> (Optional) Meshes can have a LOD (level of detail optimization) that renders more or less details depending on distance from the camera.</div></li></ul><p> You can use default <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/advanced/shape.html">Shape</a>s as meshes; load <a |
||||||
<li><div> Meshes have a bounding volume. jME3 can detect intersections (that is, non-physical collisions) between meshes, or between meshes and 2D elements such as rays. <br/> |
href="/com/jme3/gde/core/docs/jme3/advanced/3d_models.html">3D models</a> (i.e. meshes created in external applications); or create free-form <a |
||||||
<code>collideWith()</code>.</div> |
href="/com/jme3/gde/core/docs/jme3/advanced/custom_meshes.html">custom meshes</a> programmatically.</p></div><h2><a |
||||||
</li> |
name="vertex_buffer">Vertex Buffer</a></h2><div |
||||||
<li><div> Meshes are locked with <code>setStatic()</code> and unlocked with <code>setDynamic()</code>. </div> |
class="level2"><p> The VertexBuffer contains a particular type of geometry data used by Meshes. Every VertexBuffer set on a Mesh is sent as an attribute to the vertex shader to be processed.</p><div |
||||||
<ul> |
class="table sectionedit1"><table |
||||||
<li><div> Static Meshes cannot be modified, but are more optimized and faster (they can be precalculated). </div> |
class="inline"><tr |
||||||
</li> |
class="row0"><th |
||||||
<li><div> Dynamic Meshes can be modified live, but are not optimized and slower. </div> |
class="col0">Vertex Buffer Type</th><th |
||||||
</li> |
class="col1">Description</th></tr><tr |
||||||
</ul> |
class="row1"><td |
||||||
</li> |
class="col0">Type.Position</td><td |
||||||
<li><div> (Optional) Meshes can have a LOD (level of detail optimization) that renders more or less details depending on distance from the camera.</div> |
class="col1">Position of the vertex (3 floats)</td></tr><tr |
||||||
</li> |
class="row2"><td |
||||||
</ul> |
class="col0">Type.Index</td><td |
||||||
|
class="col1"> Specifies the index buffer, must contain integer data.</td></tr><tr |
||||||
<p> |
class="row3"><td |
||||||
|
class="col0">Type.TexCoord</td><td |
||||||
You can use default <a href="/com/jme3/gde/core/docs/jme3/advanced/shape.html">Shape</a>s as meshes; load <a href="/com/jme3/gde/core/docs/jme3/advanced/3d_models.html">3D models</a> (i.e. meshes created in external applications); or create free-form <a href="/com/jme3/gde/core/docs/jme3/advanced/custom_meshes.html">custom meshes</a> programmatically. |
class="col1"> Texture coordinate</td></tr><tr |
||||||
</p> |
class="row4"><td |
||||||
|
class="col0">Type.TexCoord2</td><td |
||||||
</div> |
class="col1"> Texture coordinate #2</td></tr><tr |
||||||
|
class="row5"><td |
||||||
<h2><a>Vertex Buffer</a></h2> |
class="col0">Type.Normal</td><td |
||||||
<div> |
class="col1"> Normal vector, normalized.</td></tr><tr |
||||||
|
class="row6"><td |
||||||
<p> |
class="col0">Type.Tangent</td><td |
||||||
|
class="col1"> Tangent vector, normalized.</td></tr><tr |
||||||
The VertexBuffer contains a particular type of geometry data used by Meshes. Every VertexBuffer set on a Mesh is sent as an attribute to the vertex shader to be processed. |
class="row7"><td |
||||||
|
class="col0">Type.Binormal</td><td |
||||||
</p> |
class="col1"> Binormal vector, normalized.</td></tr><tr |
||||||
<table> |
class="row8"><td |
||||||
<tr> |
class="col0">Type.Color</td><td |
||||||
<th>Vertex Buffer Type</th><th>Description</th> |
class="col1"> Color and Alpha (4 floats)</td></tr><tr |
||||||
</tr> |
class="row9"><td |
||||||
<tr> |
class="col0">Type.Size</td><td |
||||||
<td>Type.Position </td><td>Position of the vertex (3 floats)</td> |
class="col1">The size of the point when using point buffers.</td></tr><tr |
||||||
</tr> |
class="row10"><td |
||||||
<tr> |
class="col0">Type.InterleavedData</td><td |
||||||
<td>Type.Index </td><td> Specifies the index buffer, must contain integer data.</td> |
class="col1"> Specifies the source data for various vertex buffers when interleaving is used.</td></tr><tr |
||||||
</tr> |
class="row11"><td |
||||||
<tr> |
class="col0">Type.BindPosePosition</td><td |
||||||
<td>Type.TexCoord </td><td> Texture coordinate</td> |
class="col1"> Inital vertex position, used with animation.</td></tr><tr |
||||||
</tr> |
class="row12"><td |
||||||
<tr> |
class="col0">Type.BindPoseNormal</td><td |
||||||
<td>Type.TexCoord2 </td><td> Texture coordinate #2</td> |
class="col1"> Inital vertex normals, used with animation</td></tr><tr |
||||||
</tr> |
class="row13"><td |
||||||
<tr> |
class="col0">Type.BoneWeight</td><td |
||||||
<td>Type.Normal </td><td> Normal vector, normalized.</td> |
class="col1"> Bone weights, used with animation</td></tr><tr |
||||||
</tr> |
class="row14"><td |
||||||
<tr> |
class="col0">Type.BoneIndex</td><td |
||||||
<td>Type.Tangent </td><td> Tangent vector, normalized.</td> |
class="col1"> Bone indices, used with animation</td></tr></table></div><div |
||||||
</tr> |
class="table sectionedit2"><table |
||||||
<tr> |
class="inline"><tr |
||||||
<td>Type.Binormal </td><td> Binormal vector, normalized.</td> |
class="row0"><th |
||||||
</tr> |
class="col0">Mesh method</th><th |
||||||
<tr> |
class="col1">Description</th></tr><tr |
||||||
<td>Type.Color </td><td> Color and Alpha (4 floats)</td> |
class="row1"><td |
||||||
</tr> |
class="col0" colspan="2">setLineWidth(1)</td></tr><tr |
||||||
<tr> |
class="row2"><td |
||||||
<td>Type.Size </td><td>The size of the point when using point buffers.</td> |
class="col0" colspan="2">setPointSize(4.0f)</td></tr><tr |
||||||
</tr> |
class="row3"><td |
||||||
<tr> |
class="col0" colspan="2">setBound(boundingVolume)</td></tr><tr |
||||||
<td>Type.InterleavedData </td><td> Specifies the source data for various vertex buffers when interleaving is used.</td> |
class="row4"><td |
||||||
</tr> |
class="col0">setStatic()</td><td |
||||||
<tr> |
class="col1">Locks the mesh so you cannot modify it anymore, thus optimizing its data (faster).</td></tr><tr |
||||||
<td>Type.BindPosePosition </td><td> Inital vertex position, used with animation.</td> |
class="row5"><td |
||||||
</tr> |
class="col0">setDynamic()</td><td |
||||||
<tr> |
class="col1">Unlocks the mesh so you can modified it, but this will un-optimize the data (slower).</td></tr><tr |
||||||
<td>Type.BindPoseNormal </td><td> Inital vertex normals, used with animation</td> |
class="row6"><td |
||||||
</tr> |
class="col0">setMode(Mesh.Mode.Points)</td><td |
||||||
<tr> |
class="col1"> Used to set mesh modes, see below</td></tr><tr |
||||||
<td>Type.BoneWeight </td><td> Bone weights, used with animation</td> |
class="row7"><td |
||||||
</tr> |
class="col0" colspan="2">getId()</td></tr><tr |
||||||
<tr> |
class="row8"><td |
||||||
<td>Type.BoneIndex </td><td> Bone indices, used with animation</td> |
class="col0" colspan="2">getTriangle(int,tri)</td></tr><tr |
||||||
</tr> |
class="row9"><td |
||||||
</table> |
class="col0" colspan="2">scaleTextureCoordinates(Vector2f)</td></tr></table></div><div |
||||||
<table> |
class="table sectionedit3"><table |
||||||
<tr> |
class="inline"><tr |
||||||
<th>Mesh method</th><th>Description</th> |
class="row0"><th |
||||||
</tr> |
class="col0">Mesh Mode</th><th |
||||||
<tr> |
class="col1">Description</th></tr><tr |
||||||
<td>setLineWidth(1)</td> |
class="row1"><td |
||||||
</tr> |
class="col0">Mesh.Mode.Points</td><td |
||||||
<tr> |
class="col1">Show only corner points</td></tr><tr |
||||||
<td>setPointSize(4.0f)</td> |
class="row2"><td |
||||||
</tr> |
class="col0">Mesh.Mode.Lines</td><td |
||||||
<tr> |
class="col1">Show lines</td></tr><tr |
||||||
<td>setBound(boundingVolume)</td> |
class="row3"><td |
||||||
</tr> |
class="col0">Mesh.Mode.LineLoop</td><td |
||||||
<tr> |
class="col1">?</td></tr><tr |
||||||
<td>setStatic()</td><td>Locks the mesh so you cannot modify it anymore, thus optimizing its data (faster).</td> |
class="row4"><td |
||||||
</tr> |
class="col0">Mesh.Mode.LineStrip</td><td |
||||||
<tr> |
class="col1">?</td></tr><tr |
||||||
<td>setDynamic()</td><td>Unlocks the mesh so you can modified it, but this will un-optimize the data (slower).</td> |
class="row5"><td |
||||||
</tr> |
class="col0">Mesh.Mode.Triangles</td><td |
||||||
<tr> |
class="col1">?</td></tr><tr |
||||||
<td>setMode(Mesh.Mode.Points)</td><td> Used to set mesh modes, see below</td> |
class="row6"><td |
||||||
</tr> |
class="col0">Mesh.Mode.TriangleStrip</td><td |
||||||
<tr> |
class="col1">?</td></tr><tr |
||||||
<td>getId()</td> |
class="row7"><td |
||||||
</tr> |
class="col0">Mesh.Mode.TriangleFan</td><td |
||||||
<tr> |
class="col1">?</td></tr><tr |
||||||
<td>getTriangle(int,tri)</td> |
class="row8"><td |
||||||
</tr> |
class="col0">Mesh.Mode.Hybrid</td><td |
||||||
<tr> |
class="col1">?</td></tr></table></div></div> |
||||||
<td>scaleTextureCoordinates(Vector2f)</td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
<table> |
|
||||||
<tr> |
|
||||||
<th>Mesh Mode</th><th>Description</th> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Mesh.Mode.Points</td><td>Show only corner points</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Mesh.Mode.Lines</td><td>Show lines</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Mesh.Mode.LineLoop</td><td>?</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Mesh.Mode.LineStrip</td><td>?</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Mesh.Mode.Triangles</td><td>?</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Mesh.Mode.TriangleStrip</td><td>?</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Mesh.Mode.TriangleFan</td><td>?</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Mesh.Mode.Hybrid</td><td>?</td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:mesh?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:mesh?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,36 +1,12 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Motion path</a></h1> |
name="motion_path">Motion path</a></h1><div |
||||||
<div> |
class="level1"><p> When creating cinematics, we need a convenient way of making objects follow a path, or making smooth camera travelings. |
||||||
|
That's where the MotionPath come in handy.</p></div><h2><a |
||||||
<p> |
name="description">Description</a></h2><div |
||||||
|
class="level2"><p> The MotionPath is a control over a Spatial object. that means that it's able to update the Spatial position on each frame.<br/> It contains a list of way points that are positions in world space that determine the general shape of the path.<br/> The accurate shape is computed using a linear interpolation or a <a |
||||||
When creating cinematics, we need a convenient way of making objects follow a path, or making smooth camera travelings. |
href="http://www.mvps.org/directx/articles/catmull/">Catmull-Rom</a> spline interpolation.</p><ul><li |
||||||
That's where the MotionPath come in handy. |
class="level1"><div |
||||||
</p> |
class="li"> Linear interpolation result in straight segments between the way points.</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Catmull-Rom splines allow to create a very smooth path with few way points, ensure that the curve goes through each way point, with the possibility to adjust the tension of the curve. This is the interpolation you are going to use in most cases</div></li></ul><p> more to come…</p></div> |
||||||
|
|
||||||
<h2><a>Description</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
The MotionPath is a control over a Spatial object. that means that it's able to update the Spatial position on each frame.<br/> |
|
||||||
|
|
||||||
It contains a list of way points that are positions in world space that determine the general shape of the path.<br/> |
|
||||||
|
|
||||||
The accurate shape is computed using a linear interpolation or a <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.mvps.org/directx/articles/catmull/"><param name="text" value="<html><u>Catmull-Rom</u></html>"><param name="textColor" value="blue"></object> spline interpolation. |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Linear interpolation result in straight segments between the way points.</div> |
|
||||||
</li> |
|
||||||
<li><div> Catmull-Rom splines allow to create a very smooth path with few way points, ensure that the curve goes through each way point, with the possibility to adjust the tension of the curve. This is the interpolation you are going to use in most cases</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
more to come… |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:motion_path?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:motion_path?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,184 +1,136 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Interacting with the GUI from Java</a></h1> |
name="interacting_with_the_gui_from_java">Interacting with the GUI from Java</a></h1><div |
||||||
<div> |
class="level1"><ol><li |
||||||
<ol> |
class="level1"><div |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html">Nifty GUI XML Layout</a> </div> |
class="li"> <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html">Nifty GUI XML Layout</a></div></li><li |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_overlay.html">Nifty GUI Overlay</a> or <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_projection.html">Nifty GUI Projection</a></div> |
class="level1"><div |
||||||
</li> |
class="li"> <a |
||||||
<li><div> <strong>Nifty <acronym title="Graphical User Interface">GUI</acronym> Java Interaction</strong></div> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_overlay.html">Nifty GUI Overlay</a> or <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_projection.html">Nifty GUI Projection</a></div></li><li |
||||||
</ol> |
class="level1"><div |
||||||
|
class="li"> <strong>Nifty <acronym |
||||||
<p> |
title="Graphical User Interface">GUI</acronym> Java Interaction</strong></div></li></ol><p> The main purpose of the <acronym |
||||||
|
title="Graphical User Interface">GUI</acronym> is to send events back to your Java class that indicate what the users clicked, which settings they chose, which values they entered into a field, etc. In the Java class, you want to respond with an appropriate action, or store the entered settings in a file, etc.</p></div><h2><a |
||||||
The main purpose of the <acronym title="Graphical User Interface">GUI</acronym> is to send events back to your Java class that indicate what the users clicked, which settings they chose, which values they entered into a field, etc. In the Java class, you want to respond with an appropriate action, or store the entered settings in a file, etc. |
name="connect_gui_to_java_controller">Connect GUI to Java Controller</a></h2><div |
||||||
</p> |
class="level2"><p> How does the <acronym |
||||||
|
title="Extensible Markup Language">XML</acronym> file send a message back to your Java application? You register a ScreenController (a Java class) to every NiftyGUI screen. |
||||||
</div> |
Create a ScreenController by creating a Java class that implements the <code>de.lessvoid.nifty.screen.ScreenController</code> interface and its abtract methods.</p><pre>package my.game; |
||||||
|
|
||||||
<h2><a>Connect GUI to Java Controller</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
How does the <acronym title="Extensible Markup Language">XML</acronym> file send a message back to your Java application? You register a ScreenController (a Java class) to every NiftyGUI screen. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Create a ScreenController by creating a Java class that implements the <code>de.lessvoid.nifty.screen.ScreenController</code> interface and its abtract methods. |
|
||||||
</p> |
|
||||||
<pre>package my.game; |
|
||||||
import de.lessvoid.nifty.Nifty; |
import de.lessvoid.nifty.Nifty; |
||||||
import de.lessvoid.nifty.screen.Screen; |
import de.lessvoid.nifty.screen.Screen; |
||||||
import de.lessvoid.nifty.screen.ScreenController; |
import de.lessvoid.nifty.screen.ScreenController; |
||||||
|
|
||||||
public class MySettingsScreen implements ScreenController { |
public class MySettingsScreen implements ScreenController { |
||||||
|
public MySettingsScreen(MyGameData data ){ /** constructor */ } |
||||||
public void bind(Nifty nifty, Screen screen) { } |
public void bind(Nifty nifty, Screen screen) { } |
||||||
|
|
||||||
public void onStartScreen() { } |
public void onStartScreen() { } |
||||||
|
|
||||||
public void onEndScreen() { } |
public void onEndScreen() { } |
||||||
}</pre> |
}</pre><p> The name and package of your custom ScreenController class (here <code>my.game.MySettingsScreen</code>) goes into the controller parameter of the respective screen it belongs to:</p><pre><span><span><nifty></span></span> |
||||||
<p> |
|
||||||
The name and package of your custom ScreenController class (here <code>my.game.MySettingsScreen</code>) goes into the controller parameter of the respective screen it belongs to: |
|
||||||
</p> |
|
||||||
<pre><span><span><nifty></span></span> |
|
||||||
<span><screen id="settings" controller="my.game.MySettingsScreen"></span> |
<span><screen id="settings" controller="my.game.MySettingsScreen"></span> |
||||||
<!-- layer and panel code ... --> |
<!-- layer and panel code ... --> |
||||||
<span><span></screen></span></span> |
<span><span></screen></span></span> |
||||||
<span><span></nifty></span></span></pre> |
<span><span></nifty></span></span></pre><p> Now the Java class <code>my.game.MySettingsScreen</code> and this <acronym |
||||||
<p> |
title="Graphical User Interface">GUI</acronym> screen (<code>settings</code>) are connected.</p></div><h2><a |
||||||
Now the Java class <code>my.game.MySettingsScreen</code> and this <acronym title="Graphical User Interface">GUI</acronym> screen (<code>settings</code>) are connected. |
name="make_gui_and_java_interact">Make GUI and Java Interact</a></h2><div |
||||||
</p> |
class="level2"><p> In most cases, you will want to pass game data in and out of the ScreenController. Note that you can pass any arguments into your ScreenController constructor. In the example above, the object with the necessary data is is <code>MyGameData data</code>. |
||||||
|
You can use any of the three following approaches to make Java classes interact with the <acronym |
||||||
</div> |
title="Graphical User Interface">GUI</acronym>, and you can also combine them, depending on what you want to do.</p></div><h3><a |
||||||
|
name="gui_calls_a_void_java_method">GUI Calls a Void Java Method</a></h3><div |
||||||
<h2><a>Make GUI and Java Interact</a></h2> |
class="level3"><p> To respond to an interaction, add the <interact /> element to a panel and specify the Java method you want to call. In this example, we want to call <code>sayHello()</code> when a panel on the screen is clicked.</p><pre>... |
||||||
<div> |
<span><panel id="panel" height="25%" width="35%" align="center" valign="center"</span> |
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You can use any of the three following approaches to interact, and you can also combine them, depending on what you want to do. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>GUI Calls a Void Java Method</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
To respond to an interaction, add the <interact /> element to a panel and specify the Java method you want to call. In this example, we want to call <code>sayHello()</code> when a panel on the screen is clicked. |
|
||||||
</p> |
|
||||||
<pre>... |
|
||||||
<span><panel id="panel" height="25%" width="35%" align="center" valign="center" </span> |
|
||||||
<span> backgroundColor="#f60f" childLayout="center" visibleToMouse="true"></span> |
<span> backgroundColor="#f60f" childLayout="center" visibleToMouse="true"></span> |
||||||
<span><text id="text" font="aurulent-sans-17.fnt" color="#000f" </span> |
<span><text id="text" font="aurulent-sans-17.fnt" color="#000f"</span> |
||||||
<span> text="Hello World!" align="center" valign="center" /></span> |
<span> text="Hello World!" align="center" valign="center" /></span> |
||||||
<span><interact onClick="sayHello(hi)"/></span> |
<span><interact onClick="sayHello(hi)"/></span> |
||||||
<span><span></panel></span></span> |
<span><span></panel></span></span> |
||||||
...</pre> |
...</pre><p> Back in this screen's Java class, we specify what the <code>sayHello()</code> method does. As you see, you can include String arguments in the call.</p><pre>public class MySettingsScreen implements ScreenController { |
||||||
<p> |
|
||||||
Back in this screen's Java class, we specify what the <code>sayHello()</code> method does. As you see, you can include String arguments in the call. |
|
||||||
</p> |
|
||||||
<pre>public class MySettingsScreen implements ScreenController { |
|
||||||
... |
... |
||||||
public void sayHello(String myarg) { |
public void sayHello(String myarg) { |
||||||
System.out.println("Nifty says "+myarg); |
System.out.println("Nifty says "+myarg); |
||||||
} |
} |
||||||
}</pre> |
}</pre></div><h3><a |
||||||
</div> |
name="gui_gets_return_value_from_java_method">GUI Gets Return Value from Java Method</a></h3><div |
||||||
|
class="level3"><p> You can send a message from Java to Nifty. In this example, the Java class <code>callThis()</code> in MySettingsScreen defines the Text that is displayed in the textfield after the words <code>Hello World, …!</code> First define a Java method in the screen controller, in this example, <code>callThis()</code>.</p><pre>public class MySettingsScreen implements ScreenController { |
||||||
<h3><a>GUI Gets Return Value from Java Method</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You can send a message from Java to Nifty. In this example, the Java class <code>callThis()</code> in MySettingsScreen defines the Text that is displayed in the textfield after the words <code>Hello World, …!</code> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
First define a Java method in the screen controller, in this example, <code>callThis()</code>. |
|
||||||
</p> |
|
||||||
<pre>public class MySettingsScreen implements ScreenController { |
|
||||||
... |
... |
||||||
public String callThis() { |
public String callThis() { |
||||||
return "my friend"; |
return "my friend"; |
||||||
} |
} |
||||||
}</pre> |
}</pre><p> Nifty uses <code>${CALL.callThis()}</code> to get the return value of a method from your ScreenController Java class.</p><pre>... |
||||||
<p> |
<span><panel id="panel" height="25%" width="35%" align="center" valign="center"</span> |
||||||
Nifty uses <code>${CALL.callThis()}</code> to get the return value of a method from your ScreenController Java class. |
|
||||||
</p> |
|
||||||
<pre>... |
|
||||||
<span><panel id="panel" height="25%" width="35%" align="center" valign="center" </span> |
|
||||||
<span> backgroundColor="#f60f" childLayout="center" visibleToMouse="true"></span> |
<span> backgroundColor="#f60f" childLayout="center" visibleToMouse="true"></span> |
||||||
<span><text id="text" font="aurulent-sans-17.fnt" color="#000f" </span> |
<span><text id="text" font="aurulent-sans-17.fnt" color="#000f"</span> |
||||||
<span> text="Hello World, ${CALL.callThis()}!" align="center" valign="center" /></span> |
<span> text="Hello World, ${CALL.callThis()}!" align="center" valign="center" /></span> |
||||||
<span><interact onClick="sayHello(hi)"/></span> |
<span><interact onClick="sayHello(hi)"/></span> |
||||||
<span><span></panel></span></span> |
<span><span></panel></span></span> |
||||||
...</pre> |
...</pre><p> You can also use this for Strings and numeric values, e.g. when you read settings from a file, you read them like this.</p></div><h3><a |
||||||
<p> |
name="java_modifies_nifty_elements_and_events">Java Modifies Nifty Elements and Events</a></h3><div |
||||||
You can also use this for Strings and numeric values, e.g. when you read settings from a file, you read them like this. |
class="level3"><p> You can also alter the appearance and functions of your nifty elements from Java. |
||||||
</p> |
Here's an example of how to change the image <code>myElement</code>:</p><pre>NiftyImage img = nifty.getRenderEngine().createImage("Interface/Images/image.png", false); |
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Java Modifies Nifty Elements and Events</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You can also alter the appearance and functions of your nifty elements from Java. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Here's an example of how to change the image <code>myElement</code>: |
|
||||||
</p> |
|
||||||
<pre>NiftyImage img = nifty.getRenderEngine().createImage("Interface/Images/image.png", false); |
|
||||||
Element niftyElement = nifty.getCurrentScreen().findElementByName("myElement"); |
Element niftyElement = nifty.getCurrentScreen().findElementByName("myElement"); |
||||||
niftyElement.getRenderer(ImageRenderer.class).setImage(img);</pre> |
niftyElement.getRenderer(ImageRenderer.class).setImage(img);</pre><p> The same is valid for other elements, for example text fields:</p><pre>niftyElement.getRenderer(TextRenderer.class).setText("New text");</pre><p> Similarly, to change the onClick() event of an element, create an <code>ElementInteraction</code> object:</p><pre>Element niftyElement = nifty.getCurrentScreen().findElementByName("myElement"); |
||||||
<p> |
niftyElement.getElementInteraction().getPrimary().setOnMouseOver(new NiftyMethodInvoker(nifty, "myCustomMethod()", this));</pre><p> For this to work, there already needs to be an < interact > tag inside your xml element:</p><pre><interact onClick="doNothing()"/></pre></div><h2><a |
||||||
The same is valid for other elements, for example text fields: |
name="concepts_examples">Concepts & Examples</a></h2><div |
||||||
|
class="level2"><p> note: Nifty-gui 1.3 oriented.<br/></p></div><h3><a |
||||||
</p> |
name="how_do_i_create_a_popup_menu_that_i_populate_in_java">How do I create a popup menu that I populate in Java?</a></h3><div |
||||||
<pre>niftyElement.getRenderer(TextRenderer.class).setText("New text");</pre> |
class="level3"><p> Even though you create and populate the popup menu in Java you still need a "placeholder" in your <acronym |
||||||
<p> |
title="Extensible Markup Language">XML</acronym> file, below is an example extract:</p><pre><span><useControls filename="nifty-default-controls.xml"/></span> |
||||||
Similarly, to change the onClick() event of an element, create an <code>ElementInteraction</code> object: |
... |
||||||
</p> |
<span><popup id="niftyPopupMenu" childLayout="absolute-inside"</span> |
||||||
<pre>Element niftyElement = nifty.getCurrentScreen().findElementByName("myElement"); |
<span> controller="ControllerOfYourChoice" width="10%"></span> |
||||||
niftyElement.setInteraction(new ElementInteraction(nifty) { |
<span><interact onClick="closePopup()"</span> |
||||||
|
<span> onSecondaryClick="closePopup()" onTertiaryClick="closePopup()" /></span> |
||||||
@Override |
<span><control id="#menu" name="niftyMenu" /></span> |
||||||
public void onClick() { |
<span><span></popup></span></span> |
||||||
// call java functions normally. |
...</pre><p> A brief explanation of some the attributes above:</p><ul><li |
||||||
niftyController.onElementClicked(); |
class="level1"><div |
||||||
super.onClick(); |
class="li"> the popup id will be used within your Java code so that nifty knows which popup placeholder to create</div></li><li |
||||||
|
class="level1"><div |
||||||
|
class="li"> controller will tell nifty which Java class handles MenuItemActivatedEvent</div></li><li |
||||||
|
class="level1"><div |
||||||
|
class="li"> on(Secondary/Tertiary)Click tells nifty to close the popup if the user clicks anywhere except on the menu items (in this example)</div></li><li |
||||||
|
class="level1"><div |
||||||
|
class="li"> control id will be used by the Java class to define a control type (i.e. Menu)</div></li></ul><p> Java code within your defined ScreenController implementation:<br/></p><pre>private Element popup; |
||||||
|
... |
||||||
|
public void createMyPopupMenu(){ |
||||||
|
popup = nifty.createPopup("niftyPopupMenu"); |
||||||
|
Menu.class); |
||||||
|
myMenu.setWidth(new SizeValue("100px")); //must be set |
||||||
|
myMenu.addMenuItem("Click me!", "menuItemIcon.png", new menuItem("menuItemid", "blah blah")); //menuItem is a custom class |
||||||
|
nifty.subscribe(nifty.getCurrentScreen(), myMenu.getId(), MenuItemActivatedEvent.class, new MenuItemActivatedEventSubscriber()); |
||||||
|
} |
||||||
|
public void showMenu(){ //the method to trigger the menu |
||||||
|
createMyPopupMenu() //you should call this in your constructor rather than here if it is a menu that is going to be used many times |
||||||
|
nifty.showPopup(nifty.getCurrentScreen(), popup.getId(), null); //call the popup to screen of your choice |
||||||
|
} |
||||||
|
private class menuItem{ |
||||||
|
public String id; |
||||||
|
public String name; |
||||||
|
public menuItem(String name){ |
||||||
|
this.id= id; |
||||||
|
this.name = name; |
||||||
} |
} |
||||||
|
}</pre><ul><li |
||||||
|
class="level1"><div |
||||||
|
class="li"> createMyPopupMenu() creates the menu with set width so that you can populate it</div></li><li |
||||||
|
class="level1"><div |
||||||
|
class="li"> showMenu() is called by something to trigger the menu (i.e. could be a Key or some other method)</div></li></ul><p> To handle menu item events (i.e. calling a method when you click on a menu item) you subscribe a EventTopicSubscriber<MenuItemActivatedEvent> class implementation to a nifty screen and element.<br/></p><pre>private class MenuItemActivatedEventSubscriber implements EventTopicSubscriber<MenuItemActivatedEvent> { |
||||||
@Override |
@Override |
||||||
public boolean onClick(MouseInputEvent inputEvent) { |
public void onEvent(final String id, final MenuItemActivatedEvent event) { |
||||||
niftyController.onElementClicked(); |
menuItem item = (menuItem) event.getItem(); |
||||||
return super.onClick(inputEvent); |
if ("menuItemid".equals(item.id)) { |
||||||
|
//do something !!! |
||||||
|
} |
||||||
} |
} |
||||||
});</pre> |
};</pre></div><h2><a |
||||||
<p> |
name="useful_links">Useful Links</a></h2><div |
||||||
For this to work, there already needs to be an < interact > tag inside your xml element: |
class="level2"><p> Nifty 1.3 controls Java Docs: <a |
||||||
</p> |
href="http://nifty-gui.sourceforge.net/projects/1.3-SNAPSHOT/nifty-default-controls/apidocs/">http://nifty-gui.sourceforge.net/projects/1.3-SNAPSHOT/nifty-default-controls/apidocs/</a> <br/> <br/> Nifty 1.3 Java Docs: <a |
||||||
<pre><interact onClick="doNothing()"/></pre> |
href="http://nifty-gui.sourceforge.net/projects/1.3-SNAPSHOT/nifty/apidocs/index.html">http://nifty-gui.sourceforge.net/projects/1.3-SNAPSHOT/nifty/apidocs/index.html</a> <br/> <br/> Examples of standard controls in Nifty 1.3: <a |
||||||
|
href="http://sourceforge.net/apps/mediawiki/nifty-gui/index.php?title=Nifty_Standard_Controls_%28Nifty_1.3%29">http://sourceforge.net/apps/mediawiki/nifty-gui/index.php?title=Nifty_Standard_Controls_%28Nifty_1.3%29</a> <br/> <br/> Learn more: <a |
||||||
<p> |
href="http://sourceforge.net/apps/mediawiki/nifty-gui/index.php?title=MarkUp">Nifty Syntax</a></p><div |
||||||
Learn more: <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://sourceforge.net/apps/mediawiki/nifty-gui/index.php?title=MarkUp"><param name="text" value="<html><u>Nifty Syntax</u></html>"><param name="textColor" value="blue"></object> |
class="tags"><span> <a |
||||||
|
href="/wiki/doku.php/tag:gui?do=showtag&tag=tag%3Agui">gui</a>, <a |
||||||
</p> |
href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a>, <a |
||||||
<div><span> |
href="/wiki/doku.php/tag:input?do=showtag&tag=tag%3Ainput">input</a>, <a |
||||||
<a href="/wiki/doku.php/tag:gui?do=showtag&tag=tag%3Agui">gui</a>, |
href="/wiki/doku.php/tag:controller?do=showtag&tag=tag%3Acontroller">controller</a>, <a |
||||||
<a href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a>, |
href="/wiki/doku.php/tag:controllers?do=showtag&tag=tag%3Acontrollers">controllers</a> </span></div></div> |
||||||
<a href="/wiki/doku.php/tag:input?do=showtag&tag=tag%3Ainput">input</a>, |
|
||||||
<a href="/wiki/doku.php/tag:controller?do=showtag&tag=tag%3Acontroller">controller</a>, |
|
||||||
<a href="/wiki/doku.php/tag:controllers?do=showtag&tag=tag%3Acontrollers">controllers</a> |
|
||||||
</span></div> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:nifty_gui_java_interaction?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:nifty_gui_java_interaction?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,69 +1,54 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Integrating Nifty GUI: Overlay</a></h1> |
name="integrating_nifty_guioverlay">Integrating Nifty GUI: Overlay</a></h1><div |
||||||
<div> |
class="level1"><ol><li |
||||||
<ol> |
class="level1"><div |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html">Nifty GUI XML Layout</a> </div> |
class="li"> <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html">Nifty GUI XML Layout</a></div></li><li |
||||||
<li><div> <strong>Nifty <acronym title="Graphical User Interface">GUI</acronym> Overlay</strong> or <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_projection.html">Nifty GUI Projection</a></div> |
class="level1"><div |
||||||
</li> |
class="li"> <strong>Nifty <acronym |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_java_interaction.html">Interact with the GUI from Java</a></div> |
title="Graphical User Interface">GUI</acronym> Overlay</strong> or <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_projection.html">Nifty GUI Projection</a></div></li><li |
||||||
</ol> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_java_interaction.html">Interact with the GUI from Java</a></div></li></ol><p> Define a key (for example escape) that switches the <acronym |
||||||
Define a key (for example escape) that switches the <acronym title="Graphical User Interface">GUI</acronym> on and off. |
title="Graphical User Interface">GUI</acronym> on and off. |
||||||
You can either overlay the running game with the <acronym title="Graphical User Interface">GUI</acronym> (you will most likely pause the game then), or even <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_projection.html">project</a> it as a texture onto a mesh texture (but then you cannot click to select). |
You can either overlay the running game with the <acronym |
||||||
</p> |
title="Graphical User Interface">GUI</acronym> (you will most likely pause the game then), or even <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_projection.html">project</a> it as a texture onto a mesh texture (but then you cannot click to select). |
||||||
<p> |
On this page, we look at the overlay variant (more commonly used).</p><p> <a |
||||||
On this page, we look at the overlay variant (more commonly used). |
href="/wiki/lib/exe/detail.php/jme3:advanced:nifty-gui-example.png?id=jme3%3Aadvanced%3Anifty_gui_overlay"><img |
||||||
</p> |
src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/nifty-gui-example.png?w=360&h=203" class="mediacenter" alt="" width="360" height="203" /></a></p></div><h2><a |
||||||
|
name="sample_code">Sample Code</a></h2><div |
||||||
<p> |
class="level2"><ul><li |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/advanced/nifty-gui-example.png"> |
class="level1"><div |
||||||
</p> |
class="li"> <a |
||||||
|
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/niftygui/TestNiftyGui.java">TestNiftyGui.java</a></div></li></ul></div><h2><a |
||||||
</div> |
name="overlaying_the_user_interface_over_the_screen">Overlaying the User Interface Over the Screen</a></h2><div |
||||||
|
class="level2"><p> This code shows you how to overlay anything on the screen with the <acronym |
||||||
<h2><a>Sample Code</a></h2> |
title="Graphical User Interface">GUI</acronym>. This is the most common usecase.</p><pre>NiftyJmeDisplay niftyDisplay = new NiftyJmeDisplay( |
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/niftygui/TestNiftyGui.java"><param name="text" value="<html><u>TestNiftyGui.java</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Overlaying the User Interface Over the Screen</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
This code shows you how to overlay anything on the screen with the <acronym title="Graphical User Interface">GUI</acronym>. This is the most common usecase. |
|
||||||
</p> |
|
||||||
<pre>NiftyJmeDisplay niftyDisplay = new NiftyJmeDisplay( |
|
||||||
assetManager, inputManager, audioRenderer, guiViewPort); |
assetManager, inputManager, audioRenderer, guiViewPort); |
||||||
|
/** Create a new NiftyGUI object */ |
||||||
Nifty nifty = niftyDisplay.getNifty(); |
Nifty nifty = niftyDisplay.getNifty(); |
||||||
|
/** Read your XML and initialize your custom ScreenController */ |
||||||
// init Nifty start screen |
nifty.fromXml("Interface/helloworld.xml", "start", new MySettingsScreen(data)); |
||||||
nifty.fromXml("Interface/helloworld.xml", "start"); |
|
||||||
|
|
||||||
// attach the Nifty display to the gui view port as a processor |
// attach the Nifty display to the gui view port as a processor |
||||||
guiViewPort.addProcessor(niftyDisplay); |
guiViewPort.addProcessor(niftyDisplay); |
||||||
// disable the fly cam |
// disable the fly cam |
||||||
flyCam.setDragToRotate(true);</pre><hr /> |
flyCam.setDragToRotate(true);</pre><p> The <code>MySettingsScreen</code> class is a custom de.lessvoid.nifty.screen.ScreenController in which you implement your <acronym |
||||||
<ol> |
title="Graphical User Interface">GUI</acronym> behaviour. The variable <code>data</code> contains an object that you use to exchange state info with the game. See <a |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html">Nifty GUI XML Layout</a> </div> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_java_interaction.html">Nifty GUI Java Interaction</a> for details on how we created this class.</p><hr |
||||||
</li> |
/><ol><li |
||||||
<li><div> <strong>Nifty <acronym title="Graphical User Interface">GUI</acronym> Overlay</strong> or <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_projection.html">Nifty GUI Projection</a></div> |
class="level1"><div |
||||||
</li> |
class="li"> <a |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_java_interaction.html">Interact with the GUI from Java</a></div> |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html">Nifty GUI XML Layout</a></div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ol> |
class="li"> <strong>Nifty <acronym |
||||||
<div><span> |
title="Graphical User Interface">GUI</acronym> Overlay</strong> or <a |
||||||
<a href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a>, |
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_projection.html">Nifty GUI Projection</a></div></li><li |
||||||
<a href="/wiki/doku.php/tag:gui?do=showtag&tag=tag%3Agui">gui</a> |
class="level1"><div |
||||||
</span></div> |
class="li"> <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_java_interaction.html">Interact with the GUI from Java</a></div></li></ol><div |
||||||
</div> |
class="tags"><span> <a |
||||||
|
href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a>, <a |
||||||
|
href="/wiki/doku.php/tag:gui?do=showtag&tag=tag%3Agui">gui</a> </span></div></div> |
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:nifty_gui_overlay?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:nifty_gui_overlay?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,62 +1,33 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Shapes</a></h1> |
name="shapes">Shapes</a></h1><div |
||||||
<div> |
class="level1"><p> The simplest type of Meshes are jME's default Shapes. You can use Shapes to build complex Geometries. Shapes are created without using the AssetManager.</p><p> <strong>3D shapes:</strong></p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> com.jme3.scene.shape.Sphere – A ball or elipsoid.</div></li><li |
||||||
|
class="level1"><div |
||||||
The simplest type of Meshes are jME's default Shapes. You can use Shapes to build complex Geometries. Shapes are created without using the AssetManager. |
class="li"> com.jme3.scene.shape.Box – A cube or cuboid.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> com.jme3.scene.shape.Cylinder – A disk or pillar.</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
<strong>3D shapes:</strong> |
class="li"> com.jme3.scene.shape.Dome – Half a sphere.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> com.jme3.scene.shape.Torus – An single-holed torus ("donut").</div></li><li |
||||||
<li><div> com.jme3.scene.shape.Sphere – A ball or elipsoid.</div> |
class="level1"><div |
||||||
</li> |
class="li"> com.jme3.scene.shape.PQTorus – A parameterized torus, also known as PQ torus. Looks like a <a |
||||||
<li><div> com.jme3.scene.shape.Box – A cube or cuboid.</div> |
href="http://en.wikipedia.org/wiki/Torus_knot">donut knotted into spirals</a>.</div></li></ul><p> <strong>Non-3D shapes:</strong></p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> com.jme3.scene.shape.Cylinder – A disk or pillar.</div> |
class="li"> com.jme3.scene.shape.Quad – A flat 2D rectangle (has two sides)</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> com.jme3.scene.shape.Dome – Half a sphere.</div> |
class="li"> com.jme3.scene.shape.Line – A 1D line (has a length)</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> com.jme3.scene.shape.Torus – An single-holed torus (“donut”).</div> |
class="li"> come.jme3.math.Ray – A 1D line (has length, direction, start point, but no end)</div></li></ul></div><h2><a |
||||||
</li> |
name="usage">Usage</a></h2><div |
||||||
<li><div> com.jme3.scene.shape.PQTorus – A parameterized torus, also known as PQ torus. Looks like a <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://en.wikipedia.org/wiki/Torus_knot"><param name="text" value="<html><u>donut knotted into spirals</u></html>"><param name="textColor" value="blue"></object>.</div> |
class="level2"><p> To add a shape to the scene:</p><ol><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Create the base mesh shape</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Wrap it into a Geometry</div></li><li |
||||||
|
class="level1"><div |
||||||
<strong>Non-3D shapes:</strong> |
class="li"> Attach the Geometry to the rootNode to make it visible.</div></li></ol><pre>Sphere sphereMesh = new Sphere(32, 32, 10, false, true); |
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> com.jme3.scene.shape.Quad – A flat 2D rectangle (has two sides)</div> |
|
||||||
</li> |
|
||||||
<li><div> com.jme3.scene.shape.Line – A 1D line (has a length)</div> |
|
||||||
</li> |
|
||||||
<li><div> come.jme3.math.Ray – A 1D line (has length, direction, start point, but no end)</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Usage</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
To add a shape to the scene: |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Create the base mesh shape</div> |
|
||||||
</li> |
|
||||||
<li><div> Wrap it into a Geometry</div> |
|
||||||
</li> |
|
||||||
<li><div> Attach the Geometry to the rootNode to make it visible.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
<pre>Sphere sphereMesh = new Sphere(32, 32, 10, false, true); |
|
||||||
Geometry sphere = new Geometry("Sky", sphereMesh); |
Geometry sphere = new Geometry("Sky", sphereMesh); |
||||||
rootNode.attachChild(sphere);</pre> |
rootNode.attachChild(sphere);</pre></div> |
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:shape?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:shape?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,100 +1,42 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>How to add a Sky to your Scene</a></h1> |
name="how_to_add_a_sky_to_your_scene">How to add a Sky to your Scene</a></h1><div |
||||||
<div> |
class="level1"><p> <br/></p><p> Here is an example for how you add a static horizon (a background landscape and a sky) to a scene. |
||||||
|
Having a discernable horizon with a suitable landscape (or space, or ocean, or whatever) in the background makes scenes look more realistic than just a single-colored "sky" background.</p></div><h2><a |
||||||
<p> |
name="adding_the_sky">Adding the Sky</a></h2><div |
||||||
|
class="level2"><p> Adding a sky is extremely easy using the <code>com.jme3.util.SkyFactory</code>.</p><pre>rootNode.attachChild(SkyFactory.createSky( |
||||||
<br/> |
assetManager, "Textures/Sky/Bright/BrightSky.dds", false));</pre><p> To add a sky you need to supply:</p><ol><li |
||||||
|
class="level1"><div |
||||||
</p> |
class="li"> The assetManager object to use</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> A cube or sphere map texture of the sky</div></li><li |
||||||
Here is an example for how you add a static horizon (a background landscape and a sky) to a scene. |
class="level1"><div |
||||||
Having a discernable horizon with a suitable landscape (or space, or ocean, or whatever) in the background makes scenes look more realistic than just a single-colored “sky” background. |
class="li"> Set the boolean to true if you are using a sphere map texture. For a cube map, use false. <br/> Tip: Cube map is the default. You would know if you had created a sphere map.</div></li></ol><p> Internally, the SkyFactory calls the following methods:</p><ol><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> <code>sky.setQueueBucket(Bucket.Sky);</code> makes certain the sky is rendered in the right order, behind everything else.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> <code>sky.setCullHint(Spatial.CullHint.Never);</code> makes certain that the sky is never culled.</div></li><li |
||||||
<h2><a>Adding the Sky</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> The SkyFactory uses the internal jME3 material definition <code>Sky.j3md</code>. This Material definition works with sphere and cube maps.</div></li></ol></div><h2><a |
||||||
|
name="creating_the_textures">Creating the Textures</a></h2><div |
||||||
<p> |
class="level2"><p> As the sky texture we use the sample BrightSky.dds file from jme3test-test-data.</p><p> How to create a sky textures?</p><ul><li |
||||||
|
class="level1"><div |
||||||
Adding a sky is extremely easy using the <code>com.jme3.util.SkyFactory</code>. |
class="li"> There are many tools out there that generate cube and sphere maps. <br/> Examples for landscape texture generators are Terragen or Bryce.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<pre>rootNode.attachChild(SkyFactory.createSky( |
class="li"> The actual texture size does not matter, as long as you add the Sky Geometry to the Sky bucket: Everything in the sky bucket will always be infinitely far away behind everything else, and never intersect with your scene. <br/> Of course the higher the resolution, the better it will look. On the other hand, if the graphic is too big, it will slow the game down.</div></li><li |
||||||
assetManager, "Textures/Sky/Bright/BrightSky.dds", false));</pre> |
class="level1"><div |
||||||
<p> |
class="li"> A box or sphere map is the simplest solution. But you can use any Node as sky, even complex sets of geometries and quads with animated clouds, blinking stars, city skylines, etc.</div></li><li |
||||||
To add a sky you need to supply: |
class="level1"><div |
||||||
</p> |
class="li"> JME3 supports cube maps in <acronym |
||||||
<ol> |
title="Portable Network Graphics">PNG</acronym>, <acronym |
||||||
<li><div> The assetManager object to use</div> |
title="Joint Photographics Experts Group">JPG</acronym>, or (compressed) DDS format.</div></li></ul><p> Box or Sphere?</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> A cube or sphere map texture of the sky</div> |
class="li"> If you have access to cube map textures, then use a SkyBox</div><ul><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> Set the boolean to true if you are using a sphere map texture. For a cube map, use false. <br/> |
class="li"> <a |
||||||
Tip: Cube map is the default. You would know if you had created a sphere map.</div> |
href="http://1.bp.blogspot.com/_uVsWqMqIGQU/SN0IZEE117I/AAAAAAAAAPs/4lfHx1Erdqg/s1600/skybox">SkyBox examples</a></div></li></ul></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ol> |
class="li"> If you have access to sphere map textures – specially projected sky images that fit inside a sphere – then you use a SkySphere or SkyDome.</div><ul><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> <a |
||||||
|
href="http://wiki.delphigl.com/index.php/Datei:Skysphere.jpg">SkySphere example</a></div></li></ul></li></ul></div> |
||||||
Internally, the SkyFactory calls the following methods: |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> <code>sky.setQueueBucket(Bucket.Sky);</code> makes certain the sky is rendered in the right order, behind everything else.</div> |
|
||||||
</li> |
|
||||||
<li><div> <code>sky.setCullHint(Spatial.CullHint.Never);</code> makes certain that the sky is never culled.</div> |
|
||||||
</li> |
|
||||||
<li><div> The SkyFactory uses the internal jME3 material definition <code>Sky.j3md</code>. This Material definition works with sphere and cube maps. </div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Creating the Textures</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
As the sky texture we use the sample BrightSky.dds file from jme3test-test-data. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
How to create a sky textures? |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> There are many tools out there that generate cube and sphere maps. <br/> |
|
||||||
Examples for landscape texture generators are Terragen or Bryce.</div> |
|
||||||
</li> |
|
||||||
<li><div> The actual texture size does not matter, as long as you add the Sky Geometry to the Sky bucket: Everything in the sky bucket will always be infinitely far away behind everything else, and never intersect with your scene. <br/> |
|
||||||
Of course the higher the resolution, the better it will look. On the other hand, if the graphic is too big, it will slow the game down. </div> |
|
||||||
</li> |
|
||||||
<li><div> A box or sphere map is the simplest solution. But you can use any Node as sky, even complex sets of geometries and quads with animated clouds, blinking stars, city skylines, etc.</div> |
|
||||||
</li> |
|
||||||
<li><div> JME3 supports cube maps in <acronym title="Portable Network Graphics">PNG</acronym>, <acronym title="Joint Photographics Experts Group">JPG</acronym>, or (compressed) DDS format.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Box or Sphere? |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> If you have access to cube map textures, then use a SkyBox</div> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://1.bp.blogspot.com/_uVsWqMqIGQU/SN0IZEE117I/AAAAAAAAAPs/4lfHx1Erdqg/s1600/skybox"><param name="text" value="<html><u>SkyBox examples</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> If you have access to sphere map textures – specially projected sky images that fit inside a sphere – then you use a SkySphere or SkyDome. </div> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://wiki.delphigl.com/index.php/Datei:Skysphere.jpg"><param name="text" value="<html><u>SkySphere example</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:sky?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:sky?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,102 +1,59 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Spatial</a></h1> |
name="spatial">Spatial</a></h1><div |
||||||
<div> |
class="level1"><p> This is an introduction to the concept of of Spatials, the elements of the 3D scene graph. The scene graph is a data structure that manages all objects in your 3D world. For example it keeps track of the 3D models that you load and position. When you extend a Java class from com.jme3.app.SimpleApplication, you inherit the scene graph and rootNode.</p><p> The main element of the scene graph is a Spatial called rootNode. All other Spatials are <em>attached</em> to the rootNode in a parent-child relationship. If you think you want to understand the scene graph better, please read <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/scenegraph_for_dummies.html">Scenegraph for dummies</a> first.</p></div><h2><a |
||||||
<p> |
name="node_versus_geometry">Node versus Geometry</a></h2><div |
||||||
|
class="level2"><p> A Spatial is either a Node or a Geometry.</p><p> <a |
||||||
This is an introduction to the concept of of Spatials, the elements of the 3D scene graph. The scene graph is a data structure that manages all objects in your 3D world. For example it keeps track of the 3D models that you load and position. When you extend a Java class from com.jme3.app.SimpleApplication, you inherit the scene graph and rootNode. |
href="/wiki/lib/exe/detail.php/jme3:intermediate:scene-graph.png?id=jme3%3Aadvanced%3Aspatial"><img |
||||||
</p> |
src="nbdocs:/com/jme3/gde/core/docs/jme3/intermediate/scene-graph.png" class="mediacenter" alt="" /></a></p><div |
||||||
|
class="table sectionedit1"><table |
||||||
<p> |
class="inline"><tr |
||||||
The main element of the scene graph is a Spatial called rootNode. All other Spatials are <em>attached</em> to the rootNode in a parent-child relationship. If you think you want to understand the scene graph better, please read <a href="/com/jme3/gde/core/docs/jme3/scenegraph_for_dummies.html">Scenegraph for dummies</a> first. |
class="row0"><td |
||||||
</p> |
class="col0 leftalign"></td><th |
||||||
|
class="col1" colspan="2"> Spatials</th></tr><tr |
||||||
</div> |
class="row1"><th |
||||||
|
class="col0"> Purpose:</th><td |
||||||
<h2><a>Node versus Geometry</a></h2> |
class="col1" colspan="2"> A Spatial is an abstract data structure that stores transformations (translation, rotation, scale) of elements of the scene graph. A Spatial can be saved and loaded using the AssetManager.</td></tr><tr |
||||||
<div> |
class="row2"><td |
||||||
|
class="col0 leftalign"></td><th |
||||||
<p> |
class="col1"> com.jme3.scene.Geometry</th><th |
||||||
|
class="col2"> com.jme3.scene.Node</th></tr><tr |
||||||
A Spatial is either a Node or a Geometry. |
class="row3"><th |
||||||
</p> |
class="col0"> Visibility:</th><td |
||||||
|
class="col1"> A Geometry represents a visible 3-D object in the scene graph.</td><td |
||||||
<p> |
class="col2"> A Node is an invisible "handle" for a group of objects in the scene graph.</td></tr><tr |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/intermediate/scene-graph.png"> |
class="row4"><th |
||||||
|
class="col0 leftalign"> Purpose:</th><td |
||||||
</p> |
class="col1"> Use Geometries to represent an object's looks: Every Geometry contains a polygon mesh and a material, specifying its shape, color, texture, and opacity/transparency. <br/> You can attach a Geometry to an Node.</td><td |
||||||
<table> |
class="col2"> Use nodes to structure and group Geometries and other Nodes. Every Node is attached to parent node, and the node can have children attached to itself. When you transform a parent node, all its children are transformed as well.</td></tr><tr |
||||||
<tr> |
class="row5"><th |
||||||
<td> </td><th> Spatials </th> |
class="col0 leftalign"> Content:</th><td |
||||||
</tr> |
class="col1"> Transformations, mesh, material.</td><td |
||||||
<tr> |
class="col2"> Transformations. No mesh, no material.</td></tr><tr |
||||||
<th> Purpose: </th><td> A Spatial is an abstract data structure that stores transformations (translation, rotation, scale) of elements of the scene graph. A Spatial can be saved and loaded using the AssetManager. </td> |
class="row6"><th |
||||||
</tr> |
class="col0 leftalign"> Examples:</th><td |
||||||
<tr> |
class="col1"> A box, a sphere, player, a building, a piece of terrain, a vehicle, missiles, NPCs, etc…</td><td |
||||||
<td> </td><th> com.jme3.scene.Geometry </th><th> com.jme3.scene.Node </th> |
class="col2"> The rootNode, the guiNode, an audio node, a custom grouping node, etc…</td></tr></table></div><p> <strong>Important:</strong> You never create a Spatial with <code>Spatial s = new Spatial();</code> – it's abstract. Instead you create (e.g. load) a Node or Geometry object, and cast it to Spatial. You use the Spatial type in methods that accept both Nodes and Geometries as arguments.</p></div><h3><a |
||||||
</tr> |
name="mesh">Mesh</a></h3><div |
||||||
<tr> |
class="level3"><p> The polygon <a |
||||||
<th> Visibility: </th><td> A Geometry represents a visible 3-D object in the scene graph. </td><td> A Node is an invisible “handle” for a group of objects in the scene graph. </td> |
href="/com/jme3/gde/core/docs/jme3/advanced/mesh.html">Mesh</a> inside a Geometry can be one of three things:</p><ul><li |
||||||
</tr> |
class="level1"><div |
||||||
<tr> |
class="li"> <strong>Shapes:</strong> The simplest type of Meshes are jME's default <a |
||||||
<th> Purpose: </th><td> Use Geometries to represent an object's looks: Every Geometry contains a polygon mesh and a material, specifying its shape, color, texture, and opacity/transparency. <br/> |
href="/com/jme3/gde/core/docs/jme3/advanced/shape.html">Shape</a>s such as cubes and spheres. You can use several Shapes to build complex Geometries. Shapes are built-in and can be created without using the AssetManager.</div></li><li |
||||||
You can attach a Geometry to an Node. </td><td> Use nodes to structure and group Geometries and other Nodes. Every Node is attached to parent node, and the node can have children attached to itself. When you transform a parent node, all its children are transformed as well. </td> |
class="level1"><div |
||||||
</tr> |
class="li"> <strong>3D Models:</strong> <a |
||||||
<tr> |
href="/com/jme3/gde/core/docs/jme3/advanced/3d_models.html">3D models and scenes</a> are also made up of meshes, but are more complex than Shapes. You create Models and Scenes in external 3D Mesh Editors and export them as Ogre <acronym |
||||||
<th> Content: </th><td> Transformations, mesh, material. </td><td> Transformations. No mesh, no material.</td> |
title="Extensible Markup Language">XML</acronym> or Wavefront OBJ. Use the <a |
||||||
</tr> |
href="/com/jme3/gde/core/docs/jme3/advanced/asset_manager.html">Asset Manager</a> to load models into a your jME3 game.</div></li><li |
||||||
<tr> |
class="level1"><div |
||||||
<th> Examples: </th><td> A box, a sphere, player, a building, a piece of terrain, a vehicle, missiles, NPCs, etc… </td><td> The rootNode, the guiNode, an audio node, a custom grouping node, etc… </td> |
class="li"> <strong>Custom Meshes:</strong> Advanced users can create <a |
||||||
</tr> |
href="/com/jme3/gde/core/docs/jme3/advanced/custom_meshes.html">Custom Meshes</a> programmatically.</div></li></ul></div><h2><a |
||||||
</table> |
name="how_to_access_a_named_sub-mesh">How to Access a Named Sub-Mesh</a></h2><div |
||||||
|
class="level2"><p> Often after you load a scene or model, you need to access a part of it as an individual Geometry in the scene graph. Maybe you want to swap a character's weapon, or you want to play a door-opening animation. First you need to know the unique name of the sub-mesh.</p><ol><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Open the model in a 3D mesh editor, or in the jMonkeyPlatform's viewer.</div></li><li |
||||||
<strong>Important:</strong> You never create a Spatial with <code>Spatial s = new Spatial();</code> – it's abstract. Instead you create (e.g. load) a Node or Geometry object, and cast it to Spatial. You use the Spatial type in methods that accept both Nodes and Geometries as arguments. |
class="level1"><div |
||||||
</p> |
class="li"> Find out the existing names of sub-meshes in the model.</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Assign unique names to sub-meshes in the model if neccessary.</div></li></ol><p> In the following example, the Node <code>house</code> is the loaded model. The sub-meshes in the Node are called its children. The String, here <code>door 12</code>, is the name of the mesh that you are searching.</p><pre>Geometry submesh = (Geometry) houseScene.getChild("door 12");</pre></div> |
||||||
|
|
||||||
<h3><a>Mesh</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The polygon <a href="/com/jme3/gde/core/docs/jme3/advanced/mesh.html">Mesh</a> inside a Geometry can be one of three things: |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <strong>Shapes:</strong> The simplest type of Meshes are jME's default <a href="/com/jme3/gde/core/docs/jme3/advanced/shape.html">Shape</a>s such as cubes and spheres. You can use several Shapes to build complex Geometries. Shapes are built-in and can be created without using the AssetManager.</div> |
|
||||||
</li> |
|
||||||
<li><div> <strong>3D Models:</strong> <a href="/com/jme3/gde/core/docs/jme3/advanced/3d_models.html">3D models and scenes</a> are also made up of meshes, but are more complex than Shapes. You create Models and Scenes in external 3D Mesh Editors and export them as Ogre <acronym title="Extensible Markup Language">XML</acronym> or Wavefront OBJ. Use the <a href="/com/jme3/gde/core/docs/jme3/advanced/asset_manager.html">Asset Manager</a> to load models into a your jME3 game.</div> |
|
||||||
</li> |
|
||||||
<li><div> <strong>Custom Meshes:</strong> Advanced users can create <a href="/com/jme3/gde/core/docs/jme3/advanced/custom_meshes.html">Custom Meshes</a> programmatically.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>How to Access a Named Sub-Mesh</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Often after you load a scene or model, you need to access a part of it as an individual Geometry in the scene graph. Maybe you want to swap a character's weapon, or you want to play a door-opening animation. First you need to know the unique name of the sub-mesh. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Open the model in a 3D mesh editor, or in the jMonkeyPlatform's viewer. </div> |
|
||||||
</li> |
|
||||||
<li><div> Find out the existing names of sub-meshes in the model.</div> |
|
||||||
</li> |
|
||||||
<li><div> Assign unique names to sub-meshes in the model if neccessary.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
In the following example, the Node <code>house</code> is the loaded model. The sub-meshes in the Node are called its children. The String, here <code>door 12</code>, is the name of the mesh that you are searching. |
|
||||||
</p> |
|
||||||
<pre>Geometry submesh = (Geometry) houseScene.getChild("door 12");</pre> |
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:spatial?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:spatial?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,164 +1,60 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>JME3 Canvas in a Swing GUI</a></h1> |
name="jme3_canvas_in_a_swing_gui">JME3 Canvas in a Swing GUI</a></h1><div |
||||||
<div> |
class="level1"><p> 3D games are typically played full-screen, or in a window that takes over the mouse and all inputs. However it is also possible to embed a jME 3 canvas in a standard Swing application. <br/> <br/> This can be useful when you create some sort of interactive 3D viewer with a user interface that is more complex than just a HUD: For instance an interactive scientific demo, a level editor, or a game character designer. <br/> <br/></p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Advantages:</div><ul><li |
||||||
|
class="level2"><div |
||||||
3D games are typically played full-screen, or in a window that takes over the mouse and all inputs. However it is also possible to embed a jME 3 canvas in a standard Swing application. |
class="li"> You can use Swing components (frame, panels, menus, controls) next to your jME3 game.</div></li><li |
||||||
</p> |
class="level2"><div |
||||||
|
class="li"> The NetBeans <acronym |
||||||
<p> |
title="Graphical User Interface">GUI</acronym> builder is compatible with the jMonkeyEngine; you can use it it to lay out the Swing <acronym |
||||||
This can be useful when you create some sort of interactive 3D viewer with a user interface that is more complex than just a HUD: For instance an interactive scientific demo, a level editor, or a game character designer. |
title="Graphical User Interface">GUI</acronym> frame, and then add() the jME canvas into it. Install the <acronym |
||||||
|
title="Graphical User Interface">GUI</acronym> builder via Tools → Plugins → Available Plugins.</div></li></ul></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> Disadvantages:</div><ul><li |
||||||
<li><div> Advantages: </div> |
class="level2"><div |
||||||
<ul> |
class="li"> You cannot use SimpleApplication's default mouse capturing for camera navigation, but have to come up with a custom solution.</div></li></ul></li></ul><p> Here is the full <a |
||||||
<li><div> You can use Swing components (frame, panels, menus, controls) next to your jME3 game. </div> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/awt/TestCanvas.java">TestCanvas.java</a> code sample.</p></div><h2><a |
||||||
</li> |
name="extending_simpleapplication">Extending SimpleApplication</a></h2><div |
||||||
<li><div> The NetBeans <acronym title="Graphical User Interface">GUI</acronym> builder is compatible with the jMonkeyEngine; you can use it it to lay out the Swing <acronym title="Graphical User Interface">GUI</acronym> frame, and then add() the jME canvas into it. Install the <acronym title="Graphical User Interface">GUI</acronym> builder via Tools → Plugins → Available Plugins.</div> |
class="level2"><p> You start out just the same as for any jME3 game: The base application, here SwingCanvasTest, extends <code>com.jme3.app.SimpleApplication</code>. As usual, you use <code>simpleInitApp()</code> to initialize the scene, and <code>simpleUpdate()</code> as event loop. <br/> <br/> The camera's default behaviour in SimpleApplication is to capture the mouse, which doesn't make sense in a Swing window. You have to deactivate and replace this behaviour by <code>flyCam.setDragToRotate(true);</code> when you initialize the application:</p><pre>public void simpleInitApp() { |
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> Disadvantages:</div> |
|
||||||
<ul> |
|
||||||
<li><div> You cannot use SimpleApplication's default mouse capturing for camera navigation, but have to come up with a custom solution.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Here is the full <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/test/jme3test/app/SwingCanvasTest.java?r=5796"><param name="text" value="<html><u>SwingCanvasTest.java</u></html>"><param name="textColor" value="blue"></object> code sample, contributed by pgi. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Extending SimpleApplication</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You start out just the same as for any jME3 game: The base application, here SwingCanvasTest, extends <code>com.jme3.app.SimpleApplication</code>. As usual, you use <code>simpleInitApp()</code> to initialize the scene, and <code>simpleUpdate()</code> as event loop. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
The camera's default behaviour in SimpleApplication is to capture the mouse, which doesn't make sense in a Swing window. You have to deactivate and replace this behaviour by <code>flyCam.setDragToRotate(true);</code> when you initialize the application: |
|
||||||
</p> |
|
||||||
<pre>public void simpleInitApp() { |
|
||||||
// activate windowed input behaviour |
// activate windowed input behaviour |
||||||
flyCam.setDragToRotate(true); |
flyCam.setDragToRotate(true); |
||||||
|
|
||||||
// Set up inputs and load your scene as usual |
// Set up inputs and load your scene as usual |
||||||
... |
... |
||||||
}</pre> |
}</pre><p> In short: The first thing that is different is the <code>main()</code> method. We don't call start() on the SwingCanvasTest object as usual. Instead we create a Runnable() that creates and opens a standard Swing jFrame. In the runnable, we also create our SwingCanvasTest game with special settings, create a Canvas for it, and add that to the jFrame. Then we call startCanvas().</p></div><h2><a |
||||||
<p> |
name="main_and_runnable">Main() and Runnable()</a></h2><div |
||||||
In short: The first thing that is different is the <code>main()</code> method. We don't call start() on the SwingCanvasTest object as usual. Instead we create a Runnable() that creates and opens a standard Swing jFrame. In the runnable, we also create our SwingCanvasTest game with special settings, create a Canvas for it, and add that to the jFrame. Then we call startCanvas(). |
class="level2"><p> The Swing isn't thread-safe and doesn't allow us to keep the jME3 canvas up-to-date. This is why we create a runnable for the jME canvas and queue it in the AWT event thread, so it can be invoked "later" in the loop, when Swing is ready with updating its own stuff. <br/> <br/> In the SwingCanvasTest's main() method, create a queued runnable(). It will contain the jME canvas and the Swing frame.</p><pre> public static void main(String[] args) { |
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Main() and Runnable()</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The Swing isn't thread-save and doesn't allow us to keep the jME3 canvas up-to-date. This is why we create a runnable for the jME canvas and queue it in the AWT event thread, so it can be invoked “later” in the loop, when Swing is ready with updating its own stuff. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
In the SwingCanvasTest's main() method, create a queued runnable(). It will contain the jME canvas and the Swing frame. |
|
||||||
</p> |
|
||||||
<pre> public static void main(String[] args) { |
|
||||||
java.awt.Runnable() { |
java.awt.Runnable() { |
||||||
public void run() { |
public void run() { |
||||||
// ... see below ... |
// ... see below ... |
||||||
} |
} |
||||||
}); |
}); |
||||||
}</pre> |
}</pre></div><h3><a |
||||||
</div> |
name="creating_the_canvas">Creating the Canvas</a></h3><div |
||||||
|
class="level3"><p> Here in the <code>run()</code> method, we start the jME application, create its canvas, create a Swing frame, and add everything together. <br/> <br/> Specify the com.jme3.system.AppSettings so jME knows the size of the Swing panel that we put it into. The application will not ask the user for display settings, you have to specify them in advance.</p><pre>AppSettings settings = new AppSettings(true); |
||||||
<h3><a>Creating the Canvas</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Here in the <code>run()</code> method, we start the jME application, create its canvas, create a Swing frame, and add everything together. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Specify the com.jme3.system.AppSettings so jME knows the size of the Swing panel that we put it into. The application will not ask the user for display settings, you have to specify them in advance. |
|
||||||
</p> |
|
||||||
<pre>AppSettings settings = new AppSettings(true); |
|
||||||
settings.setWidth(640); |
settings.setWidth(640); |
||||||
settings.setHeight(480);</pre> |
settings.setHeight(480);</pre><p> We create our canvas application SwingCanvasTest, and give it the settings. We manually create a canvas for this game and configure the com.jme3.system.JmeCanvasContext. The method setSystemListener() makes sure that the listener receives events relating to context creation, update, and destroy.</p><pre>SwingCanvasTest canvasApplication = new SwingCanvasTest(); |
||||||
<p> |
|
||||||
We create our canvas application SwingCanvasTest, and give it the settings. We manually create a canvas for this game and configure the com.jme3.system.JmeCanvasContext. The method setSystemListener() makes sure that the listener receives events relating to context creation, update, and destroy. |
|
||||||
</p> |
|
||||||
<pre>SwingCanvasTest canvasApplication = new SwingCanvasTest(); |
|
||||||
canvasApplication.setSettings(settings); |
canvasApplication.setSettings(settings); |
||||||
canvasApplication.createCanvas(); // create canvas! |
canvasApplication.createCanvas(); // create canvas! |
||||||
JmeCanvasContext ctx = (JmeCanvasContext) canvasApplication.getContext(); |
JmeCanvasContext ctx = (JmeCanvasContext) canvasApplication.getContext(); |
||||||
ctx.setSystemListener(canvasApplication); |
ctx.setSystemListener(canvasApplication); |
||||||
Dimension(640, 480); |
Dimension(640, 480); |
||||||
ctx.getCanvas().setPreferredSize(dim);</pre> |
ctx.getCanvas().setPreferredSize(dim);</pre><p> Note that we have not called start() on the application, as we would usually do in the main() method. We will call startCanvas() later instead.</p></div><h3><a |
||||||
<p> |
name="creating_the_swing_frame">Creating the Swing Frame</a></h3><div |
||||||
Note that we have not called start() on the application, as we would usually do in the main() method. We will call startCanvas() later instead. |
class="level3"><p> Inside the run() method, you create the Swing window as you would usually do. Create an empty jFrame and add() components to it, or create a custom jFrame object in another class file (for example, by using the NetBeans <acronym |
||||||
</p> |
title="Graphical User Interface">GUI</acronym> builder) and create an instance of it here. |
||||||
|
Which ever you do, let's call the jFrame <code>window</code>.</p><pre>JFrame("Swing Application"); |
||||||
</div> |
window.setDefaultCloseOperation(FlowLayout()); // a panel |
||||||
|
|
||||||
<h3><a>Creating the Swing Frame</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Inside the run() method, you create the Swing window as you would usually do. Create an empty jFrame and add() components to it, or create a custom jFrame object in another class file (for example, by using the NetBeans <acronym title="Graphical User Interface">GUI</acronym> builder) and create an instance of it here. |
|
||||||
Which ever you do, let's call the jFrame <code>window</code>. |
|
||||||
</p> |
|
||||||
<pre>JFrame("Swing Application"); |
|
||||||
window.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);</pre> |
|
||||||
<p> |
|
||||||
We create a standard JPanel inside the JFrame. Give it any Layout you wish – here we use a simple Flow Layout. Where the code sample says “Some Swing Component”, this is where you add your buttons and controls. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
The important step is to add() the canvas component into the panel, like all the other Swing components. |
|
||||||
</p> |
|
||||||
<pre>FlowLayout()); // a panel |
|
||||||
// add all your Swing components ... |
// add all your Swing components ... |
||||||
panel.add(new JButton("Some Swing Component")); |
panel.add(new JButton("Some Swing Component")); |
||||||
... |
... |
||||||
// add the JME canvas |
// add the JME canvas |
||||||
panel.add(ctx.getCanvas());</pre> |
panel.add(ctx.getCanvas());</pre><p> OK, the jFrame and the panel are ready. We add the panel into the jFrame, and pack everything together. Set the window's visibility to true make it appear.</p><pre>window.add(panel); |
||||||
<p> |
|
||||||
OK, the jFrame and the panel are ready. We add the panel into the jFrame, and pack everything together. Set the window's visibility to true make it appear. |
|
||||||
</p> |
|
||||||
<pre>window.add(panel); |
|
||||||
window.pack(); |
window.pack(); |
||||||
window.setVisible(true);</pre> |
window.setVisible(true);</pre><p> Remember that we haven't called start() on the jME appliation yet? For the canvas, there is a special <code>startCanvas()</code> method that you must call now:</p><pre>canvasApplication.startCanvas();</pre><p> Clean, build, and run!</p></div><h2><a |
||||||
<p> |
name="navigation">Navigation</a></h2><div |
||||||
Remember that we haven't called start() on the jME appliation yet? For the canvas, there is a special <code>startCanvas()</code> method that you must call now: |
class="level2"><p> Remember, to navigate in the scene, click and drag (!) the mouse, or press the WASD keys. Depending on your game you may even want to define custom inputs to handle navigation in this untypical environment.</p><div |
||||||
</p> |
class="tags"><span> <a |
||||||
<pre>canvasApplication.startCanvas();</pre> |
href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a>, <a |
||||||
<p> |
href="/wiki/doku.php/tag:gui?do=showtag&tag=tag%3Agui">gui</a> </span></div></div> |
||||||
Clean, build, and run! |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Navigation</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Remember, to navigate in the scene, click and drag (!) the mouse, or press the WASD keys. Depending on your game you may even want to define custom inputs to handle navigation in this untypical environment. |
|
||||||
</p> |
|
||||||
<div><span> |
|
||||||
<a href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a>, |
|
||||||
<a href="/wiki/doku.php/tag:gui?do=showtag&tag=tag%3Agui">gui</a> |
|
||||||
</span></div> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:swing_canvas?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:swing_canvas?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,76 +1,52 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Update Loop</a></h1> |
name="update_loop">Update Loop</a></h1><div |
||||||
<div> |
class="level1"><p> Extending your application from com.jme3.app.<a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/intermediate/simpleapplication.html">SimpleApplication</a> provides you with an update loop. This is where you implement your game logic (game mechanics).</p><p> Examples: Here you remote-control NPCs (computer controlled characters), generate game events, and respond to user input.</p><ol><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Initialization (<code>simpleInit()</code>)</div></li><li |
||||||
Extending your application from com.jme3.app.<a href="/com/jme3/gde/core/docs/jme3/intermediate/simpleapplication.html">SimpleApplication</a> provides you with an update loop. This is where you implement your game logic (game mechanics). |
class="level1"><div |
||||||
</p> |
class="li"> If exit is requested, then cleanup and destroy</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> <a |
||||||
Examples: Here you remote-control NPCs (computer controlled characters), generate game events, and respond to user input. |
href="/com/jme3/gde/core/docs/jme3/advanced/input_handling.html">Input handling</a> (listeners)</div></li><li |
||||||
|
class="level1"><div |
||||||
</p> |
class="li"> Update game state</div><ol><li |
||||||
<ol> |
class="level2"><div |
||||||
<li><div> Initialization (<code>simpleInit()</code>)</div> |
class="li"> <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/advanced/application_states.html">Application States</a> update</div></li><li |
||||||
<li><div> If exit is requested, then cleanup and destroy</div> |
class="level2"><div |
||||||
</li> |
class="li"> User update (<code>simpleUpdate()</code> method)</div></li><li |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/input_handling.html">Input handling</a> (listeners)</div> |
class="level2"><div |
||||||
</li> |
class="li"> Entity logical update (<a |
||||||
<li><div> Update game state</div> |
href="/com/jme3/gde/core/docs/jme3/advanced/custom_controls.html">Custom Controls</a>)</div></li></ol></li><li |
||||||
<ol> |
class="level1"><div |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/application_states.html">Application States</a> update</div> |
class="li"> render</div><ol><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> User update (<code>simpleUpdate()</code> method)</div> |
class="li"> <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/advanced/application_states.html">Application States</a> rendering</div></li><li |
||||||
<li><div> Entity logical update (<a href="/com/jme3/gde/core/docs/jme3/advanced/custom_controls.html">Custom Controls</a>)</div> |
class="level2"><div |
||||||
</li> |
class="li"> Scene rendering</div></li><li |
||||||
</ol> |
class="level2"><div |
||||||
</li> |
class="li"> User rendering (<code>simpleRender()</code> method)</div></li></ol></li><li |
||||||
<li><div> render</div> |
class="level1"><div |
||||||
<ol> |
class="li"> Repeat (goto 2)</div></li></ol></div><h2><a |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/application_states.html">Application States</a> rendering</div> |
name="usage">Usage</a></h2><div |
||||||
</li> |
class="level2"><p> Use…</p><ul><li |
||||||
<li><div> Scene rendering</div> |
class="level1"><div |
||||||
</li> |
class="li"> <a |
||||||
<li><div> User rendering (<code>simpleRender()</code> method)</div> |
href="/com/jme3/gde/core/docs/jme3/advanced/application_states.html">Application States</a> to implement global game mechanics <br/> Example: Physics, Global gameplay control</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ol> |
class="li"> <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/advanced/custom_controls.html">Custom Controls</a> to implement entity behavior <br/> Example: Enemy AI</div></li><li |
||||||
<li><div> Repeat (goto 2)</div> |
class="level1"><div |
||||||
</li> |
class="li"> <code>simpleUpdate()</code> to implement the rest, or for testing during development.</div></li></ul><div |
||||||
</ol> |
class="tags"><span> <a |
||||||
|
href="/wiki/doku.php/tag:basegame?do=showtag&tag=tag%3Abasegame">basegame</a>, <a |
||||||
</div> |
href="/wiki/doku.php/tag:controller?do=showtag&tag=tag%3Acontroller">controller</a>, <a |
||||||
|
href="/wiki/doku.php/tag:input?do=showtag&tag=tag%3Ainput">input</a>, <a |
||||||
<h2><a>Usage</a></h2> |
href="/wiki/doku.php/tag:init?do=showtag&tag=tag%3Ainit">init</a>, <a |
||||||
<div> |
href="/wiki/doku.php/tag:keyinput?do=showtag&tag=tag%3Akeyinput">keyinput</a>, <a |
||||||
|
href="/wiki/doku.php/tag:loop?do=showtag&tag=tag%3Aloop">loop</a>, <a |
||||||
<p> |
href="/wiki/doku.php/tag:states?do=showtag&tag=tag%3Astates">states</a>, <a |
||||||
|
href="/wiki/doku.php/tag:state?do=showtag&tag=tag%3Astate">state</a> </span></div></div> |
||||||
Use… |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/application_states.html">Application States</a> to implement global game mechanics <br/> |
|
||||||
Example: Physics, Global gameplay control</div> |
|
||||||
</li> |
|
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/custom_controls.html">Custom Controls</a> to implement entity behavior <br/> |
|
||||||
Example: Enemy AI</div> |
|
||||||
</li> |
|
||||||
<li><div> <code>simpleUpdate()</code> to implement the rest, or for testing during development.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
<div><span> |
|
||||||
<a href="/wiki/doku.php/tag:basegame?do=showtag&tag=tag%3Abasegame">basegame</a>, |
|
||||||
<a href="/wiki/doku.php/tag:controller?do=showtag&tag=tag%3Acontroller">controller</a>, |
|
||||||
<a href="/wiki/doku.php/tag:input?do=showtag&tag=tag%3Ainput">input</a>, |
|
||||||
<a href="/wiki/doku.php/tag:init?do=showtag&tag=tag%3Ainit">init</a>, |
|
||||||
<a href="/wiki/doku.php/tag:keyinput?do=showtag&tag=tag%3Akeyinput">keyinput</a>, |
|
||||||
<a href="/wiki/doku.php/tag:loop?do=showtag&tag=tag%3Aloop">loop</a>, |
|
||||||
<a href="/wiki/doku.php/tag:states?do=showtag&tag=tag%3Astates">states</a>, |
|
||||||
<a href="/wiki/doku.php/tag:state?do=showtag&tag=tag%3Astate">state</a> |
|
||||||
</span></div> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:update_loop?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:advanced:update_loop?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,187 +1,85 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Setting up JME3 in Netbeans 6.x</a></h1> |
name="setting_up_jme3_in_netbeans_6x">Setting up JME3 in Netbeans 6.x</a></h1><div |
||||||
<div> |
class="level1"><p> You are welcome to try out the new jME3, and contribute patches and features! This document shows how to download, set up, build, and run the latest development version from the sources. (As of Spring 2010, we are in alpha.) These instructions work in NetBeans IDE 6 or better.</p><p> Note: In the following, always replace "~" with the path to your home directory.</p></div><h2><a |
||||||
|
name="downloading_the_sources">Downloading the Sources</a></h2><div |
||||||
<p> |
class="level2"><p> Check out the sources from the repository. (The following NetBeans instructions are equivalent to executing <code>cd ~/NetBeansProjects; svn checkout <a |
||||||
|
href="http://jmonkeyengine.googlecode.com/svn/trunk/engine">http://jmonkeyengine.googlecode.com/svn/trunk/engine</a> jme3</code> on the commandline.)</p><ol><li |
||||||
You are welcome to try out the new jME3, and contribute patches and features! This document shows how to download, set up, build, and run the latest development version from the sources. (As of Spring 2010, we are in alpha.) These instructions work in NetBeans IDE 6 or better. |
class="level1"><div |
||||||
</p> |
class="li"> In NetBeans go to Team > Subversion > Checkout</div><ol><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> Repository <acronym |
||||||
Note: In the following, always replace ”~” with the path to your home directory. |
title="Uniform Resource Locator">URL</acronym>: <code><a |
||||||
</p> |
href="https://jmonkeyengine.googlecode.com/svn">https://jmonkeyengine.googlecode.com/svn</a></code></div></li><li |
||||||
|
class="level2"><div |
||||||
</div> |
class="li"> You can leave user/pw blank for anonymous access.</div></li></ol></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Downloading the Sources</a></h2> |
class="li"> Click Next</div><ol><li |
||||||
<div> |
class="level2"><div |
||||||
|
class="li"> Repository Folders: <code>trunk/engine</code></div></li><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> Enable the checkbox to Skip "engine" and only checkout its contents.</div></li><li |
||||||
Check out the sources from the repository. (The following NetBeans instructions are equivalent to executing <code>cd ~/NetBeansProjects; svn checkout <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://jmonkeyengine.googlecode.com/svn/trunk/engine"><param name="text" value="<html><u>http://jmonkeyengine.googlecode.com/svn/trunk/engine</u></html>"><param name="textColor" value="blue"></object> jme3</code> on the commandline.) |
class="level2"><div |
||||||
|
class="li"> Local Folder: <code>~/NetBeansProjects/jme3</code></div></li></ol></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ol> |
class="li"> Click Finish and wait.</div></li></ol><p> The jme3 project opens in the Project window. It already includes a working ANT build script for building and running.</p><p> Look into the Libraries node and confirm that the project depends on the following libraries in the classpath:</p><pre>jME3-natives-joal.jar lwjgl.jar gluegen-rt.jar |
||||||
<li><div> In NetBeans go to Team > Subversion > Checkout</div> |
|
||||||
<ol> |
|
||||||
<li><div> Repository <acronym title="Uniform Resource Locator">URL</acronym>: <code><object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="https://jmonkeyengine.googlecode.com/svn"><param name="text" value="<html><u>https://jmonkeyengine.googlecode.com/svn</u></html>"><param name="textColor" value="blue"></object></code></div> |
|
||||||
</li> |
|
||||||
<li><div> You can leave user/pw blank for anonymous access. </div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
<li><div> Click Next</div> |
|
||||||
<ol> |
|
||||||
<li><div> Repository Folders: <code>trunk/engine</code></div> |
|
||||||
</li> |
|
||||||
<li><div> Enable the checkbox to Skip “engine” and only checkout its contents.</div> |
|
||||||
</li> |
|
||||||
<li><div> Local Folder: <code>~/NetBeansProjects/jme3</code></div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
<li><div> Click Finish and wait.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The jme3 project opens in the Project window. It already includes a working ANT build script for building and running. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Look into the Libraries node and confirm that the project depends on the following libraries in the classpath: |
|
||||||
</p> |
|
||||||
<pre> |
|
||||||
jME3-natives-joal.jar lwjgl.jar gluegen-rt.jar |
|
||||||
jME3-lwjgl-natives.jar jinput.jar swing-layout-1.0.4.jar |
jME3-lwjgl-natives.jar jinput.jar swing-layout-1.0.4.jar |
||||||
j-ogg-oggd.jar vecmath.jar stack-alloc.jar |
j-ogg-oggd.jar vecmath.jar stack-alloc.jar |
||||||
j-ogg-vorbisd.jar asm-all-3.1.jar jbullet.jar |
j-ogg-vorbisd.jar asm-all-3.1.jar jbullet.jar |
||||||
jheora-jst-debug-0.6.0.jar xmlpull.xpp3-1.1.4c.jar |
jheora-jst-debug-0.6.0.jar xmlpull.xpp3-1.1.4c.jar |
||||||
nifty*.jar eventbus-1.4.jar |
nifty*.jar eventbus-1.4.jar</pre></div><h3><a |
||||||
</pre> |
name="optionalsetting_up_android_support">Optional: Setting up Android Support</a></h3><div |
||||||
|
class="level3"><p> Work in progress …</p><p> A jme3 application can either be deployed to the desktop (as Java Swing application) and web browser (as JNLP/WebStart or Applet), or to an Android phone. While the former is the default, switching to Android deployment can be done in a few steps.</p><ol><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Open Project Properties, go to Sources category.</div></li><li |
||||||
<h3><a>Optional: Setting up Android Support</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> At Source Packages Folders, click "Add Folder".</div><ul><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> Add <code>src/android/</code></div></li><li |
||||||
|
class="level2"><div |
||||||
Work in progress … |
class="li"> Remove <code>src/desktop</code></div></li><li |
||||||
</p> |
class="level2"><div |
||||||
|
class="li"> Remove <code>src/desktop_fx</code></div></li></ul></li><li |
||||||
<p> |
class="level1"><div |
||||||
A jme3 application can either be deployed to the desktop (as Java Swing application) and web browser (as JNLP/WebStart or Applet), or to an Android phone. While the former is the default, switching to Android deployment can be done in a few steps. |
class="li"> build.xml…</div></li></ol></div><h2><a |
||||||
|
name="build_and_run">Build and Run</a></h2><div |
||||||
</p> |
class="level2"><p> That's it!</p><ol><li |
||||||
<ol> |
class="level1"><div |
||||||
<li><div> Open Project Properties, go to Sources category.</div> |
class="li"> Right-click the jme3 project node and "Clean and Build" the project.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> At Source Packages Folders, click “Add Folder”. </div> |
class="li"> In the Projects window, browse to the <code>src/test/jme3test</code> folder.</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Add <code>src/android/</code></div> |
class="li"> Right-click e.g. the file <code>src/test/jme3test/model/TestHoverTank.java</code> and choose "Run" to run a sample.</div><ol><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> Remove <code>src/desktop</code></div> |
class="li"> In the sample application, use the mouse and the AWSD keys to move around the test object.</div></li><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> Remove <code>src/desktop_fx</code></div> |
class="li"> Press escape to quit the sample application.</div></li></ol></li></ol><p> Sample code for cool features is in the <code>src/test/jme3test</code> folder. A sample game can be found in <code>src/games/jme3game/cubefield/CubeField.java</code>.</p><p> Tips:</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> To run runnable classes from the Projects window, right-click and choose Run.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> build.xml…</div> |
class="li"> To run any runnable class that is open in the editor, press shift-F6.</div></li></ul></div><h2><a |
||||||
</li> |
name="optionaljavadoc_popups_and_source_navigation_in_netbeans">Optional: Javadoc Popups and Source Navigation in NetBeans</a></h2><div |
||||||
</ol> |
class="level2"><p> If you are working on the jme3 sources:</p><ol><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> In the Projects window, right-click the jme3 project and choose Generate Javadoc. Wait.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Build and Run</a></h2> |
class="li"> Confirm in the Files window that the javadoc has been created in <code>~/NetBeansProjects/jme3/dist/javadoc</code></div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> In the editor, place the caret in a jme class and press ctrl-space to view javadoc.</div></li></ol><p> If you are working on a game project that depends on jme3:</p><ol><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> First follow the previous tip. (In the future, we may offer jme javadoc as download instead.)</div></li><li |
||||||
That's it! |
class="level1"><div |
||||||
</p> |
class="li"> In your game project, right-click the Libraries node and choose "Properties".</div></li><li |
||||||
<ol> |
class="level1"><div |
||||||
<li><div> Right-click the jme3 project node and “Clean and Build” the project.</div> |
class="li"> In the Library properties, select jme3.jar and click the Edit button.</div><ol><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> In the Projects window, browse to the <code>src/test/jme3test</code> folder. </div> |
class="li"> For the Javadoc field, browse to <code>~/NetBeansProjects/jme3/dist/javadoc</code>. Check "as relative path" and click select.</div></li><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> Right-click e.g. the file <code>src/test/jme3test/model/TestHoverTank.java</code> and choose “Run” to run a sample. </div> |
class="li"> For the Sources field, browse to <code>~/NetBeansProjects/jme3/src</code>. Check "as relative path" and click select.</div></li><li |
||||||
<ol> |
class="level2"><div |
||||||
<li><div> In the sample application, use the mouse and the AWSD keys to move around the test object.</div> |
class="li"> Click OK.</div></li></ol></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Press escape to quit the sample application.</div> |
class="li"> In the editor, place the caret in a jme class and press ctrl-space to view javadoc. Ctrl-click any jme3 method to jump to its definition in the sources.</div></li></ol><p> This tip works for any third-party JAR library that you use. (You may have to download the javadoc/sources from their home page separately).</p><hr |
||||||
</li> |
/><p> Sources used: <a |
||||||
</ol> |
href="http://code.google.com/p/jmonkeyengine/wiki/BuildJme3">BuildJme3</a>, <a |
||||||
</li> |
href="http://www.jmonkeyengine.com/forum/index.php?topic=13108.0">netbeans tutorial from forum</a></p></div> |
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Sample code for cool features is in the <code>src/test/jme3test</code> folder. A sample game can be found in <code>src/games/jme3game/cubefield/CubeField.java</code>. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Tips: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> To run runnable classes from the Projects window, right-click and choose Run.</div> |
|
||||||
</li> |
|
||||||
<li><div> To run any runnable class that is open in the editor, press shift-F6.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Optional: Javadoc Popups and Source Navigation in NetBeans</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
If you are working on the jme3 sources: |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> In the Projects window, right-click the jme3 project and choose Generate Javadoc. Wait.</div> |
|
||||||
</li> |
|
||||||
<li><div> Confirm in the Files window that the javadoc has been created in <code>~/NetBeansProjects/jme3/dist/javadoc</code></div> |
|
||||||
</li> |
|
||||||
<li><div> In the editor, place the caret in a jme class and press ctrl-space to view javadoc.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
If you are working on a game project that depends on jme3: |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> First follow the previous tip. (In the future, we may offer jme javadoc as download instead.)</div> |
|
||||||
</li> |
|
||||||
<li><div> In your game project, right-click the Libraries node and choose “Properties”.</div> |
|
||||||
</li> |
|
||||||
<li><div> In the Library properties, select jme3.jar and click the Edit button.</div> |
|
||||||
<ol> |
|
||||||
<li><div> For the Javadoc field, browse to <code>~/NetBeansProjects/jme3/dist/javadoc</code>. Check “as relative path” and click select.</div> |
|
||||||
</li> |
|
||||||
<li><div> For the Sources field, browse to <code>~/NetBeansProjects/jme3/src</code>. Check “as relative path” and click select.</div> |
|
||||||
</li> |
|
||||||
<li><div> Click OK.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
<li><div> In the editor, place the caret in a jme class and press ctrl-space to view javadoc. Ctrl-click any jme3 method to jump to its definition in the sources. </div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
This tip works for any third-party JAR library that you use. (You may have to download the javadoc/sources from their home page separately). |
|
||||||
</p> |
|
||||||
<hr /> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Sources used: <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/wiki/BuildJme3"><param name="text" value="<html><u>BuildJme3</u></html>"><param name="textColor" value="blue"></object>, <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.jmonkeyengine.com/forum/index.php?topic=13108.0"><param name="text" value="<html><u>netbeans tutorial from forum</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:build_jme3_sources_with_netbeans?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:build_jme3_sources_with_netbeans?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,41 +1,10 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Multithreading Bullet Physics in jme3</a></h1> |
name="multithreading_bullet_physics_in_jme3">Multithreading Bullet Physics in jme3</a></h1><div |
||||||
<div> |
class="level1"></div><h2><a |
||||||
|
name="introduction">Introduction</a></h2><div |
||||||
</div> |
class="level2"><p> Since bullet is not (yet) multithreaded or GPU accelerated the jME3 implementation allows to run each physics space on a separate thread that is executed in parallel to rendering.</p></div><h2><a |
||||||
|
name="how_is_it_handled_in_jme3_and_bullet">How is it handled in jme3 and bullet?</a></h2><div |
||||||
<h2><a>Introduction</a></h2> |
class="level2"><p> A SimpleApplication with a BulletAppState allows setting the threading type via</p><pre>setThreadingType(ThreadingType type);</pre><p> where ThreadingType can be either SEQUENTIAL or PARALLEL.</p><p> In the simpleInitApp() method:</p><pre>bulletAppState = new BulletAppState(); |
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
Since bullet is not (yet) multithreaded or GPU accelerated the jME3 implementation allows to run each physics space on a separate thread that is executed in parallel to rendering. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>How is it handled in jme3 and bullet?</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A SimpleApplication with a BulletAppState allows setting the threading type via |
|
||||||
</p> |
|
||||||
<pre>setThreadingType(ThreadingType type);</pre> |
|
||||||
|
|
||||||
<p> |
|
||||||
where ThreadingType can be either SEQUENTIAL or PARALLEL. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
In the simpleInitApp() method: |
|
||||||
</p> |
|
||||||
<pre>bulletAppState = new BulletAppState(); |
|
||||||
bulletAppState.setThreadingType(BulletAppState.ThreadingType.PARALLEL); |
bulletAppState.setThreadingType(BulletAppState.ThreadingType.PARALLEL); |
||||||
stateManager.attach(bulletAppState);</pre> |
stateManager.attach(bulletAppState);</pre><p> The physics update happens in parallel to rendering, after the users changes have been made in the update() call. This way the loop logic is still maintained: the user can set and change values in physics and scenegraph objects before render() and physicsUpdate() are called in parallel.</p></div> |
||||||
<p> |
|
||||||
The physics update happens in parallel to rendering, after the users changes have been made in the update() call. This way the loop logic is still maintained: the user can set and change values in physics and scenegraph objects before render() and physicsUpdate() are called in parallel. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:bullet_multithreading?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:bullet_multithreading?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,106 +1,77 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jME3 Application Display Settings</a></h1> |
name="jme3_application_display_settings">jME3 Application Display Settings</a></h1><div |
||||||
<div> |
class="level1"><p> Every class that extends jme3.app.Application (or jme3.app.SimpleApplication) has properties that can be configured by customizing a <code>com.jme3.system.AppSettings</code> object. Configure the settings before you call <code>app.start()</code> on the application object. If you change display settings during runtime, call <code>app.restart()</code> to make them take effect.</p><p> <strong>Note:</strong> Other runtime settings are covered in <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/intermediate/simpleapplication.html">SimpleApplication</a>.</p></div><h2><a |
||||||
<p> |
name="code_sample">Code Sample</a></h2><div |
||||||
|
class="level2"><pre>AppSettings settings = new AppSettings(true); |
||||||
Every class that extends jme3.app.Application (or jme3.app.SimpleApplication) has properties that can be configured by customizing a <code>com.jme3.system.AppSettings</code> object. Configure the settings before you call <code>app.start()</code> on the application object. If you change display settings during runtime, call <code>app.restart()</code> to make them take effect. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<strong>Note:</strong> Other runtime settings are covered in <a href="/com/jme3/gde/core/docs/jme3/intermediate/simpleapplication.html">SimpleApplication</a>. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Code Sample</a></h2> |
|
||||||
<div> |
|
||||||
<pre>AppSettings settings = new AppSettings(true); |
|
||||||
settings.setRenderer(AppSettings.LWJGL_OPENGL3); |
settings.setRenderer(AppSettings.LWJGL_OPENGL3); |
||||||
Application app = new Application(); |
Application app = new Application(); |
||||||
app.setSettings(settings); |
app.setSettings(settings); |
||||||
app.start();</pre> |
app.start();</pre><p> Set the boolean in the AppSettings contructor to true if you want to keep the default settings for everything that you do not specify. Set this parameter to false if you want to specify each property yourself (you'll get an exception if you missed one).</p><p> Use <code>app.setShowSettings(false);</code> to disable the default settings-window at startup.</p></div><h2><a |
||||||
<p> |
name="properties">Properties</a></h2><div |
||||||
Set the boolean in the AppSettings contructor to true if you want to keep the default settings for everything that you do not specify. Set this parameter to false if you want to specify each property yourself (you'll get an exception if you missed one). |
class="level2"><div |
||||||
</p> |
class="table sectionedit1"><table |
||||||
|
class="inline"><tr |
||||||
<p> |
class="row0"><th |
||||||
Use <code>app.setShowSettings(false);</code> to disable the default settings-window at startup. |
class="col0">Property</th><th |
||||||
</p> |
class="col1">Dscription</th><th |
||||||
|
class="col2">Default</th></tr><tr |
||||||
</div> |
class="row1"><td |
||||||
|
class="col0">setRenderer(AppSettings.LWJGL_OPENGL2) <br/> setRenderer(AppSettings.LWJGL_OPENGL3)</td><td |
||||||
<h2><a>Properties</a></h2> |
class="col1">Switch Video Renderer</td><td |
||||||
<div> |
class="col2">OpenGL 2</td></tr><tr |
||||||
<table> |
class="row2"><td |
||||||
<tr> |
class="col0">setAudioRenderer(AppSettings.LWJGL_OPENAL) <br/> setAudioRenderer(AppSettings.LWJGL_JOAL)</td><td |
||||||
<th>Property</th><th>Dscription</th><th>Default</th> |
class="col1">Switch Audio Renderer</td><td |
||||||
</tr> |
class="col2">OpenAL</td></tr><tr |
||||||
<tr> |
class="row3"><td |
||||||
<td>setRenderer(AppSettings.LWJGL_OPENGL2) <br/> |
class="col0">setBitsPerPixel(8)</td><td |
||||||
setRenderer(AppSettings.LWJGL_OPENGL3)</td><td>Switch Video Renderer</td><td>OpenGL 2</td> |
class="col1">Set color depth. <br/> 1 = black and white, 2 bit = gray, <br/> 4 = 16 colors, 8 = 256 colors, 24 or 32 = "truecolor".</td><td |
||||||
</tr> |
class="col2">24</td></tr><tr |
||||||
<tr> |
class="row4"><td |
||||||
<td>setAudioRenderer(AppSettings.LWJGL_OPENAL) <br/> |
class="col0">setFrequency(60)</td><td |
||||||
setAudioRenderer(AppSettings.LWJGL_JOAL)</td><td>Switch Audio Renderer</td><td>OpenAL</td> |
class="col1">The screen frequency (refresh rate of the graphics card), usually 60 or 75 fps.</td><td |
||||||
</tr> |
class="col2">60 fps</td></tr><tr |
||||||
<tr> |
class="row5"><td |
||||||
<td>setBitsPerPixel(8)</td><td>Set color depth. <br/> |
class="col0">setFramerate(60)</td><td |
||||||
1 = black and white, 2 bit = gray, <br/> |
class="col1">How often per second the engine should try to refresh the frame. For the release, usually 60 fps. Can be lower (59-30) for FX-intensive games. Do not set to a higher value than the screen frequency.</td><td |
||||||
4 = 16 colors, 8 = 256 colors, 24 or 32 = “truecolor”.</td><td>24</td> |
class="col2">-1 (auto)</td></tr><tr |
||||||
</tr> |
class="row6"><td |
||||||
<tr> |
class="col0">setFullscreen(true)</td><td |
||||||
<td>setFrequency(60)</td><td>The screen frequency (refresh rate of the graphics card), usually 60 or 75 fps.</td><td>60 fps</td> |
class="col1">Set this to true to make the display fill the whole screen; you need to provide a key that calls app.stop() to exit the fullscreen view gracefully (default: escape). <br/> Set it to false to play the game in a normal window of its own.</td><td |
||||||
</tr> |
class="col2">False (windowed)</td></tr><tr |
||||||
<tr> |
class="row7"><td |
||||||
<td>setFramerate(60)</td><td>How often per second the engine should try to refresh the frame. For the release, usually 60 fps. Can be lower (59-30) for FX-intensive games. Do not set to a higher value than the screen frequency.</td><td>-1 (auto)</td> |
class="col0">setHeight(480), setWidth(640) <br/> setResolution(640,480)</td><td |
||||||
</tr> |
class="col1">Two equivalent ways of setting the display resolution.</td><td |
||||||
<tr> |
class="col2">640x480 pixels</td></tr><tr |
||||||
<td>setFullscreen(true)</td><td>Set this to true to make the display fill the whole screen; you need to provide a key that calls app.stop() to exit the fullscreen view gracefully (default: escape). <br/> |
class="row8"><td |
||||||
Set it to false to play the game in a normal window of its own.</td><td>False (windowed)</td> |
class="col0">setSamples(4)</td><td |
||||||
</tr> |
class="col1">Set multisampling to 0 to switch antialiasing off (harder edges, faster.) <br/> Set multisampling to 2 or 4 to activate antialising (softer edges, may be slower.) <br/> Depending on your graphic card, you may be able to go set multisampling to 8, 16, or 32 samples.</td><td |
||||||
<tr> |
class="col2">0</td></tr><tr |
||||||
<td>setHeight(480), setWidth(640) <br/> |
class="row9"><td |
||||||
setResolution(640,480)</td><td>Two equivalent ways of setting the display resolution.</td><td>640×480 pixels</td> |
class="col0">setVSync(true)</td><td |
||||||
</tr> |
class="col1">Set vertical syncing to true to time the frame buffer to coincide with the refresh interval of the screen: Prevents page tearing, but slower; recommened for release. <br/> Set to false to deactivate vertical syncing (faster, but possible page tearing artifacts); can be deactivated during development.</td><td |
||||||
<tr> |
class="col2">false</td></tr><tr |
||||||
<td>setSamples(4)</td><td>Set multisampling to 0 to switch antialiasing off (harder edges, faster.) <br/> |
class="row10"><td |
||||||
Set multisampling to 2 or 4 to activate antialising (softer edges, may be slower.) <br/> |
class="col0">useInput(false)</td><td |
||||||
Depending on your graphic card, you may be able to go set multisampling to 8, 16, or 32 samples.</td><td>0</td> |
class="col1">Respond to user input by mouse and keyboard. Can be deactivated for use cases where you only display a 3D scene on the canvas without any interaction.</td><td |
||||||
</tr> |
class="col2">true</td></tr><tr |
||||||
<tr> |
class="row11"><td |
||||||
<td>setVSync(true)</td><td>Set vertical syncing to true to time the frame buffer to coincide with the refresh interval of the screen: Prevents page tearing, but slower; recommened for release. <br/> |
class="col0">useJoysticks(true)</td><td |
||||||
Set to false to deactivate vertical syncing (faster, but possible page tearing artifacts); can be deactivated during development.</td><td>false</td> |
class="col1">Activate optional joystick support</td><td |
||||||
</tr> |
class="col2">false</td></tr><tr |
||||||
<tr> |
class="row12"><td |
||||||
<td>useInput(false)</td><td>Respond to user input by mouse and keyboard. Can be deactivated for use cases where you only display a 3D scene on the canvas without any interaction.</td><td>true</td> |
class="col0">setSettingsDialogImage("/path/in/assets.png")</td><td |
||||||
</tr> |
class="col1">A custom image to display when the settings dialog is shown.</td><td |
||||||
<tr> |
class="col2">"/com/jme3/app/Monkey.png"</td></tr><tr |
||||||
<td>useJoysticks(true)</td><td>Activate optional joystick support</td><td>false</td> |
class="row13"><td |
||||||
</tr> |
class="col0">setTitle("My Game")</td><td |
||||||
<tr> |
class="col1">This string will be visible in the titlebar, unless the window is fullscreen.</td><td |
||||||
<td>setSettingsDialogImage(”/path/in/assets.png”)</td><td>A custom image to display when the settings dialog is shown.</td><td>”/com/jme3/app/Monkey.png”</td> |
class="col2">"jMonkey Engine 3.0"</td></tr></table></div></div><h2><a |
||||||
</tr> |
name="methods">Methods</a></h2><div |
||||||
<tr> |
class="level2"><p> An AppSettings object also supports the following methods:</p><ul><li |
||||||
<td>setTitle(“My Game”)</td><td>This string will be visible in the titlebar, unless the window is fullscreen.</td><td>“jMonkey Engine 3.0”</td> |
class="level1"><div |
||||||
</tr> |
class="li"> Use <code>settings.save(outstream)</code> and <code>settings.load(instream)</code> to save and load your settings via standard java.io serialization.</div></li><li |
||||||
</table> |
class="level1"><div |
||||||
|
class="li"> Use <code>newSettings.copyFrom(oldSettings)</code> to copy a settings object.</div></li></ul></div> |
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Methods</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
An AppSettings object also supports the following methods: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Use <code>settings.save(outstream)</code> and <code>settings.load(instream)</code> to save and load your settings via standard java.io serialization.</div> |
|
||||||
</li> |
|
||||||
<li><div> Use <code>newSettings.copyFrom(oldSettings)</code> to copy a settings object.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:appsettings?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:appsettings?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,508 +1,271 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Best Practices For jME3 Developers</a></h1> |
name="best_practices_for_jme3_developers">Best Practices For jME3 Developers</a></h1><div |
||||||
<div> |
class="level1"><p> A collection of recommendations and expert tips. Feel free to add your own!</p><p> If you are a beginner, you should first <a |
||||||
|
href="http://www.gamedevlessons.com/?page=free">read some</a> <a |
||||||
<p> |
href="http://gamasutra.com/">articles about</a> <a |
||||||
|
href="http://www.google.com/search?q=3d+game+development">game development</a>. We cannot cover all general tips here.</p></div><h2><a |
||||||
A collection of recommendations and expert tips. Feel free to add your own! |
name="requirements_gathering">Requirements Gathering</a></h2><div |
||||||
</p> |
class="level2"><p> As a quick overview, answer yourself the following questions:</p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Motivation</div><ul><li |
||||||
If you are a beginner, you should first <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.gamedevlessons.com/?page=free"><param name="text" value="<html><u>read some</u></html>"><param name="textColor" value="blue"></object> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://gamasutra.com/"><param name="text" value="<html><u>articles about</u></html>"><param name="textColor" value="blue"></object> game development. We cannot cover all general tips here. |
class="level2"><div |
||||||
</p> |
class="li"> Sum up your game idea in one sentence. If you can't, it's too complicated.</div></li><li |
||||||
|
class="level2"><div |
||||||
</div> |
class="li"> Who's the target group? Why would they choose your game over the million others that exist?</div></li></ul></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Requirements Gathering</a></h2> |
class="li"> Game type</div><ul><li |
||||||
<div> |
class="level2"><div |
||||||
|
class="li"> Point of view (camera)? What character(s) does the player control (if any)?</div></li><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> Time- or turn-based?</div></li><li |
||||||
As a quick overview, answer yourself the following questions: |
class="level2"><div |
||||||
|
class="li"> Genre, setting, background story? (If applicable)</div></li></ul></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> Gameplay</div><ul><li |
||||||
<li><div> Motivation</div> |
class="level2"><div |
||||||
<ul> |
class="li"> What is the start state, what is the end state?</div></li><li |
||||||
<li><div> Sum up your game idea in one sentence. If you can't, it's too complicated.</div> |
class="level2"><div |
||||||
</li> |
class="li"> What resources does the player manage? How are resources gained, transformed, spent? E.g. speed, gold, health, "points".</div></li><li |
||||||
<li><div> Who's the target group? Why would they choose your game over the million others that exist? </div> |
class="level2"><div |
||||||
</li> |
class="li"> How does the player interact? I.e. rules, challenges, game mechanics.</div></li><li |
||||||
</ul> |
class="level2"><div |
||||||
</li> |
class="li"> What state is considered winning, and what losing?</div></li></ul></li><li |
||||||
<li><div> Game type</div> |
class="level1"><div |
||||||
<ul> |
class="li"> Media assets</div><ul><li |
||||||
<li><div> Point of view (camera)? What character(s) does the player control (if any)? </div> |
class="level2"><div |
||||||
</li> |
class="li"> Which media will you need? How will you get this content? <br/> models, terrains; materials, textures; audio, sound, music; video; spoken/written dialog; levels, quests, stories; AI scripts</div></li></ul></li><li |
||||||
<li><div> Time- or turn-based? </div> |
class="level1"><div |
||||||
</li> |
class="li"> Interface</div><ul><li |
||||||
<li><div> Genre, setting, background story? (If applicable)</div> |
class="level2"><div |
||||||
</li> |
class="li"> Can you achieve a high degree of input control? Even minor navigation and interaction glitches make the game unsolvable.</div></li><li |
||||||
</ul> |
class="level2"><div |
||||||
</li> |
class="li"> Clearly reflect current status, and changes in game states. E.g. health/damage.</div></li><li |
||||||
<li><div> Gameplay</div> |
class="level2"><div |
||||||
<ul> |
class="li"> Clearly reward good moves and discourage bad ones.</div></li></ul></li></ul></div><h2><a |
||||||
<li><div> What is the start state, what is the end state? </div> |
name="planning_development_milestones">Planning Development Milestones</a></h2><div |
||||||
</li> |
class="level2"><ol><li |
||||||
<li><div> What resources does the player manage? How are resources gained, transformed, spent? E.g. speed, gold, health, “points”.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Pre-Alpha</div><ol><li |
||||||
<li><div> How does the player interact? I.e. rules, challenges, game mechanics.</div> |
class="level2"><div |
||||||
</li> |
class="li"> Lay out the overall application flow using mock-ups or stock art. E.g. switching between intro screen / options screen / game screen.</div></li><li |
||||||
<li><div> What state is considered winning, and what losing?</div> |
class="level2"><div |
||||||
</li> |
class="li"> Get one typical level working. E.g. if it's a "Jump'n'Run", jumping and running must work before you can call it an Alpha.</div></li></ol></li><li |
||||||
</ul> |
class="level1"><div |
||||||
</li> |
class="li"> Alpha</div><ol><li |
||||||
<li><div> Media assets</div> |
class="level2"><div |
||||||
<ul> |
class="li"> Run internal tests, debug, optimize (issue tracker).</div></li><li |
||||||
<li><div> Which media will you need? How will you get this content? <br/> |
class="level2"><div |
||||||
models, terrains; materials, textures; audio, sound, music; video; spoken/written dialog; levels, quests, stories; AI scripts </div> |
class="li"> Replace all mock-ups with first drafts of real media and levels.</div></li><li |
||||||
</li> |
class="level2"><div |
||||||
</ul> |
class="li"> Feature Freeze: Avoid a bottomless pit of side effects causing new issues.</div></li></ol></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Interface </div> |
class="li"> Beta</div><ol><li |
||||||
<ul> |
class="level2"><div |
||||||
<li><div> Can you achieve a high degree of input control? Even minor navigation and interaction glitches make the game unsolvable.</div> |
class="li"> Have external people review and "beta test" it (issue tracker).</div></li><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> Clearly reflect current status, and changes in game states. E.g. health/damage.</div> |
class="li"> Even out the kinks in the code – don't add any more new features.</div></li><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> Clearly reward good moves and discourage bad ones.</div> |
class="li"> Fill in all final content.</div></li></ol></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Gamma, Delta = Release Candidates</div><ol><li |
||||||
</li> |
class="level2"><div |
||||||
</ul> |
class="li"> Last chance to find a horrible bug.</div></li></ol></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Omega = Final Release</div></li></ol><p> How you actually name or number these milestones is up to you. People use the words "milestone", Greek letters, version numbers, or combinations thereof.</p><p> Every milestone is made up of a development phase and a test phase. Here are some best practices:</p></div><h2><a |
||||||
|
name="development_phase">Development Phase</a></h2><div |
||||||
<h2><a>Planning Development Milestones</a></h2> |
class="level2"></div><h3><a |
||||||
<div> |
name="where_to_start">Where to Start?</a></h3><div |
||||||
<ol> |
class="level3"><p> You have a list of features that you want in game, but which one do you implement first? You will keep adding features to a project that grows more and more complex, how can you minimize the amount of rewriting required?</p><ol><li |
||||||
<li><div> Pre-Alpha</div> |
class="level1"><div |
||||||
<ol> |
class="li"> Start with implementing the most complex game feature first – the one that imposes most constraints on the structure of your project (for instance, networking.)</div></li><li |
||||||
<li><div> Lay out the overall application flow using mock-ups or stock art. E.g. switching between intro screen / options screen / game screen.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Make sure the game's high-level frame (screen switching, networking, physics, loading/saving) is sound and solid before you implement low-level details of gameplay.</div></li><li |
||||||
<li><div> Get one typical level working. E.g. if it's a “Jump'n'Run”, jumping and running must work before you can call it an Alpha.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Only add one larger feature at a time. If there are complex interactions (such as "networking + physics"), start with a small test case ("one cube") and work your way up, don't start with a whole scene.</div></li><li |
||||||
</ol> |
class="level1"><div |
||||||
</li> |
class="li"> Test for side-effects on existing code before you add the next feature.</div></li></ol><p> Acknowledge whether you want a feature because it is necessary for gameplay, or simply because "everyone else has it". Successful high-performance games are the ones where someone made smart decisions what to keep and what to drop.</p><ul><li |
||||||
<li><div> Alpha</div> |
class="level1"><div |
||||||
<ol> |
class="li"> Example: Everybody wants "full physics, AI, post-rendering effects, and multi-player networking"… Make certain you truly understand what that requires (e.g. client-server synchonization)! Your goal should be to bring out the essence of your game idea, don't water down gameplay but attempting to make it "do everything, but better".</div></li></ul></div><h3><a |
||||||
<li><div> Run internal tests, debug, optimize (issue tracker).</div> |
name="extend_simpleapplication">Extend SimpleApplication</a></h3><div |
||||||
</li> |
class="level3"><p> Typically, developers extend a custom class off of jME3's com.jme3.app.SimpleApplication (or even com.jme3.app.Application). For a racing game you would create a different base game class than for a space game or a shooter.</p><ol><li |
||||||
<li><div> Replace all mock-ups with first drafts of real media and levels.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Create a generic game class for your custom game:</div><ol><li |
||||||
<li><div> Feature Freeze: Avoid a bottomless pit of side effects causing new issues.</div> |
class="level3"><div |
||||||
</li> |
class="li"> Create a jME3-based project with all necessary JARs on the classpath.</div></li><li |
||||||
</ol> |
class="level3"><div |
||||||
</li> |
class="li"> Create a class in this package that extends SimpleApplication, name it something like <code>my.company.MyBaseGame.java</code>.</div></li><li |
||||||
<li><div> Beta</div> |
class="level3"><div |
||||||
<ol> |
class="li"> Implement all generic features that the game type needs in the MyBaseGame class. For example methods for loading and saving scenes, physics, networking and multi-player logon screen, switching to settings screen, etc.</div></li><li |
||||||
<li><div> Have external people review and “beta test” it (issue tracker).</div> |
class="level3"><div |
||||||
</li> |
class="li"> Include generic assets (company logo, reusable <acronym |
||||||
<li><div> Even out the kinks in the code – don't add any more new features.</div> |
title="Graphical User Interface">GUI</acronym> elements in your company style, etc) in the MyBaseGame's assets directory.</div></li></ol></li><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> Fill in all final content.</div> |
class="li"> Create your actual game, e.g. a shooter:</div><ol><li |
||||||
</li> |
class="level3"><div |
||||||
</ol> |
class="li"> Create another jME3-based project, and a new package for the game itself, e.g. <code>my.company.zombieshooter.MyGame.java</code>.</div></li><li |
||||||
</li> |
class="level3"><div |
||||||
<li><div> Gamma, Delta = Release Candidates</div> |
class="li"> Add MyBaseGame.jar to the classpath of MyGame.java.</div></li><li |
||||||
<ol> |
class="level3"><div |
||||||
<li><div> Last chance to find a horrible bug.</div> |
class="li"> Make MyGame.java's main class extend MyBaseGame.</div></li><li |
||||||
</li> |
class="level3"><div |
||||||
</ol> |
class="li"> The specific assets (scenes, models) of this game go into MyGame's own assets folder.</div></li><li |
||||||
</li> |
class="level3"><div |
||||||
<li><div> Omega = Final Release</div> |
class="li"> Now implement this game's mechanics and levels – without having to worry about logon&settings screens and all the other features that you already dealt with in MyBaseGame.</div></li></ol></li></ol></div><h3><a |
||||||
</li> |
name="controls_and_appstates_--_the_smart_way_to_implement_game_logic">Controls and AppStates -- The Smart Way to Implement Game Logic</a></h3><div |
||||||
</ol> |
class="level3"><p> As your jME3-based application grows more advanced, you may find yourself putting more and more tests in the simpleUpdate() loop, and passing around lots of object references. Don't implement game behaviour by copying and pasting boilerplate code! It is a best practice to move game behaviour into classes of their own. In jME3 these classes are Controls and AppStates.</p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Use Controls to implement the behaviour of types of game entities. A character control that defines how this type of Spatials moves, an animation control that plays animations in this type of Spatial's model, etc.</div></li><li |
||||||
|
class="level1"><div |
||||||
How you actually name or number these milestones is up to you. People use the words “milestone”, Greek letters, version numbers, or combinations thereof. |
class="li"> Use AppStates to implement global game behaviour: A physics manager, a custom artificial intelligence manager, etc.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Use the simpleUpdate() loop for the remaining "one-off" tests and interactions.</div></li></ul><p> Both classes automatically hook into the main update loop. Instead of remote controlling game entities via simpleUpdate(), you define the desired behaviour in the update methods of custom Controls and AppStates. You then add Controls to Spatials, and AppStates to the application, and jME3 will automatically trigger the update methods. This cleans up your simpleUpdate() loop code considerably.</p><p> Learn more about <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/jme3/advanced/custom_controls.html">Custom Controls</a> and <a |
||||||
Every milestone is made up of a development phase and a test phase. Here are some best practices: |
href="/com/jme3/gde/core/docs/jme3/advanced/application_states.html">Application States</a>.</p></div><h3><a |
||||||
</p> |
name="optimize_application_performance">Optimize Application Performance</a></h3><div |
||||||
|
class="level3"><ul><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
<h2><a>Development Phase</a></h2> |
href="/com/jme3/gde/core/docs/jme3/intermediate/optimization.html">Optimization</a></div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
</div> |
href="/com/jme3/gde/core/docs/jme3/advanced/multithreading.html">Multithreading</a></div></li></ul></div><h3><a |
||||||
|
name="use_an_assets_folder">Use an Assets Folder</a></h3><div |
||||||
<h3><a>Where to Start?</a></h3> |
class="level3"><p> Put your assets into subfolders of your project's <code>assets</code> directory. This is the default path where the assetManager looks for files.</p><pre>jMonkeyProjects/Pong/assets/ # Store assets here |
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You have a list of features that you want in game, but which one do you implement first? You will keep adding features to a project that grows more and more complex, how can you minimize the amount of rewriting required? |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Start with implementing the most complex game feature first – the one that imposes most constraints on the structure of your project (for instance, networking.)</div> |
|
||||||
</li> |
|
||||||
<li><div> Make sure the game's high-level frame (screen switching, networking, physics, loading/saving) is sound and solid before you implement low-level details of gameplay. </div> |
|
||||||
</li> |
|
||||||
<li><div> Only add one larger feature at a time. If there are complex interactions (such as “networking + physics”), start with a small test case (“one cube”) and work your way up, don't start with a whole scene.</div> |
|
||||||
</li> |
|
||||||
<li><div> Test for side-effects on existing code before you add the next feature.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Acknowledge whether you want a feature because it is necessary for gameplay, or simply because “everyone else has it”. Successful high-performance games are the ones where someone made smart decisions what to keep and what to drop. |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Example: Everybody wants “full physics, AI, post-rendering effects, and multi-player networking”… Make certain you truly understand what that requires (e.g. client-server synchonization)! Your goal should be to bring out the essence of your game idea, don't water down gameplay but attempting to make it “do everything, but better”. </div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Extend SimpleApplication</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Typically, developers extend a custom class off of jME3's com.jme3.app.SimpleApplication (or even com.jme3.app.Application). For a racing game you would create a different base game class than for a space game or a shooter. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Create a generic game class for your custom game:</div> |
|
||||||
<ol> |
|
||||||
<li><div> Create a jME3-based project with all necessary JARs on the classpath. </div> |
|
||||||
</li> |
|
||||||
<li><div> Create a class in this package that extends SimpleApplication, name it something like <code>my.company.MyBaseGame.java</code>.</div> |
|
||||||
</li> |
|
||||||
<li><div> Implement all generic features that the game type needs in the MyBaseGame class. For example methods for loading and saving scenes, physics, networking and multi-player logon screen, switching to settings screen, etc. </div> |
|
||||||
</li> |
|
||||||
<li><div> Include generic assets (company logo, reusable <acronym title="Graphical User Interface">GUI</acronym> elements in your company style, etc) in the MyBaseGame's assets directory.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
<li><div> Create your actual game, e.g. a shooter: </div> |
|
||||||
<ol> |
|
||||||
<li><div> Create another jME3-based project, and a new package for the game itself, e.g. <code>my.company.zombieshooter.MyGame.java</code>. </div> |
|
||||||
</li> |
|
||||||
<li><div> Add MyBaseGame.jar to the classpath of MyGame.java.</div> |
|
||||||
</li> |
|
||||||
<li><div> Make MyGame.java's main class extend MyBaseGame. </div> |
|
||||||
</li> |
|
||||||
<li><div> The specific assets (scenes, models) of this game go into MyGame's own assets folder.</div> |
|
||||||
</li> |
|
||||||
<li><div> Now implement this game's mechanics and levels – without having to worry about logon&settings screens and all the other features that you already dealt with in MyBaseGame.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Controls and AppStates -- The Smart Way to Implement Game Logic</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
As your jME3-based application grows more advanced, you may find yourself putting more and more tests in the simpleUpdate() loop, and passing around lots of object references. Don't implement game behaviour by copying and pasting boilerplate code! It is a best practice to move game behaviour into classes of their own. In jME3 these classes are Controls and AppStates. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Use Controls to implement the behaviour of types of game entities. A character control that defines how this type of Spatials moves, an animation control that plays animations in this type of Spatial's model, etc.</div> |
|
||||||
</li> |
|
||||||
<li><div> Use AppStates to implement global game behaviour: A physics manager, a custom artificial intelligence manager, etc.</div> |
|
||||||
</li> |
|
||||||
<li><div> Use the simpleUpdate() loop for the remaining “one-off” tests and interactions.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Both classes automatically hook into the main update loop. Instead of remote controlling game entities via simpleUpdate(), you define the desired behaviour in the update methods of custom Controls and AppStates. You then add Controls to Spatials, and AppStates to the application, and jME3 will automatically trigger the update methods. This cleans up your simpleUpdate() loop code considerably. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Learn more about <a href="/com/jme3/gde/core/docs/jme3/advanced/custom_controls.html">Custom Controls</a> and <a href="/com/jme3/gde/core/docs/jme3/advanced/application_states.html">Application States</a>. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Optimize Application Performance</a></h3> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/intermediate/optimization.html">Optimization</a></div> |
|
||||||
</li> |
|
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/multithreading.html">Multithreading</a></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Use an Assets Folder</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Put your assets into subfolders of your project's <code>assets</code> directory. This is the default path where the assetManager looks for files. |
|
||||||
</p> |
|
||||||
<pre> |
|
||||||
jMonkeyProjects/Pong/assets/ # Store assets here |
|
||||||
jMonkeyProjects/Pong/build/ # jMP generates built classes here * |
jMonkeyProjects/Pong/build/ # jMP generates built classes here * |
||||||
jMonkeyProjects/Pong/build.xml # Customize Ant build script here |
jMonkeyProjects/Pong/build.xml # Customize Ant build script here |
||||||
jMonkeyProjects/Pong/nbproject/ # jMP stores default build.xml and meta data * |
jMonkeyProjects/Pong/nbproject/ # jMP stores default build.xml and meta data * |
||||||
jMonkeyProjects/Pong/dist/ # jMP generates executables here * |
jMonkeyProjects/Pong/dist/ # jMP generates executables here * |
||||||
jMonkeyProjects/Pong/src/ # Store Java sources here |
jMonkeyProjects/Pong/src/ # Store Java sources here |
||||||
jMonkeyProjects/Pong/test/ # Store test classes here (optional) |
jMonkeyProjects/Pong/test/ # Store test classes here (optional) |
||||||
(*) managed by jMonkeyPlatform, don't edit |
(*) managed by jMonkeyPlatform, don't edit</pre><ul><li |
||||||
</pre> |
class="level1"><div |
||||||
<ul> |
class="li"> Agree on a file and directory naming scheme with the designers.</div><ul><li |
||||||
<li><div> Agree on a file and directory naming scheme with the designers.</div> |
class="level2"><div |
||||||
<ul> |
class="li"> Are there assets (models, sound files, …) that will be used interchangeably? Then name or number them in a way so that the developer can swap the assets by swapping part of the path string.</div></li><li |
||||||
<li><div> Are there assets (models, sound files, …) that will be used interchangeably? Then name or number them in a way so that the developer can swap the assets by swapping part of the path string.</div> |
class="level2"><div |
||||||
</li> |
class="li"> Decide on naming standards for naming interactive parts of models (e.g. arms/legs in an animation).</div></li></ul></li><li |
||||||
<li><div> Decide on naming standards for naming interactive parts of models (e.g. arms/legs in an animation).</div> |
class="level1"><div |
||||||
</li> |
class="li"> Structure the subfolders of <code>assets</code> in any way that suits the project – but stick with one system.</div><ul><li |
||||||
</ul> |
class="level2"><div |
||||||
</li> |
class="li"> Either keep all Textures together with their Ogre meshes in the Model directory.</div></li><li |
||||||
<li><div> Structure the subfolders of <code>assets</code> in any way that suits the project – but stick with one system. </div> |
class="level2"><div |
||||||
<ul> |
class="li"> Or keep the Ogre meshes with their Textures in the Textures directory. (Recommended.)</div></li></ul></li><li |
||||||
<li><div> Either keep all Textures together with their Ogre meshes in the Model directory.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Place reusable Textures and Materials (the ones that you set programmatically) into the Textures and Materials directory, respectively.</div></li><li |
||||||
<li><div> Or keep the Ogre meshes with their Textures in the Textures directory. (Recommended.)</div> |
class="level1"><div |
||||||
</li> |
class="li"> If different types of assets (materials, textures, models) belong together, create a parallel subdirectory structure for them: <code>Textures/vehicles/car/</code>, <code>Materials/vehicles/car/</code>, <code>Models/vehicles/car/</code></div></li></ul><p> Here is an example of a commonly used directory structure:</p><pre>jMonkeyProjects/Pong/assets/Interface/ # .font, .jpg, .png, .xml |
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> Place reusable Textures and Materials (the ones that you set programmatically) into the Textures and Materials directory, respectively.</div> |
|
||||||
</li> |
|
||||||
<li><div> If different types of assets (materials, textures, models) belong together, create a parallel subdirectory structure for them: <code>Textures/vehicles/car/</code>, <code>Materials/vehicles/car/</code>, <code>Models/vehicles/car/</code></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Here is an example of a commonly used directory structure: |
|
||||||
</p> |
|
||||||
<pre> |
|
||||||
jMonkeyProjects/Pong/assets/Interface/ # .font, .jpg, .png, .xml |
|
||||||
jMonkeyProjects/Pong/assets/MatDefs/ # .j3md |
jMonkeyProjects/Pong/assets/MatDefs/ # .j3md |
||||||
jMonkeyProjects/Pong/assets/Materials/ # .j3m |
jMonkeyProjects/Pong/assets/Materials/ # .j3m |
||||||
jMonkeyProjects/Pong/assets/Models/ # .j3o |
jMonkeyProjects/Pong/assets/Models/ # .j3o |
||||||
jMonkeyProjects/Pong/assets/Scenes/ # .j3o |
jMonkeyProjects/Pong/assets/Scenes/ # .j3o |
||||||
jMonkeyProjects/Pong/assets/Shaders/ # .vert, .frag |
jMonkeyProjects/Pong/assets/Shaders/ # .vert, .frag |
||||||
jMonkeyProjects/Pong/assets/Sounds/ # .ogg, .wav |
jMonkeyProjects/Pong/assets/Sounds/ # .ogg, .wav |
||||||
jMonkeyProjects/Pong/assets/Textures/ # .mesh.xml+.material, .mtl+.obj, .jpg, .png |
jMonkeyProjects/Pong/assets/Textures/ # .mesh.xml+.material, .mtl+.obj, .jpg, .png</pre><p> See also: <a |
||||||
</pre> |
href="/com/jme3/gde/core/docs/sdk/asset_packs.html">Asset Packs</a></p></div><h3><a |
||||||
|
name="don_t_mess_with_geometric_state">Don't Mess With Geometric State</a></h3><div |
||||||
<p> |
class="level3"><p> Here are some tips especially for users who already know jME2. Automatic handling of the Geometric State has improved in jME3, and it is now a best practice to <em>not</em> mess with it.</p><ul><li |
||||||
See also: <a href="/com/jme3/gde/core/docs/sdk/asset_packs.html">Asset Packs</a> |
class="level1"><div |
||||||
</p> |
class="li"> Do not call updateGeometricState() on anything but the root node!</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Do not override or mess with updateGeometricState() at all.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h3><a>Don't Mess With Geometric State</a></h3> |
class="li"> Do not use getLocalTranslation().set() to move a spatial, always use setLocalTranslation().</div></li></ul></div><h3><a |
||||||
<div> |
name="maintain_internal_documentation">Maintain Internal Documentation</a></h3><div |
||||||
|
class="level3"><p> It's unlikely you will be willing to fully document every class you write. You should at minimum javadoc all crucial methods/parameters in a meaningful way.</p><ul><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Answer three questions for every crucial method/parameter:</div><ul><li |
||||||
Here are some tips especially for users who already know jME2. Automatic handling of the Geometric State has improved in jME3, and it is now a best practice to <em>not</em> mess with it. |
class="level2"><div |
||||||
|
class="li"> What is this?</div></li><li |
||||||
</p> |
class="level2"><div |
||||||
<ul> |
class="li"> How does it solve its task? (e.g. algorithm used)</div></li><li |
||||||
<li><div> Do not call updateGeometricState() on anything but the root node!</div> |
class="level2"><div |
||||||
</li> |
class="li"> In which situation do I want to use this?</div></li></ul></li><li |
||||||
<li><div> Do not override or mess with updateGeometricState() at all.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Write down limits (e.g. min/max values) and defaults while you still remember.</div></li><li |
||||||
<li><div> Do not use getLocalTranslation().set() to move a spatial, always use setLocalTranslation().</div> |
class="level1"><div |
||||||
</li> |
class="li"> Is this optional or required? What are the alternatives?</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> Treat javadoc as messages to your future self. "genNextVal() generates the next value" and "@param float factor A factor influencing the result" do <em>not</em> count as documentation.</div></li></ul></div><h3><a |
||||||
</div> |
name="use_version_control">Use Version Control</a></h3><div |
||||||
|
class="level3"><p> Whether you work in a team or alone, keeping a version controlled repository of your code will help you roll-back buggy changes or recover that code that you or someone deleted and now is needed.</p><ul><li |
||||||
<h3><a>Maintain Internal Documentation</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> Treat commit messages as messages to your future self. "Made some changes" is <em>not</em> a commit message.</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> The jMonkeyPlatform supports Subversion, Mercurial, and <acronym |
||||||
|
title="Concurrent Versions System">CVS</acronym>.</div><ul><li |
||||||
It's unlikely you will be willing to fully document every class you write. You should at minimum javadoc all crucial methods/parameters in a meaningful way. |
class="level2"><div |
||||||
|
class="li"> If you don't know which to choose, Subversion is a good choice for starters.</div></li><li |
||||||
</p> |
class="level2"><div |
||||||
<ul> |
class="li"> You can get free project hosting space from various open-source dev portals like <a |
||||||
<li><div> Answer three questions for every crucial method/parameter:</div> |
href="http://sourceforge.net/">Sourceforge</a>, <a |
||||||
<ul> |
href="https://github.com/">Github</a>, <a |
||||||
<li><div> What is this? </div> |
href="https://bitbucket.org/">bitbucket</a> or <a |
||||||
</li> |
href="https://code.google.com">Google Code</a>. <a |
||||||
<li><div> How does it solve its task? (e.g. algorithm used)</div> |
href="https://bitbucket.org/">Bitbucket</a> support private projects.</div></li></ul></li></ul></div><h3><a |
||||||
</li> |
name="convert_models_to_j3o_format">Convert Models to .j3o Format</a></h3><div |
||||||
<li><div> In which situation do I want to use this? </div> |
class="level3"><p> From the beta on, convert all Ogre mesh models and scenes to the binary .j3o format. Use the jMonkeyPlatform for the conversion, and save the .j3o files into the Models directory.</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> .j3o is an optimized format to store part of a jME3 scenegraph. <br/> It can contain an individual model or a whole scene. Optionally (using the jMonkeyEngine SceneComposer) you can include the model's physical properties, materials, lights, particle emitters, and audio nodes.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Write down limits (e.g. min/max values) and defaults while you still remember. </div> |
class="li"> If you kept the Ogre mesh together with the textures in the Textures directory during the conversion, the paths are recorded in a way so that you can move the .j3o to another directory, and it will still find its textures.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Is this optional or required? What are the alternatives?</div> |
class="li"> The default Ant build script copies .j3o / .j3m files and other assets into the distributable JAR automatically.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Treat javadoc as messages to your future self. “genNextVal() generates the next value” and ”@param float factor A factor influencing the result” do <em>not</em> count as documentation. </div> |
class="li"> Important: Other model files however (.mesh.xml, .material, .obj, .mat) are not bundled automatically. You will get a runtime error that a resource was not found if you try to run the JAR with code referring to these files.</div></li></ul></div><h2><a |
||||||
</li> |
name="debugging_and_test_phase">Debugging and Test Phase</a></h2><div |
||||||
</ul> |
class="level2"></div><h3><a |
||||||
|
name="test">Test</a></h3><div |
||||||
</div> |
class="level3"><p> Unit Tests (Java Assertions) have a different status in 3D graphics development than in other types of software. You cannot write any assertions that automatically test whether the rendered image looks correct, or whether interactions are intuitive. Still you should create simple test cases for separate game features such as loaders, content generators, effects. Run them now and then to see whether they still work as intended – or whether they are affected by side effects. Keep the test classes in a test directory in the project, but don't include them in the distribution.</p><p> Quality Assurance (QA) means maintaining a clear list of steps that must always work, and checking them. There can be bugs in software, but tasks such as installing and de-installing, saving and loading, starting/pausing/quitting the game, <em>must work</em>, no excuse. After every milestone, you go through the list again, on every supported operating system, and systematically look for regressions or bugs.</p><p> Alpha and Beta Testing means that you ask someone to try to install and run your game. It should be a real user situation, where they are left to figure it out by themselves (you only can include the usual read-me and help docs). Provide the testers with an easy method to report back descriptions of their problems, e.g. why they gave up. Evaluate whether these problems are exceptions or must be fixed for the game to be playable.</p></div><h3><a |
||||||
|
name="debug">Debug</a></h3><div |
||||||
<h3><a>Use Version Control</a></h3> |
class="level3"><p> A Java Debugger is included in the jMonkeyPlatform. It allows you to set a break point in your code near the point where an exception happens. Then you step through the execution line by line and watch object and variable states to detect where the bug starts.</p><p> Use the <a |
||||||
<div> |
href="/com/jme3/gde/core/docs/jme3/advanced/logging.html">Logger</a> to print status messages during the development and debugging phase, instead of System.out.println().</p></div><h3><a |
||||||
|
name="enhance_performance">Enhance Performance</a></h3><div |
||||||
<p> |
class="level3"><p> A Java Profiler can be added to the jMonkeyPlatform via Tools → Plugins → Available. The profiler presents statistics on the lifecycle of methods and objects. Performance problems may be caused by just a few methods that take long, or are called too often. If object creation and garbage collection counts keep increasing, you are looking at a memory leak.</p></div><h2><a |
||||||
|
name="release_phase">Release Phase</a></h2><div |
||||||
Whether you work in a team or alone, keeping a version controlled repository of your code will help you roll-back buggy changes or recover that code that you or someone deleted and now is needed. |
class="level2"><p> <strong>Pre-Release To-Do List</strong></p><ul><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> Verify that all assets are up-to-date and converted to .j3o.</div></li><li |
||||||
<li><div> Treat commit messages as messages to your future self. “Made some changes” is <em>not</em> a commit message.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Prepare licenses of assets that you use for inclusion (you <em>did</em> obtain permission to use them, right…?)</div></li><li |
||||||
<li><div> The jMonkeyPlatform supports Subversion, Mercurial, and <acronym title="Concurrent Versions System">CVS</acronym>. </div> |
class="level1"><div |
||||||
<ul> |
class="li"> Switch off fine <a |
||||||
<li><div> If you don't know which to choose, Subversion is a good choice for starters. </div> |
href="/com/jme3/gde/core/docs/jme3/advanced/logging.html">logging</a> output.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> You can get free project hosting space from various open-source dev portals like <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://sourceforge.net/"><param name="text" value="<html><u>Sourceforge</u></html>"><param name="textColor" value="blue"></object>, <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="https://github.com/"><param name="text" value="<html><u>Github</u></html>"><param name="textColor" value="blue"></object>, <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="https://bitbucket.org/"><param name="text" value="<html><u>bitbucket</u></html>"><param name="textColor" value="blue"></object> or <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="https://code.google.com"><param name="text" value="<html><u>Google Code</u></html>"><param name="textColor" value="blue"></object>. <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="https://bitbucket.org/"><param name="text" value="<html><u>Bitbucket</u></html>"><param name="textColor" value="blue"></object> support private projects.</div> |
class="li"> Prepare promotional art: Cool screenshots (in thumbnail, square, vertical, horizontal, and fullscreen formats) and video clips. Include name, contact info, slogan, etc so customers can find you.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Prepare a web page, start getting advertisment slots, etc</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Prepare a readme.txt file, or installation guide, or handbook – if applicable.</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Get a certificate if it is required for your distribution method (see below).</div></li><li |
||||||
|
class="level1"><div |
||||||
<h3><a>Convert Models to .j3o Format</a></h3> |
class="li"> Specify a classification rating.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> …</div></li></ul><p> <strong>Distributable Executable</strong></p><p> The <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/sdk.html">SDK</a> can help you with deployment. Do you release your game as WebStart, Desktop JAR, or Applet? Each has its pros and cons.</p><div |
||||||
|
class="table sectionedit1"><table |
||||||
From the beta on, convert all Ogre mesh models and scenes to the binary .j3o format. Use the jMonkeyPlatform for the conversion, and save the .j3o files into the Models directory. |
class="inline"><tr |
||||||
|
class="row0"><th |
||||||
</p> |
class="col0">Distribution</th><th |
||||||
<ul> |
class="col1">Pros</th><th |
||||||
<li><div> .j3o is an optimized format to store part of a jME3 scenegraph. <br/> |
class="col2">Cons</th></tr><tr |
||||||
It can contain an individual model or a whole scene. Optionally (using the jMonkeyEngine SceneComposer) you can include the model's physical properties, materials, lights, particle emitters, and audio nodes.</div> |
class="row1"><td |
||||||
</li> |
class="col0">Desktop Launcher <br/> (.EXE, .app, .jar+.sh)</td><td |
||||||
<li><div> If you kept the Ogre mesh together with the textures in the Textures directory during the conversion, the paths are recorded in a way so that you can move the .j3o to another directory, and it will still find its textures.</div> |
class="col1">This is the standard way of distributing desktop applications. The jMonkeyPlatform can be configured to automatically create zipped launchers for each operating system.</td><td |
||||||
</li> |
class="col2">You need to offer three separate, platform-dependent downloads.</td></tr><tr |
||||||
<li><div> The default Ant build script copies .j3o / .j3m files and other assets into the distributable JAR automatically. </div> |
class="row2"><td |
||||||
</li> |
class="col0">Desktop Application <br/> (.JAR)</td><td |
||||||
<li><div> Important: Other model files however (.mesh.xml, .material, .obj, .mat) are not bundled automatically. You will get a runtime error that a resource was not found if you try to run the JAR with code referring to these files. </div> |
class="col1">Platform independent desktop application.</td><td |
||||||
</li> |
class="col2">User must have Java configured to run JARs when they are opened; or user must know how to run JARs from command line; or you must provide a custom JAR wrapper.</td></tr><tr |
||||||
</ul> |
class="row3"><td |
||||||
|
class="col0">Web Start <br/> (.JNLP)</td><td |
||||||
</div> |
class="col1">The user accesses a <acronym |
||||||
|
title="Uniform Resource Locator">URL</acronym>, saves the game as one executable file. Easy process, no installer required. You can allow the game to be played offline.</td><td |
||||||
<h2><a>Debugging and Test Phase</a></h2> |
class="col2">Users need network connection to install the game. Downloading bigger games takes a while as opposed to running them from a CD.</td></tr><tr |
||||||
<div> |
class="row4"><td |
||||||
|
class="col0">Browser Applet <br/> (.<acronym |
||||||
</div> |
title="HyperText Markup Language">HTML</acronym>+.JAR)</td><td |
||||||
|
class="col1">Easy to access and play game via most web browsers. Userfriendly solution for quick small games.</td><td |
||||||
<h3><a>Test</a></h3> |
class="col2">Game only runs in the browser. Game or settings cannot be saved to disk. Some restrictions in default camera navigation (jME cannot capture mouse.)</td></tr></table></div><p> Which ever method you choose, a Java-Application works on the three main operating systems: Windows, Mac <acronym |
||||||
<div> |
title="Operating System">OS</acronym>, Linux.</p></div> |
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Unit Tests (Java Assertions) have a different status in 3D graphics development than in other types of software. You cannot write any assertions that automatically test whether the rendered image looks correct, or whether interactions are intuitive. Still you should create simple test cases for separate game features such as loaders, content generators, effects. Run them now and then to see whether they still work as intended – or whether they are affected by side effects. Keep the test classes in a test directory in the project, but don't include them in the distribution. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Quality Assurance (QA) means maintaining a clear list of steps that must always work, and checking them. There can be bugs in software, but tasks such as installing and de-installing, saving and loading, starting/pausing/quitting the game, <em>must work</em>, no excuse. After every milestone, you go through the list again, on every supported operating system, and systematically look for regressions or bugs. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Alpha and Beta Testing means that you ask someone to try to install and run your game. It should be a real user situation, where they are left to figure it out by themselves (you only can include the usual read-me and help docs). Provide the testers with an easy method to report back descriptions of their problems, e.g. why they gave up. Evaluate whether these problems are exceptions or must be fixed for the game to be playable. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Debug</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A Java Debugger is included in the jMonkeyPlatform. It allows you to set a break point in your code near the point where an exception happens. Then you step through the execution line by line and watch object and variable states to detect where the bug starts. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Use the <a href="/com/jme3/gde/core/docs/jme3/advanced/logging.html">Logger</a> to print status messages during the development and debugging phase, instead of System.out.println(). |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Enhance Performance</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A Java Profiler can be added to the jMonkeyPlatform via Tools → Plugins → Available. The profiler presents statistics on the lifecycle of methods and objects. Performance problems may be caused by just a few methods that take long, or are called too often. If object creation and garbage collection counts keep increasing, you are looking at a memory leak. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Release Phase</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<strong>Pre-Release To-Do List</strong> |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Verify that all assets are up-to-date and converted to .j3o.</div> |
|
||||||
</li> |
|
||||||
<li><div> Prepare licenses of assets that you use for inclusion (you <em>did</em> obtain permission to use them, right…?)</div> |
|
||||||
</li> |
|
||||||
<li><div> Switch off fine <a href="/com/jme3/gde/core/docs/jme3/advanced/logging.html">logging</a> output.</div> |
|
||||||
</li> |
|
||||||
<li><div> Prepare promotional art: Cool screenshots (in thumbnail, square, vertical, horizontal, and fullscreen formats) and video clips. Include name, contact info, slogan, etc so customers can find you.</div> |
|
||||||
</li> |
|
||||||
<li><div> Prepare a web page, start getting advertisment slots, etc</div> |
|
||||||
</li> |
|
||||||
<li><div> Prepare a readme.txt file, or installation guide, or handbook – if applicable.</div> |
|
||||||
</li> |
|
||||||
<li><div> Get a certificate if it is required for your distribution method (see below).</div> |
|
||||||
</li> |
|
||||||
<li><div> Specify a classification rating.</div> |
|
||||||
</li> |
|
||||||
<li><div> …</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<strong>Distributable Executable</strong> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
The <a href="/com/jme3/gde/core/docs/sdk.html">SDK</a> can help you with deployment. Do you release your game as WebStart, Desktop JAR, or Applet? Each has its pros and cons. |
|
||||||
|
|
||||||
</p> |
|
||||||
<table> |
|
||||||
<tr> |
|
||||||
<th>Distribution</th><th>Pros</th><th>Cons</th> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Desktop Launcher <br/> |
|
||||||
(.EXE, .app, .jar+.sh)</td><td>This is the standard way of distributing desktop applications. The jMonkeyPlatform can be configured to automatically create zipped launchers for each operating system. </td><td>You need to offer three separate, platform-dependent downloads.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Desktop Application <br/> |
|
||||||
(.JAR)</td><td>Platform independent desktop application. </td><td>User must have Java configured to run JARs when they are opened; or user must know how to run JARs from command line; or you must provide a custom JAR wrapper.</td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Web Start <br/> |
|
||||||
(.JNLP)</td><td>The user accesses a <acronym title="Uniform Resource Locator">URL</acronym>, saves the game as one executable file. Easy process, no installer required. You can allow the game to be played offline.</td><td>Users need network connection to install the game. Downloading bigger games takes a while as opposed to running them from a CD. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td>Browser Applet <br/> |
|
||||||
(.<acronym title="HyperText Markup Language">HTML</acronym>+.JAR)</td><td>Easy to access and play game via most web browsers. Userfriendly solution for quick small games.</td><td>Game only runs in the browser. Game or settings cannot be saved to disk. Some restrictions in default camera navigation (jME cannot capture mouse.)</td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Which ever method you choose, a Java-Application works on the three main operating systems: Windows, Mac <acronym title="Operating System">OS</acronym>, Linux. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:best_practices?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:best_practices?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,56 +1,60 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jMonkeyEngine3 Supported File Types</a></h1> |
name="jmonkeyengine3_supported_file_types">jMonkeyEngine3 Supported File Types</a></h1><div |
||||||
<div> |
class="level1"></div><h2><a |
||||||
|
name="jmonkeyengine3_file_formats">jMonkeyEngine3 File Formats</a></h2><div |
||||||
</div> |
class="level2"><div |
||||||
|
class="table sectionedit1"><table |
||||||
<h2><a>jMonkeyEngine3 File Formats</a></h2> |
class="inline"><tr |
||||||
<div> |
class="row0"><th |
||||||
<table> |
class="col0">Suffix</th><th |
||||||
<tr> |
class="col1">Usage</th><th |
||||||
<th>Suffix</th><th>Usage</th><th>Learn more</th> |
class="col2">Learn more</th></tr><tr |
||||||
</tr> |
class="row1"><td |
||||||
<tr> |
class="col0">.j3o</td><td |
||||||
<td>.j3o</td><td>Binary 3D model or scene. From the Beta release of your game on, you should convert all models to .j3o format. During alpha and earlier development phases (when models still change a lot) you can alternatively load OgreXML/OBJ models directly.</td><td><a href="/com/jme3/gde/core/docs/sdk/model_loader_and_viewer.html">Model Loader and Viewer</a> </td> |
class="col1">Binary 3D model or scene. From the Beta release of your game on, you should convert all models to .j3o format. During alpha and earlier development phases (when models still change a lot) you can alternatively load OgreXML/OBJ models directly.</td><td |
||||||
</tr> |
class="col2"><a |
||||||
<tr> |
href="/com/jme3/gde/core/docs/sdk/model_loader_and_viewer.html">Model Loader and Viewer</a></td></tr><tr |
||||||
<td>.j3m</td><td>A custom Material. You create these Material objects to store Material configurations for your 3D models.</td><td><a href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a> <a href="/com/jme3/gde/core/docs/sdk/material_editing.html">Material Editing</a> </td> |
class="row2"><td |
||||||
</tr> |
class="col0">.j3m</td><td |
||||||
<tr> |
class="col1">A custom Material. You create these Material objects to store Material configurations for your 3D models.</td><td |
||||||
<td>.j3md</td><td>A Material definition. These are templates for advanced shader-based Materials. Each custom .j3m Material is based on a .j3md Material Definition. </td><td> <a href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a> </td> |
class="col2 leftalign"><a |
||||||
</tr> |
href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a> <a |
||||||
</table> |
href="/com/jme3/gde/core/docs/sdk/material_editing.html">Material Editing</a></td></tr><tr |
||||||
|
class="row3"><td |
||||||
</div> |
class="col0">.j3md</td><td |
||||||
|
class="col1">A Material definition. These are templates for advanced shader-based Materials. Each custom .j3m Material is based on a .j3md Material Definition.</td><td |
||||||
<h2><a>Supported External File Types</a></h2> |
class="col2"> <a |
||||||
<div> |
href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a></td></tr></table></div></div><h2><a |
||||||
<table> |
name="supported_external_file_types">Supported External File Types</a></h2><div |
||||||
<tr> |
class="level2"><div |
||||||
<th>File Suffix</th><th>Description</th> |
class="table sectionedit2"><table |
||||||
</tr> |
class="inline"><tr |
||||||
<tr> |
class="row0"><th |
||||||
<td>.mesh.xml, .meshxml, .scene</td><td>Ogre Mesh <acronym title="Extensible Markup Language">XML</acronym> for 3D models, Ogre DotScene for 3D scenes </td> |
class="col0">File Suffix</th><th |
||||||
</tr> |
class="col1">Description</th></tr><tr |
||||||
<tr> |
class="row1"><td |
||||||
<td>.OBJ, .MTL</td><td>Wavefront, 3D model format</td> |
class="col0">.mesh.xml, .meshxml, .scene</td><td |
||||||
</tr> |
class="col1">Ogre Mesh <acronym |
||||||
<tr> |
title="Extensible Markup Language">XML</acronym> for 3D models, Ogre DotScene for 3D scenes</td></tr><tr |
||||||
<td>.<acronym title="Joint Photographics Experts Group">JPG</acronym>, .<acronym title="Portable Network Graphics">PNG</acronym>, .<acronym title="Graphics Interchange Format">GIF</acronym></td><td>2D Images, textures</td> |
class="row2"><td |
||||||
</tr> |
class="col0">.OBJ, .MTL</td><td |
||||||
<tr> |
class="col1">Wavefront, 3D model format</td></tr><tr |
||||||
<td>.DDS, .HDR, .PFM, .TGA</td><td>Textures</td> |
class="row3"><td |
||||||
</tr> |
class="col0">.<acronym |
||||||
<tr> |
title="Joint Photographics Experts Group">JPG</acronym>, .<acronym |
||||||
<td>.fnt</td><td>Bitmap fonts</td> |
title="Portable Network Graphics">PNG</acronym>, .<acronym |
||||||
</tr> |
title="Graphics Interchange Format">GIF</acronym></td><td |
||||||
<tr> |
class="col1">2D Images, textures</td></tr><tr |
||||||
<td>.WAV, .OGG</td><td>Wave and OGG Vorbis audio</td> |
class="row4"><td |
||||||
</tr> |
class="col0">.DDS, .HDR, .PFM, .TGA</td><td |
||||||
<tr> |
class="col1">Textures</td></tr><tr |
||||||
<td>.OGV</td><td>Ogg Theora video</td> |
class="row5"><td |
||||||
</tr> |
class="col0">.fnt</td><td |
||||||
</table> |
class="col1">Bitmap fonts</td></tr><tr |
||||||
|
class="row6"><td |
||||||
</div> |
class="col0">.WAV, .OGG</td><td |
||||||
|
class="col1">Wave and OGG Vorbis audio</td></tr><tr |
||||||
|
class="row7"><td |
||||||
|
class="col0">.OGV</td><td |
||||||
|
class="col1">Ogg Theora video</td></tr></table></div></div> |
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:file_types?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:file_types?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,78 +1,37 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jME3 Headless Server</a></h1> |
name="jme3_headless_server">jME3 Headless Server</a></h1><div |
||||||
<div> |
class="level1"><p> When adding multiplayer to your game, you may find that your server needs to know about game state (e.g. where are players, objects? Was that a direct hit? etc.) You can code all this up yourself, but there's an easier way.</p><p> It's very easy to change your current (client) game to function as a server as well.</p></div><h2><a |
||||||
|
name="client_code">Client Code</a></h2><div |
||||||
<p> |
class="level2"><p> First, let's take a look at the default way of creating a new game (in its simplest form):</p><pre>public static void main(String[] args) { |
||||||
|
|
||||||
When adding multiplayer to your game, you may find that your server needs to know about game state (e.g. where are players, objects? Was that a direct hit? etc.) You can code all this up yourself, but there's an easier way. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
It's very easy to change your current (client) game to function as a server as well. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Client Code</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
First, let's take a look at the default way of creating a new game (in its simplest form): |
|
||||||
</p> |
|
||||||
<pre>public static void main(String[] args) { |
|
||||||
Application app = new Main(); |
Application app = new Main(); |
||||||
app.start(); |
app.start(); |
||||||
}</pre> |
}</pre></div><h2><a |
||||||
</div> |
name="headless_server_code">Headless Server Code</a></h2><div |
||||||
|
class="level2"><p> Now, with a simple change you can start your game in Headless mode. This means that all input and audio/visual output will be ignored. That's a good thing for a server.</p><pre>import com.jme3.system.JmeContext; |
||||||
<h2><a>Headless Server Code</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Now, with a simple change you can start your game in Headless mode. This means that all input and audio/visual output will be ignored. That's a good thing for a server. |
|
||||||
</p> |
|
||||||
<pre>import com.jme3.system.JmeContext; |
|
||||||
import com.jme3.system.JmeContext.Type; |
import com.jme3.system.JmeContext.Type; |
||||||
|
|
||||||
public static void main(String[] args) { |
public static void main(String[] args) { |
||||||
Application app = new Main(); |
Application app = new Main(); |
||||||
app.start(JmeContext.Type.Headless); |
app.start(JmeContext.Type.Headless); |
||||||
}</pre> |
}</pre><p><p><div |
||||||
<p> |
class="noteclassic">Although all input/output is ignored, the server <em>does</em> keep game state and <em>does</em> call the <code>simpleUpdate()</code> as expected.</div></p></p></div><h2><a |
||||||
<p><div>Although all input/output is ignored, the server <em>does</em> keep game state and <em>does</em> call the <code>simpleUpdate()</code> as expected. |
name="next_steps">Next steps</a></h2><div |
||||||
</div></p> |
class="level2"><p> Okay, so you can now start your game in a headless 'server mode', where to go from here?</p><ul><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Parse <code>String[] args</code> from the <code>main</code>-method to enable server mode on demand (e.g. start your server like <code>java -jar mygame.jar –server</code>.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Integrate <a |
||||||
<h2><a>Next steps</a></h2> |
href="/com/jme3/gde/core/docs/spidermonkey.html">SpiderMonkey</a>, to provide game updates to the server over a network.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> Only execute code that's needed. (E.g. place all rendering code inside an <code>if (servermode)</code>-block) (or <code>if (!servermode)</code> for the client).</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Add decent <a |
||||||
Okay, so you can now start your game in a headless 'server mode', where to go from here? |
href="/com/jme3/gde/core/docs/jme3/advanced/logging.html">logging</a> so your server actually makes sense.</div></li></ul><div |
||||||
|
class="tags"><span> <a |
||||||
</p> |
href="/wiki/doku.php/tag:intermediate?do=showtag&tag=tag%3Aintermediate">intermediate</a>, <a |
||||||
<ul> |
href="/wiki/doku.php/tag:server?do=showtag&tag=tag%3Aserver">server</a>, <a |
||||||
<li><div> Parse <code>String[] args</code> from the <code>main</code>-method to enable server mode on demand (e.g. start your server like <code>java -jar mygame.jar –server</code>.</div> |
href="/wiki/doku.php/tag:spidermonkey?do=showtag&tag=tag%3Aspidermonkey">spidermonkey</a>, <a |
||||||
</li> |
href="/wiki/doku.php/tag:headless?do=showtag&tag=tag%3Aheadless">headless</a>, <a |
||||||
<li><div> Integrate <a href="/com/jme3/gde/core/docs/spidermonkey.html">SpiderMonkey</a>, to provide game updates to the server over a network.</div> |
href="/wiki/doku.php/tag:network?do=showtag&tag=tag%3Anetwork">network</a>, <a |
||||||
</li> |
href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a> </span></div></div> |
||||||
<li><div> Only execute code that's needed. (E.g. place all rendering code inside an <code>if (servermode)</code>-block) (or <code>if (!servermode)</code> for the client).</div> |
|
||||||
</li> |
|
||||||
<li><div> Add decent <a href="/com/jme3/gde/core/docs/jme3/advanced/logging.html">logging</a> so your server actually makes sense.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
<div><span> |
|
||||||
<a href="/wiki/doku.php/tag:intermediate?do=showtag&tag=tag%3Aintermediate">intermediate</a>, |
|
||||||
<a href="/wiki/doku.php/tag:server?do=showtag&tag=tag%3Aserver">server</a>, |
|
||||||
<a href="/wiki/doku.php/tag:spidermonkey?do=showtag&tag=tag%3Aspidermonkey">spidermonkey</a>, |
|
||||||
<a href="/wiki/doku.php/tag:headless?do=showtag&tag=tag%3Aheadless">headless</a>, |
|
||||||
<a href="/wiki/doku.php/tag:network?do=showtag&tag=tag%3Anetwork">network</a>, |
|
||||||
<a href="/wiki/doku.php/tag:documentation?do=showtag&tag=tag%3Adocumentation">documentation</a> |
|
||||||
</span></div> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:headlessserver?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:headlessserver?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,54 +1,42 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Optimization reference</a></h1> |
name="optimization_reference">Optimization reference</a></h1><div |
||||||
<div> |
class="level1"><p> This page is intended as a reference collection of optimization tricks that can be used to speed up JME3 applications.</p></div><h2><a |
||||||
|
name="maintain_low_geometry_count">Maintain low Geometry count</a></h2><div |
||||||
<p> |
class="level2"><p> The more Geometry objects are added to the scene, the harder it gets to handle them in a speedy fashion. |
||||||
|
The reson for this is, that for every object a render command must be done, here is a bottleneck betwenn the CPU and the Graficcard. <strong>Possible optimization techniques</strong></p><ul><li |
||||||
This page is intended as a reference collection of optimization tricks that can be used to speed up JME3 applications. |
class="level1"><div |
||||||
</p> |
class="li"> Use GeometryBatchFactory.optimize(node) to merge the meshes of the geometries contained in the given node into fewer batches (based on common Material used).</div></li></ul><p> <strong>Side-effects</strong></p><ul><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Using GeometryBatchFactory merges individual Geometries into a single mesh. Thereby it becomes hard to apply specific Materials or to remove a single Geometry. Therefore it should be used for static Geometry only that does not require frequent changes or individual materials/texturing.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Maintain low Geometry count</a></h2> |
class="li">Using Texture atlases might be a way to provide a limited individual texturing.</div></li></ul></div><h2><a |
||||||
<div> |
name="avoid_creating_new_objects">Avoid creating new objects</a></h2><div |
||||||
|
class="level2"><p> When you use math operations like vectorA.mult(vectorB); new objects are created that have to be garbage collected when you don't use them anymore. Check your math operations for opportunities to use the local version of the math operations, e.g. vectorA.multLocal(vectorB). This way the result is stored in vectorA and no new object needs to be created.</p></div><h2><a |
||||||
<p> |
name="check_the_statistics">Check the Statistics</a></h2><div |
||||||
|
class="level2"><p> SimpleApplication displays a HUD with statistics. Use <code>app.setDisplayStatView(true);</code> to activate it, and false to deactivate it. |
||||||
The more Geometry objects are added to the scene, the harder it gets to handle them in a speedy fashion. |
It counts how many FrameBuffers, Textures, or Shaders…</p><ul><li |
||||||
The reson for this is, that for every object a render command must be done, here is a bottleneck betwenn the CPU and the Graficcard. |
class="level1"><div |
||||||
</p> |
class="li"> … were switched in the last frame (S)</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> … were used during the last frame (F)</div></li><li |
||||||
<strong>Possible optimization techniques</strong> |
class="level1"><div |
||||||
</p> |
class="li"> … exist in memory (M)</div></li></ul><p> Example:</p><ul><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Use GeometryBatchFactory.optimize(node) to merge the meshes of the geometries contained in the given node into fewer batches (based on common Material used).</div> |
class="li"> Textures (M) = how many textures are currently in the OpenGL driver</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Textures(F) = how many textures were used in the last frame</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Textures(S) = how many texture switches were done in the last frame.</div></li></ul><p> Genereally jME3 is well optimized and optimizes these things correctly. The normal state is that the (S/F/M) values should be in the same order of magnitude; (S) values can be lower than (F).</p><ul><li |
||||||
|
class="level1"><div |
||||||
<strong>Side-effects</strong> |
class="li"> If the (S) values are significantly higher than the (F) values, that means there are a lot of extra switches happening which can cause a performance loss. Switches happen for instance if you have many transparent materials in your scene. In that case this tells you that you should use fewer transparent materials.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> If the (M) values are much higher than the (F) values, that means a lot more GL objects are in memory than are actually used. This can happen in rare cases, such as extremely large scenes (> 2000 wu). In this case, you should can optimize performance by identifying spatials to cull or detach.</div></li><li |
||||||
<li><div> Using GeometryBatchFactory merges individual Geometries into a single mesh. Thereby it becomes hard to apply specific Materials or to remove a single Geometry. Therefore it should be used for static Geometry only that does not require frequent changes or individual materials/texturing.</div> |
class="level1"><div |
||||||
</li> |
class="li"> The Object Count (Batch Count) is a very important value that indicates how many geometries were rendered in the last frame. In general, try to keep the object count around 100-200 to keep your game fast and responsive. If the count is permanently higher, optimize your scene via GeometryBatchFactory or other means.</div></li><li |
||||||
<li><div>Using Texture atlases might be a way to provide a limited individual texturing.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Same for Triangle Counts. If your game runs sluggishly and triangle count is high, then you are rendering too many too detailed meshes.</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> FrameBuffers: If you don't use any post-processing effects (FilterPostProcessor), this count should be zero. The more effects you use, the more FrameBuffers are in use.</div></li></ul><div |
||||||
</div> |
class="tags"><span> <a |
||||||
|
href="/wiki/doku.php/tag:performance?do=showtag&tag=tag%3Aperformance">performance</a> </span></div></div> |
||||||
<h2><a>Avoid creating new objects</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
When you use math operations like vectorA.mult(vectorB); new objects are created that have to be garbage collected when you don't use them anymore. Check your math operations for opportunities to use the local version of the math operations, e.g. vectorA.multLocal(vectorB). This way the result is stored in vectorA and no new object needs to be created. |
|
||||||
</p> |
|
||||||
<div><span> |
|
||||||
<a href="/wiki/doku.php/tag:performance?do=showtag&tag=tag%3Aperformance">performance</a> |
|
||||||
</span></div> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:optimization?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:intermediate:optimization?do=export_xhtmlbody">view online version</a></em></p> |
||||||
File diff suppressed because it is too large
Load Diff
@ -1,622 +1,261 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>3D Game Development Terminology</a></h1> |
name="d_game_development_terminology">3D Game Development Terminology</a></h1><div |
||||||
<div> |
class="level1"><p> Before you start, make certain you are familiar with the following concepts and terminology.</p></div><h1><a |
||||||
|
name="d_graphics_and_audio">3D Graphics and Audio</a></h1><div |
||||||
<p> |
class="level1"><p> <strong>OpenGL</strong> is the Open Graphics Library, a platform-independent specification for rendering 2D/3D computer graphics. For Java, there are two implementations of OpenGL-based renderers:</p><ol><li |
||||||
|
class="level1"><div |
||||||
Before you start, make certain you are familiar with the following concepts and terminology. |
class="li"> Lightweight Java Game Library (LWJGL)</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Java OpenGL (JOGL)</div></li></ol><p> <strong>OpenAL</strong> is the Open Audio Library, a platform-independent 3D audio <acronym |
||||||
</div> |
title="Application Programming Interface">API</acronym>.</p></div><h1><a |
||||||
|
name="context_display_renderer">Context, Display, Renderer</a></h1><div |
||||||
<h1><a>3D Graphics and Audio</a></h1> |
class="level1"><p> The <strong>jME Context</strong> makes settings, renderer, timer, input and event listeners, display system, accessible to a JME game.</p><ul><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> The <strong>jME Display System</strong> is what draws the custom JME window (instead of Java Swing).</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> The <strong>input system</strong> is what lets you respond to user input via mouse, keyboard, and joystick.</div></li><li |
||||||
<strong>OpenGL</strong> is the Open Graphics Library, a platform-independent specification for rendering 2D/3D computer graphics. For Java, there are two implementations of OpenGL-based renderers: |
class="level1"><div |
||||||
</p> |
class="li"> The <strong>renderer</strong> is what does all the work of calculating how to draw the 3D scenegraph to the 2D screen.</div><ul><li |
||||||
<ol> |
class="level2"><div |
||||||
<li><div> Lightweight Java Game Library (LWJGL)</div> |
class="li"> The <strong>Shader</strong> is a programmable part of the rendering pipeline. The jME3 game engine uses it to offer advanced customizable materials.</div></li></ul></li></ul></div><h1><a |
||||||
</li> |
name="geometry">Geometry</a></h1><div |
||||||
<li><div> Java OpenGL (JOGL)</div> |
class="level1"></div><h2><a |
||||||
</li> |
name="coordinates">Coordinates</a></h2><div |
||||||
</ol> |
class="level2"><p> Coordinates represent a location in a coordinate system, relative to the origin (0,0,0). m. In 3D space, you need to specify three coordinate values to locate a point: x,y,z. |
||||||
|
As opposed to a vector (which looks similar), a coordinate does not have a "direction". <a |
||||||
<p> |
href="/wiki/lib/exe/detail.php/jme3:intermediate:coordinate-system.png?id=jme3%3Aterminology"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/jme3/intermediate/coordinate-system.png?w=235&h=210" class="mediaright" align="right" alt="" width="235" height="210" /></a></p></div><h3><a |
||||||
<strong>OpenAL</strong> is the Open Audio Library, a platform-independent 3D audio <acronym title="Application Programming Interface">API</acronym>. |
name="the_origin">The Origin</a></h3><div |
||||||
</p> |
class="level3"><p> The origin is the central point in the 3D world. It's at the coordinates (0,0,0). |
||||||
|
Code sample: <code>Vector3f origin = new Vector3f( Vector3f.ZERO );</code></p></div><h2><a |
||||||
</div> |
name="vectors">Vectors</a></h2><div |
||||||
|
class="level2"><p> A vector has a length and a direction. It is used like an arrow pointing at a point in 3D space. A vector starts at the origin (0,0,0), and ends at the target coordinate (x,y,z). Backwards directions are expressed with negative values. |
||||||
<h1><a>Context, Display, Renderer</a></h1> |
Code sample: <code>Vector3f v = new Vector3f( 17 , -4 , 0 );</code></p></div><h3><a |
||||||
<div> |
name="unit_vectors">Unit Vectors</a></h3><div |
||||||
|
class="level3"><p> A <em>unit vector</em> is a basic vector with a length of 1 world unit. Since its length is fixed (and it thus can only point at one location anyway), the only interesting thing about this vector is its direction.</p><ul><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> <code>Vector3f.UNIT_X</code> = ( 1, 0, 0) = right</div></li><li |
||||||
The <strong>jME Context</strong> makes settings, renderer, timer, input and event listeners, display system, accessible to a JME game. |
class="level1"><div |
||||||
</p> |
class="li"> <code>Vector3f.UNIT_Y</code> = ( 0, 1, 0) = up</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> The <strong>jME Display System</strong> is what draws the custom JME window (instead of Java Swing). </div> |
class="li"> <code>Vector3f.UNIT_Z</code> = ( 0, 0, 1) = forwards</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> The <strong>input system</strong> is what lets you respond to user input via mouse, keyboard, and joystick.</div> |
class="li"> <code>Vector3f.UNIT_XYZ</code> = 1 wu diagonal right-up-forewards</div></li></ul></div><h3><a |
||||||
</li> |
name="normalized_vectors">Normalized Vectors</a></h3><div |
||||||
<li><div> The <strong>renderer</strong> is what does all the work of calculating how to draw the 3D scenegraph to the 2D screen.</div> |
class="level3"><p> A <em>normalized vector</em> is a custom <em>unit vector</em>. A normalized vector is not the same as a <em>(surface) normal vector</em>. |
||||||
<ul> |
|
||||||
<li><div> The <strong>Shader</strong> is a programmable part of the rendering pipeline. The jME3 game engine uses it to offer advanced customizable materials.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h1><a>Geometry</a></h1> |
|
||||||
<div> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Coordinates</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Coordinates represent a location in a coordinate system, relative to the origin (0,0,0). m. In 3D space, you need to specify three coordinate values to locate a point: x,y,z. |
|
||||||
As opposed to a vector (which looks similar), a coordinate does not have a “direction”. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/intermediate/coordinate-system.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>The Origin</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The origin is the central point in the 3D world. It's at the coordinates (0,0,0). |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Code sample: <code>Vector3f origin = new Vector3f( Vector3f.ZERO );</code> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Vectors</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A vector has a length and a direction. It is used like an arrow pointing at a point in 3D space. A vector starts at the origin (0,0,0), and ends at the target coordinate (x,y,z). Backwards directions are expressed with negative values. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Code sample: <code>Vector3f v = new Vector3f( 17 , -4 , 0 );</code> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Unit Vectors</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A <em>unit vector</em> is a basic vector with a length of 1 world unit. Since its length is fixed (and it thus can only point at one location anyway), the only interesting thing about this vector is its direction. |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <code>Vector3f.UNIT_X</code> = ( 1, 0, 0) = right</div> |
|
||||||
</li> |
|
||||||
<li><div> <code>Vector3f.UNIT_Y</code> = ( 0, 1, 0) = up</div> |
|
||||||
</li> |
|
||||||
<li><div> <code>Vector3f.UNIT_Z</code> = ( 0, 0, 1) = forwards</div> |
|
||||||
</li> |
|
||||||
<li><div> <code>Vector3f.UNIT_XYZ</code> = 1 wu diagonal right-up-forewards </div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Normalized Vectors</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A <em>normalized vector</em> is a custom <em>unit vector</em>. A normalized vector is not the same as a <em>(surface) normal vector</em>. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
When you normalize a vector, it still has the same direction, but you lose the information where the vector originally pointed. |
When you normalize a vector, it still has the same direction, but you lose the information where the vector originally pointed. |
||||||
</p> |
For instance, you normalize vectors before calculating angles.</p></div><h3><a |
||||||
|
name="surface_normals">Surface Normals</a></h3><div |
||||||
<p> |
class="level3"><p> A surface normal is a vector that is perpendicular to a plane. |
||||||
For instance, you normalize vectors before calculating angles. |
You calculate the Surface Normal by calculating the cross product.</p></div><h3><a |
||||||
</p> |
name="cross_product">Cross Product</a></h3><div |
||||||
|
class="level3"><p> The cross product is a calculation that you use to find a perpendicular vector (an orthogonal, a "right angle" at 90°). |
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Surface Normals</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A surface normal is a vector that is perpendicular to a plane. |
|
||||||
You calculate the Surface Normal by calculating the cross product. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Cross Product</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The cross product is a calculation that you use to find a perpendicular vector (an orthogonal, a “right angle” at 90°). |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
In 3D space, speaking of an orthogonal only makes sense with respect to a plane. You need two vectors to uniquely define a plane. The cross product of the two vectors, <code>v1 × v2</code>, is a new vector that is perpendicular to this plane. A vector perpendicular to a plane is a called <em>Surface Normal</em>. |
In 3D space, speaking of an orthogonal only makes sense with respect to a plane. You need two vectors to uniquely define a plane. The cross product of the two vectors, <code>v1 × v2</code>, is a new vector that is perpendicular to this plane. A vector perpendicular to a plane is a called <em>Surface Normal</em>. |
||||||
</p> |
Example: The x unit vector and the y unit vector together define the x/y plane. The vector perpendicular to them is the z axis. JME can calculate that this equation is true: <br/> <code>( Vector3f.UNIT_X.cross( Vector3f.UNIT_Y ) ).equals( Vector3f.UNIT_Z )</code> == true</p></div><h2><a |
||||||
|
name="polygon_mesh_vertex">Polygon, Mesh, Vertex</a></h2><div |
||||||
<p> |
class="level2"><p> <a |
||||||
Example: The x unit vector and the y unit vector together define the x/y plane. The vector perpendicular to them is the z axis. JME can calculate that this equation is true: <br/> |
href="/wiki/lib/exe/detail.php/jme3:dolphin-mesh.png?id=jme3%3Aterminology"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/jme3/dolphin-mesh.png" class="mediaright" align="right" alt="" /></a> Most visible objects in a 3D scene are made up of polygon meshes – characters, terrains, buildings, etc. A mesh is a grid-like structure that represents a complex shape. The advantage of a mesh is that it is mathematically simple enough to render in real time, and detailed enough to be recognizable. |
||||||
<code>( Vector3f.UNIT_X.cross( Vector3f.UNIT_Y ) ).equals( Vector3f.UNIT_Z )</code> == true |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Polygon, Mesh, Vertex</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/dolphin-mesh.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Most visible objects in a 3D scene are made up of polygon meshes – characters, terrains, buildings, etc. A mesh is a grid-like structure that represents a complex shape. The advantage of a mesh is that it is mathematically simple enough to render in real time, and detailed enough to be recognizable. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Every shape is reduced to a number of connected polygons, usually triangles; even round surfaces such as spheres are reduced to a grid of triangles. The polygons' corner points are called vertices. Every vertex is positioned at a coordinate, all vertices together describe the outline of the shape. |
Every shape is reduced to a number of connected polygons, usually triangles; even round surfaces such as spheres are reduced to a grid of triangles. The polygons' corner points are called vertices. Every vertex is positioned at a coordinate, all vertices together describe the outline of the shape. |
||||||
</p> |
You create 3D meshes in tools called mesh editors, e.g in Blender. <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/math.html">Learn more about 3D maths here.</a></p></div><h1><a |
||||||
<p> |
name="materialscolor_lighting_shading">Materials: Color, Lighting/Shading</a></h1><div |
||||||
You create 3D meshes in tools called mesh editors, e.g in Blender. |
class="level1"><p> What we call "color" is merely part of an object's light reflection. The onlooker's brain uses shading and reflecting properties to infer an object's shape and material. Factors like these make all the difference between chalk vs milk, skin vs paper, water vs plastic, etc! (<a |
||||||
</p> |
href="http://www.shaders.org/ifw2_textures/whatsin10.htm">External examples</a>)</p></div><h2><a |
||||||
|
name="color">Color</a></h2><div |
||||||
<p> |
class="level2"></div><h3><a |
||||||
<a href="/com/jme3/gde/core/docs/jme3/math.html">Learn more about 3D maths here.</a> |
name="ambient_color">Ambient color</a></h3><div |
||||||
</p> |
class="level3"><ul><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> The uniform base color of the mesh – what it looks like when not influenced by any light source.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h1><a>Materials: Color, Lighting/Shading</a></h1> |
class="li"> Usually similar to the Diffuse color.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> This is the minimum color you need for an object to be visible.</div></li></ul></div><h3><a |
||||||
<p> |
name="diffuse_color">Diffuse color</a></h3><div |
||||||
|
class="level3"><ul><li |
||||||
What we call “color” is merely part of an object's light reflection. The onlooker's brain uses shading and reflecting properties to infer an object's shape and material. Factors like these make all the difference between chalk vs milk, skin vs paper, water vs plastic, etc! (<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.shaders.org/ifw2_textures/whatsin10.htm"><param name="text" value="<html><u>External examples</u></html>"><param name="textColor" value="blue"></object>) |
class="level1"><div |
||||||
</p> |
class="li"> The base color of the mesh plus shattered light and shadows that are caused by a light source.</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Usually similar to the Ambient color.</div></li></ul></div><h2><a |
||||||
|
name="light_sources">Light Sources</a></h2><div |
||||||
<h2><a>Color</a></h2> |
class="level2"></div><h3><a |
||||||
<div> |
name="emissive_color">Emissive color</a></h3><div |
||||||
|
class="level3"><ul><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> The color of light emitted by a light source or glowing material.</div></li><li |
||||||
<h3><a>Ambient color</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> Only glowing materials such as lights have an emissive color, normal objects don't have this property.</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> The uniform base color of the mesh – what it looks like when not influenced by any light source.</div> |
class="li"> Often white (sun light).</div></li></ul></div><h2><a |
||||||
</li> |
name="reflections">Reflections</a></h2><div |
||||||
<li><div> Usually similar to the Diffuse color. </div> |
class="level2"></div><h3><a |
||||||
</li> |
name="shininess">Shininess</a></h3><div |
||||||
<li><div> This is the minimum color you need for an object to be visible.</div> |
class="level3"><ul><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Degree of shininess of a surface (0-128).</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Shiny objects have small, clearly outlined specular highlights. (E.g. glass, water, silver)</div></li><li |
||||||
|
class="level1"><div |
||||||
<h3><a>Diffuse color</a></h3> |
class="li"> Normal objects have wide, blurry specular highlights. (E.g. metal, plastic, stone, polished materials)</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
<ul> |
class="li"> Uneven objects are not shiny and have no specular highlights. (E.g. cloth, paper, wood, snow)</div></li></ul></div><h3><a |
||||||
<li><div> The base color of the mesh plus shattered light and shadows that are caused by a light source.</div> |
name="specular_color">Specular Color</a></h3><div |
||||||
</li> |
class="level3"><ul><li |
||||||
<li><div> Usually similar to the Ambient color.</div> |
class="level1"><div |
||||||
</li> |
class="li"> If the material is shiny, then the Specular Color is the color of the reflected highlights.</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> Usually the same as the emissive color of the light source (e.g. white).</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> You can use colors to achieve special specular effects, such as metallic or iridescent reflections.</div></li><li |
||||||
<h2><a>Light Sources</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> Non-shiny objects don't use a specular color.</div></li></ul><p> <a |
||||||
|
href="/wiki/lib/exe/fetch.php?hash=08b76e&media=http%3A%2F%2Fimg823.imageshack.us%2Fimg823%2F1171%2Ftanlglow2.png"><img |
||||||
</div> |
src="/wiki/lib/exe/fetch.php?hash=08b76e&w=400&h=234&media=http%3A%2F%2Fimg823.imageshack.us%2Fimg823%2F1171%2Ftanlglow2.png" class="mediacenter" alt="" width="400" height="234" /></a></p></div><h1><a |
||||||
|
name="materialstextures">Materials: Textures</a></h1><div |
||||||
<h3><a>Emissive color</a></h3> |
class="level1"><p> Textures are part of Materials. In the simplest case, an object could have just one texture, the Color Map, loaded from one image file. When you think back of old computer games you'll remember this looks quite plain. |
||||||
<div> |
The more information you (the game designer) provide additionally to the Color Map, the higher the degree of detail and realism. Whether you want photo-realistic rendering or "toon" rendering (Cel Shading), everything depends on the quality of your materials and texture maps. Modern 3D graphics use several layers of information to describe one material, each layer is a Texture Map.</p></div><h2><a |
||||||
<ul> |
name="texture_maps">Texture Maps</a></h2><div |
||||||
<li><div> The color of light emitted by a light source or glowing material. </div> |
class="level2"></div><h3><a |
||||||
</li> |
name="color_map">Color Map</a></h3><div |
||||||
<li><div> Only glowing materials such as lights have an emissive color, normal objects don't have this property. </div> |
class="level3"><p> <a |
||||||
</li> |
href="/wiki/lib/exe/fetch.php?hash=b4d15a&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FTextures%2FTerrain%2Fsplat%2Froad.jpg"><img |
||||||
<li><div> Often white (sun light).</div> |
src="/wiki/lib/exe/fetch.php?hash=b4d15a&w=64&h=64&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FTextures%2FTerrain%2Fsplat%2Froad.jpg" class="mediaright" align="right" title="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_textures_terrain_splat_road.jpg" alt="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_textures_terrain_splat_road.jpg" width="64" height="64" /></a></p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> A simple image file (or a procedural texture).</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> The image can have alpha channels for transparency.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Reflections</a></h2> |
class="li"> <strong>A color map is the minimum texture you need.</strong> All other texture maps are optional improvements.</div></li></ul></div><h3><a |
||||||
<div> |
name="diffuse_map">Diffuse Map</a></h3><div |
||||||
|
class="level3"><p> <a |
||||||
</div> |
href="/wiki/lib/exe/fetch.php?hash=f41169&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FModels%2FHoverTank%2Ftank_diffuse.jpg"><img |
||||||
|
src="/wiki/lib/exe/fetch.php?hash=f41169&w=128&h=128&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FModels%2FHoverTank%2Ftank_diffuse.jpg" class="mediaright" align="right" title="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_models_hovertank_tank_diffuse.jpg" alt="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_models_hovertank_tank_diffuse.jpg" width="128" height="128" /></a></p><ul><li |
||||||
<h3><a>Shininess</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> The Diffuse Map specifies the intensity of color.</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Degree of shininess of a surface (0-128).</div> |
class="li"> Its basically the same as a Color Map but its called Diffuse Map in a lighting environment, as it defines the color the object "diffuses".</div></li></ul></div><h3><a |
||||||
</li> |
name="bump_map">Bump Map</a></h3><div |
||||||
<li><div> Shiny objects have small, clearly outlined specular highlights. (E.g. glass, water, silver)</div> |
class="level3"><p> Bump maps are used to describe detailed shapes that would be too hard or simply too inefficient to sculpt in a mesh editor. You use Normal Maps to model cracks in walls, rust, skin texture, or a canvas weave. You use Height Maps to model whole terrains with valleys and mountains. <a |
||||||
</li> |
href="/wiki/lib/exe/fetch.php?hash=e15227&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FTextures%2FTerrain%2Fsplat%2Fmountains512.png"><img |
||||||
<li><div> Normal objects have wide, blurry specular highlights. (E.g. metal, plastic, stone, polished materials)</div> |
src="/wiki/lib/exe/fetch.php?hash=e15227&w=128&h=128&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FTextures%2FTerrain%2Fsplat%2Fmountains512.png" class="mediaright" align="right" alt="" width="128" height="128" /></a></p></div><h4><a |
||||||
</li> |
name="height_map">Height Map</a></h4><div |
||||||
<li><div> Uneven objects are not shiny and have no specular highlights. (E.g. cloth, paper, wood, snow)</div> |
class="level4"><ul><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> A height map is a grayscale image looking similar to a terrain map used in topography. Brighter grays represent higher areas and darker grays lower areas.</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> A heightmap can represent 256 height levels and is mostly used to roughly outline terrains.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h3><a>Specular Color</a></h3> |
class="li"> You can draw a heightmap by hand in any image editor.</div></li></ul></div><h4><a |
||||||
<div> |
name="normal_map">Normal Map</a></h4><div |
||||||
<ul> |
class="level4"><p> <a |
||||||
<li><div> If the material is shiny, then the Specular Color is the color of the reflected highlights. </div> |
href="/wiki/lib/exe/fetch.php?hash=945484&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FModels%2FHoverTank%2Ftank_normals.png"><img |
||||||
</li> |
src="/wiki/lib/exe/fetch.php?hash=945484&w=128&h=128&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FModels%2FHoverTank%2Ftank_normals.png" class="mediaright" align="right" alt="" width="128" height="128" /></a></p><ul><li |
||||||
<li><div> Usually the same as the emissive color of the light source (e.g. white). </div> |
class="level1"><div |
||||||
</li> |
class="li"> A well-done Normal Map makes a shape more detailed–without the need to add costly polygons to the mesh. It contains shading information that makes the object appear smoother and more fine-grained.</div></li><li |
||||||
<li><div> You can use colors to achieve special specular effects, such as metallic or iridescent reflections.</div> |
class="level1"><div |
||||||
</li> |
class="li"> The Normal Map is displayed looking like a false-color version of the Color Map–but it is never used for coloring, instead, each RGB value encodes transformation data. This displacement data is represented by Surface Normals of the slopes, hence the name.</div></li><li |
||||||
<li><div> Non-shiny objects don't use a specular color.</div> |
class="level1"><div |
||||||
</li> |
class="li"> It's hard to draw normal maps by hand. Generally you use software tools to calculate them off 3D models.</div></li></ul></div><h3><a |
||||||
</ul> |
name="specular_map">Specular Map</a></h3><div |
||||||
|
class="level3"><p> <a |
||||||
<p> |
href="/wiki/lib/exe/fetch.php?hash=789616&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FModels%2FHoverTank%2Ftank_specular.jpg"><img |
||||||
|
src="/wiki/lib/exe/fetch.php?hash=789616&w=128&h=128&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FModels%2FHoverTank%2Ftank_specular.jpg" class="mediaright" align="right" title="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_models_hovertank_tank_specular.jpg" alt="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_models_hovertank_tank_specular.jpg" width="128" height="128" /></a></p><ul><li |
||||||
<img src="/wiki/lib/exe/fetch.php"> |
class="level1"><div |
||||||
</p> |
class="li"> A Specular Map further improves the realism of an object's surface: It contains extra information about shininess and makes the shape appear more realistically illumated.</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Start out with a gray value that corresponds to the average shininess/dullness of this material. Then add ligher grays for smoother, shinier, more reflective areas; and darker grays for duller, rougher, worn-out areas. The resulting image file looks similar to a grayscale version of the Color Map.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h1><a>Materials: Textures</a></h1> |
class="li"> You can use colors in a specular map to create certain reflective effects (iridiscence, metallic).</div></li></ul></div><h2><a |
||||||
<div> |
name="seamless_tiled_textures">Seamless Tiled Textures</a></h2><div |
||||||
|
class="level2"><p> <a |
||||||
<p> |
href="/wiki/lib/exe/fetch.php?hash=5adfc8&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FTextures%2FTerrain%2FBrickWall%2FBrickWall.jpg"><img |
||||||
|
src="/wiki/lib/exe/fetch.php?hash=5adfc8&w=128&h=128&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FTextures%2FTerrain%2FBrickWall%2FBrickWall.jpg" class="mediaright" align="right" title="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_textures_terrain_brickwall_brickwall.jpg" alt="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_textures_terrain_brickwall_brickwall.jpg" width="128" height="128" /></a> This is a very simple, commonly used type of texture. When texturing a wide area (e.g. walls, floors), you don't create one huge texture, instead you tile a small texture repeatedly to fill the area. |
||||||
Textures are part of Materials. In the simplest case, an object could have just one texture, the Color Map, loaded from one image file. When you think back of old computer games you'll remember this looks quite plain. |
A seamless texture is an image file that has been designed so that it can be used as tiles: The right edge matches the left edge, and the top edge matches the bottom edge. The onlooker cannot easily tell where one starts and the next one ends, thus creating an illusion of a huge texture. The downside is that the tiling becomes painfully obvious when the area is viewed from a distance. Also you cannot use it on more complex models such as characters.</p></div><h2><a |
||||||
</p> |
name="uv_maps">UV Maps</a></h2><div |
||||||
|
class="level2"><p> <a |
||||||
<p> |
href="/wiki/lib/exe/fetch.php?hash=82332e&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FModels%2FFerrari%2FCar.jpg"><img |
||||||
The more information you (the game designer) provide additionally to the Color Map, the higher the degree of detail and realism. Whether you want photo-realistic rendering or “toon” rendering (Cel Shading), everything depends on the quality of your materials and texture maps. Modern 3D graphics use several layers of information to describe one material, each layer is a Texture Map. |
src="/wiki/lib/exe/fetch.php?hash=82332e&w=128&h=128&media=http%3A%2F%2Fjmonkeyengine.googlecode.com%2Fsvn%2Ftrunk%2Fengine%2Fsrc%2Ftest-data%2FModels%2FFerrari%2FCar.jpg" class="mediaright" align="right" title="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_models_ferrari_car.jpg" alt="jmonkeyengine.googlecode.com_svn_trunk_engine_src_test-data_models_ferrari_car.jpg" width="128" height="128" /></a> Creating a texture for a cube is easy – but what about a character with a face and extremities? For more complex objects, you design the texture in the same ways as a sewing pattern: One image file contains the outline of the front, back, and side of the object, next to one another. Specific areas of the flat texture (UV coordinates) map onto certain areas of your 3D model (XYZ coordinates), hence the name UV map. |
||||||
</p> |
Getting the seams and mappings right is crucial: You will have to use a graphic tool like Blender to create UV Maps. It's worth the while to learn this, UV mapped models look a lot more professional.</p></div><h2><a |
||||||
|
name="environment_maps">Environment Maps</a></h2><div |
||||||
</div> |
class="level2"><p> <a |
||||||
|
href="/wiki/lib/exe/fetch.php?hash=124408&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fglass-teapot1.png"><img |
||||||
<h2><a>Texture Maps</a></h2> |
src="/wiki/lib/exe/fetch.php?hash=124408&w=160&h=90&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fglass-teapot1.png" class="mediaright" align="right" alt="" width="160" height="90" /></a> Environment Maps are used to create the impression of reflections and refractions. You create a Cube Map to represent your environment, similar to a skybox. (Sphere Maps are possible, but often look too distorted.) You give the Cube Map a set of images showing a "360° view" of the completed scene. The renderer uses this as base to texture the reflective surface. |
||||||
<div> |
Of course these reflections are static and not "real", e.g. the player will not see his avatar's face reflected, etc… But they cause the desired "glass/mirror/water" effect, and are fast enough to render in real usecases, it's better than nothing.</p></div><h2><a |
||||||
|
name="mip_map_texture">MIP Map Texture</a></h2><div |
||||||
</div> |
class="level2"><p> You provide the texture in two or three resolutions to be stored in one file (MIP = "multum in parvo" = "many in one"). Depending on how close (or far) the camera is, the engine automatically renders a more (or less) detailed texture for the object. Thus objects look smooth from close up, but don't waste resources with unspottable details when far away. Good for everything, but requires more time to create and more space to store textures.</p></div><h2><a |
||||||
|
name="procedural_textures">Procedural Textures</a></h2><div |
||||||
<h3><a>Color Map</a></h3> |
class="level2"><p> A procedural texture is generated from repeating one small image, plus some pseudo-random, gradient variations (Perlin noise). Procedural textures look more natural than static rectangular textures, for instance, they look less distorted on spheres. On big meshes, their repetitiveness is much less noticable than tiled seamless textures. Procedural textures are ideal for irregular large-area textures like grass, soil, rock, rust, and walls. See also: <a |
||||||
<div> |
href="http://jmonkeyengine.org/wiki/doku.php/jme3:jmonkeyplatform:neotexture">jMonkeyPlatform NeoTexture plugin</a> <a |
||||||
|
href="/wiki/lib/exe/fetch.php?hash=051bf1&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fneotexture-2.jpg"><img |
||||||
<p> |
src="/wiki/lib/exe/fetch.php?hash=051bf1&w=380&h=189&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fneotexture-2.jpg" class="mediacenter" title="jmonkeyengine.org_wp-content_uploads_2010_10_neotexture-2.jpg" alt="jmonkeyengine.org_wp-content_uploads_2010_10_neotexture-2.jpg" width="380" height="189" /></a> See also: <a |
||||||
|
href="http://www.blender.org/education-help/tutorials/materials/">Creating Materials in Blender</a>, <a |
||||||
<img src="/wiki/lib/exe/fetch.php"> |
href="http://en.wikibooks.org/wiki/Blender_3D:_Noob_to_Pro/Every_Material_Known_to_Man">Blender: Every Material Known to Man</a></p></div><h1><a |
||||||
</p> |
name="animation">Animation</a></h1><div |
||||||
<ul> |
class="level1"><p> In 3D games, Skeletal Animation is used for animated characters, but in principle the skeleton approach can be extended to any 3D mesh (for example, an opening crate's hinge can be considered a joint). |
||||||
<li><div> A simple image file (or a procedural texture). </div> |
Unless you animate a 3D cartoon, realism of animated characters is generally a problem: Movement can look alien-like mechanical or broken, the character appears hollow, or as if floating. Professional game designers invest a lot of effort to make characters animate in a natural way (including motion capturing).</p></div><h2><a |
||||||
</li> |
name="rigging_and_skinning">Rigging and Skinning</a></h2><div |
||||||
<li><div> The image can have alpha channels for transparency. </div> |
class="level2"><p> <a |
||||||
</li> |
href="/wiki/lib/exe/fetch.php?hash=6038ee&media=http%3A%2F%2Fpub.admc.com%2Fmisc%2Fjme%2Fblenderjmetut%2Fblenderswordsman.png"><img |
||||||
<li><div> <strong>A color map is the minimum texture you need.</strong> All other texture maps are optional improvements.</div> |
src="/wiki/lib/exe/fetch.php?hash=6038ee&w=195&h=151&media=http%3A%2F%2Fpub.admc.com%2Fmisc%2Fjme%2Fblenderjmetut%2Fblenderswordsman.png" class="mediaright" align="right" alt="" width="195" height="151" /></a> An animated character has an armature: An internal skeleton (Bones) and an external surface (Skin). The Skin is the visible outside of the character and it includes clothing. The Bones are not visible and are used to interpolate (calculate) the morphing steps of the skin. |
||||||
</li> |
JME3, the game engine, only loads and plays your recorded animations. You must use a tool (such as Blender) to set up (rig, skin, and animate) a character.</p><ol><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> <strong>Rigging:</strong> The Construction of a character's skeleton.</div><ul><li |
||||||
</div> |
class="level2"><div |
||||||
|
class="li"> Create as few Bones as possible to decrease complexity.</div></li><li |
||||||
<h3><a>Diffuse Map</a></h3> |
class="level2"><div |
||||||
<div> |
class="li"> Bones are connected in a parent-child hierarchy: Moving one bone can pull another bone with it (e.g. arm pulls hand).</div></li><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> Bones follow a certain naming scheme so the 3D engines know what's what.</div></li></ul></li><li |
||||||
|
class="level1"><div |
||||||
<img src="/wiki/lib/exe/fetch.php"> |
class="li"> <strong>Skinning:</strong> The association of individual bones with the corresponding skin sections.</div><ul><li |
||||||
</p> |
class="level2"><div |
||||||
<ul> |
class="li"> Each Bone is connected to a part of the Skin. Animating the (invisible) Bone pulls the (visible) Skin with it. <br/> E.g. the thigh Bone is connected to the upper leg Skin.</div></li><li |
||||||
<li><div> The Diffuse Map specifies the intensity of color. </div> |
class="level2"><div |
||||||
</li> |
class="li"> One part of the Skin can be affected by more than one bone (e.g. knee, elbow).</div></li><li |
||||||
<li><div> Its basically the same as a Color Map but its called Diffuse Map in a lighting environment, as it defines the color the object “diffuses”.</div> |
class="level2"><div |
||||||
</li> |
class="li"> The connection between bones and skin sections is gradual: You assign weights how much each skin polygon is affected by any bone's motion. <br/> E.g. when the thigh bone moves, the leg is fully affected, the hips joints less so, and the head not at all.</div></li></ul></li><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> <strong>Keyframe Animation:</strong> A keyframe is one recorded snapshot of a motion sequence.</div><ul><li |
||||||
</div> |
class="level2"><div |
||||||
|
class="li"> A series of keyframes makes up one animation.</div></li><li |
||||||
<h3><a>Bump Map</a></h3> |
class="level2"><div |
||||||
<div> |
class="li"> Each model can have several animations. Each animation has a name to identify it (e.g. "walk", "attack", "jump").</div></li><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> You specify in your game code which keyframe animation to load, and when to play it.</div></li></ul></li></ol></div><h2><a |
||||||
|
name="kinematics">Kinematics</a></h2><div |
||||||
Bump maps are used to describe detailed shapes that would be too hard or simply too inefficient to sculpt in a mesh editor. You use Normal Maps to model cracks in walls, rust, skin texture, or a canvas weave. You use Height Maps to model whole terrains with valleys and mountains. |
class="level2"><ul><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Forward kinematics: "Given the angles of all the character's joints, what is the position of the character's hand?"</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
<img src="/wiki/lib/exe/fetch.php"> |
class="li"> Inverse kinematics: "Given the position of the character's hand, what are the angles of all the character's joints?"</div></li></ul></div><h2><a |
||||||
</p> |
name="controller_and_channel">Controller and Channel</a></h2><div |
||||||
|
class="level2"><p> In the JME3 application, you register animated models to the Animation Controller. The controller object gives you access to the available animation sequences. The controller has several channels, each channels can run one animation sequence at a time. To run several sequences, you create several channels, and run them in parallel.</p></div><h1><a |
||||||
</div> |
name="artificial_intelligence_ai">Artificial Intelligence (AI)</a></h1><div |
||||||
|
class="level1"><p> Non-player (computer-controlled) characters (NPCs) are only fun in a game if they do not stupidly bump into walls, or blindly run into the line of fire. You want to make NPCs "aware" of their surroundings and let them make decisions based on the game state – otherwise the player can just ignore them. The most common use case is that you want to make enemies interact in a way so they offer a more interesting challenge for the player. |
||||||
<h4><a>Height Map</a></h4> |
"Smart" game elements are called artificially intelligent agents (AI agents). An AI agent can be an NPC, but also an "automatic alarm system" that locks doors after an intruder alert, or a trained pet. |
||||||
<div> |
The domain of artificial intelligence deals, among other things, with:</p><ul><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> A height map is a grayscale image looking similar to a terrain map used in topography. Brighter grays represent higher areas and darker grays lower areas. </div> |
class="li"> Knowledge – An agent only "knows" what it can "see and hear", this implies that things can be hidden from it. You can make a group of agents share knowledge (e.g. guards with two-way radios know, other guards don't know about the intruder).</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> A heightmap can represent 256 height levels and is mostly used to roughly outline terrains.</div> |
class="li"> Goal Planning – The agent has a priority to achieve a specific goal (a future state). It splits the goal into subgoals, determines tactics and strategies, and prioritizes them. The agent keeps testing whether the current state is closer to the (sub)goal. If unsuccessful, the agent changes the tactics/strategy. E.g. Finding the best path to reach a target in a changing environment.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> You can draw a heightmap by hand in any image editor.</div> |
class="li"> Problem solving – The agent uses a given set of facts and rules to deduct what state it is in. In every state, only a certain subset of reactions makes sense. The actual decision depends on the agent's goal. Examples: If target in range, attack or protect base or raise alarm. If idle, lay traps or heal oneself or recharge ammunition. If floor on fire, then danger. If danger, escape or kamikaze.</div></li></ul><p> There are lots of resources explaining interesting AI algorithms:</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> <a |
||||||
|
href="http://www.policyalmanac.org/games/aStarTutorial.htm">A* (A-Star) pathfinding for beginners</a></div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
<h4><a>Normal Map</a></h4> |
href="http://theory.stanford.edu/~amitp/GameProgramming/">A* (A-star) pathfinding theory</a></div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
<p> |
href="http://hem.fyristorg.com/dawnbringer/z-path.html">"Z-Path" algorithm</a> (backwards pathfinding)</div></li><li |
||||||
|
class="level1"><div |
||||||
<img src="/wiki/lib/exe/fetch.php"> |
class="li"> <a |
||||||
</p> |
href="http://web.media.mit.edu/~jorkin/goap.html">Goal-Oriented Action Planning</a></div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> A well-done Normal Map makes a shape more detailed–without the need to add costly polygons to the mesh. It contains shading information that makes the object appear smoother and more fine-grained.</div> |
class="li"> <a |
||||||
</li> |
href="http://neuroph.sourceforge.net/">Java Neural Networks</a></div></li><li |
||||||
<li><div> The Normal Map is displayed looking like a false-color version of the Color Map–but it is never used for coloring, instead, each RGB value encodes transformation data. This displacement data is represented by Surface Normals of the slopes, hence the name. </div> |
class="level1"><div |
||||||
</li> |
class="li"> …</div></li></ul></div> |
||||||
<li><div> It's hard to draw normal maps by hand. Generally you use software tools to calculate them off 3D models.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Specular Map</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="/wiki/lib/exe/fetch.php"> |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> A Specular Map further improves the realism of an object's surface: It contains extra information about shininess and makes the shape appear more realistically illumated. </div> |
|
||||||
</li> |
|
||||||
<li><div> Start out with a gray value that corresponds to the average shininess/dullness of this material. Then add ligher grays for smoother, shinier, more reflective areas; and darker grays for duller, rougher, worn-out areas. The resulting image file looks similar to a grayscale version of the Color Map.</div> |
|
||||||
</li> |
|
||||||
<li><div> You can use colors in a specular map to create certain reflective effects (iridiscence, metallic). </div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Seamless Tiled Textures</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="/wiki/lib/exe/fetch.php"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
This is a very simple, commonly used type of texture. When texturing a wide area (e.g. walls, floors), you don't create one huge texture, instead you tile a small texture repeatedly to fill the area. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
A seamless texture is an image file that has been designed so that it can be used as tiles: The right edge matches the left edge, and the top edge matches the bottom edge. The onlooker cannot easily tell where one starts and the next one ends, thus creating an illusion of a huge texture. The downside is that the tiling becomes painfully obvious when the area is viewed from a distance. Also you cannot use it on more complex models such as characters. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>UV Maps</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="/wiki/lib/exe/fetch.php"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Creating a texture for a cube is easy – but what about a character with a face and extremities? For more complex objects, you design the texture in the same ways as a sewing pattern: One image file contains the outline of the front, back, and side of the object, next to one another. Specific areas of the flat texture (UV coordinates) map onto certain areas of your 3D model (XYZ coordinates), hence the name UV map. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Getting the seams and mappings right is crucial: You will have to use a graphic tool like Blender to create UV Maps. It's worth the while to learn this, UV mapped models look a lot more professional. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Environment Maps</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="/wiki/lib/exe/fetch.php"> |
|
||||||
Environment Maps are used to create the impression of reflections and refractions. You create a Cube Map to represent your environment, similar to a skybox. (Sphere Maps are possible, but often look too distorted.) You give the Cube Map a set of images showing a “360° view” of the completed scene. The renderer uses this as base to texture the reflective surface. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Of course these reflections are static and not “real”, e.g. the player will not see his avatar's face reflected, etc… But they cause the desired “glass/mirror/water” effect, and are fast enough to render in real usecases, it's better than nothing. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>MIP Map Texture</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You provide the texture in two or three resolutions to be stored in one file (MIP = “multum in parvo” = “many in one”). Depending on how close (or far) the camera is, the engine automatically renders a more (or less) detailed texture for the object. Thus objects look smooth from close up, but don't waste resources with unspottable details when far away. Good for everything, but requires more time to create and more space to store textures. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Procedural Textures</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A procedural texture is generated from repeating one small image, plus some pseudo-random, gradient variations (Perlin noise). Procedural textures look more natural than static rectangular textures, for instance, they look less distorted on spheres. On big meshes, their repetitiveness is much less noticable than tiled seamless textures. Procedural textures are ideal for irregular large-area textures like grass, soil, rock, rust, and walls. See also: <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://jmonkeyengine.org/wiki/doku.php/jme3:jmonkeyplatform:neotexture"><param name="text" value="<html><u>jMonkeyPlatform NeoTexture plugin</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="/wiki/lib/exe/fetch.php"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
See also: <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.blender.org/education-help/tutorials/materials/"><param name="text" value="<html><u>Creating Materials in Blender</u></html>"><param name="textColor" value="blue"></object>, <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://en.wikibooks.org/wiki/Blender_3D:_Noob_to_Pro/Every_Material_Known_to_Man"><param name="text" value="<html><u>Blender: Every Material Known to Man</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h1><a>Animation</a></h1> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
In 3D games, Skeletal Animation is used for animated characters, but in principle the skeleton approach can be extended to any 3D mesh (for example, an opening crate's hinge can be considered a joint). |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Unless you animate a 3D cartoon, realism of animated characters is generally a problem: Movement can look alien-like mechanical or broken, the character appears hollow, or as if floating. Professional game designers invest a lot of effort to make characters animate in a natural way (including motion capturing). |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Rigging and Skinning</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="/wiki/lib/exe/fetch.php"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
An animated character has an armature: An internal skeleton (Bones) and an external surface (Skin). The Skin is the visible outside of the character and it includes clothing. The Bones are not visible and are used to interpolate (calculate) the morphing steps of the skin. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
JME3, the game engine, only loads and plays your recorded animations. You must use a tool (such as Blender) to set up (rig, skin, and animate) a character. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> <strong>Rigging:</strong> The Construction of a character's skeleton. </div> |
|
||||||
<ul> |
|
||||||
<li><div> Create as few Bones as possible to decrease complexity. </div> |
|
||||||
</li> |
|
||||||
<li><div> Bones are connected in a parent-child hierarchy: Moving one bone can pull another bone with it (e.g. arm pulls hand). </div> |
|
||||||
</li> |
|
||||||
<li><div> Bones follow a certain naming scheme so the 3D engines know what's what.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> <strong>Skinning:</strong> The association of individual bones with the corresponding skin sections. </div> |
|
||||||
<ul> |
|
||||||
<li><div> Each Bone is connected to a part of the Skin. Animating the (invisible) Bone pulls the (visible) Skin with it. <br/> |
|
||||||
E.g. the thigh Bone is connected to the upper leg Skin.</div> |
|
||||||
</li> |
|
||||||
<li><div> One part of the Skin can be affected by more than one bone (e.g. knee, elbow).</div> |
|
||||||
</li> |
|
||||||
<li><div> The connection between bones and skin sections is gradual: You assign weights how much each skin polygon is affected by any bone's motion. <br/> |
|
||||||
E.g. when the thigh bone moves, the leg is fully affected, the hips joints less so, and the head not at all.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> <strong>Keyframe Animation:</strong> A keyframe is one recorded snapshot of a motion sequence.</div> |
|
||||||
<ul> |
|
||||||
<li><div> A series of keyframes makes up one animation. </div> |
|
||||||
</li> |
|
||||||
<li><div> Each model can have several animations. Each animation has a name to identify it (e.g. “walk”, “attack”, “jump”). </div> |
|
||||||
</li> |
|
||||||
<li><div> You specify in your game code which keyframe animation to load, and when to play it.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Kinematics</a></h2> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> Forward kinematics: “Given the angles of all the character's joints, what is the position of the character's hand?”</div> |
|
||||||
</li> |
|
||||||
<li><div> Inverse kinematics: “Given the position of the character's hand, what are the angles of all the character's joints?” </div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Controller and Channel</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
In the JME3 application, you register animated models to the Animation Controller. The controller object gives you access to the available animation sequences. The controller has several channels, each channels can run one animation sequence at a time. To run several sequences, you create several channels, and run them in parallel. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h1><a>Artificial Intelligence (AI)</a></h1> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Non-player (computer-controlled) characters (NPCs) are only fun in a game if they do not stupidly bump into walls, or blindly run into the line of fire. You want to make NPCs “aware” of their surroundings and let them make decisions based on the game state – otherwise the player can just ignore them. The most common use case is that you want to make enemies interact in a way so they offer a more interesting challenge for the player. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
“Smart” game elements are called artificially intelligent agents (AI agents). An AI agent can be an NPC, but also an “automatic alarm system” that locks doors after an intruder alert, or a trained pet. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
The domain of artificial intelligence deals, among other things, with: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Knowledge – An agent only “knows” what it can “see and hear”, this implies that things can be hidden from it. You can make a group of agents share knowledge (e.g. guards with two-way radios know, other guards don't know about the intruder).</div> |
|
||||||
</li> |
|
||||||
<li><div> Goal Planning – The agent has a priority to achieve a specific goal (a future state). It splits the goal into subgoals, determines tactics and strategies, and prioritizes them. The agent keeps testing whether the current state is closer to the (sub)goal. If unsuccessful, the agent changes the tactics/strategy. E.g. Finding the best path to reach a target in a changing environment.</div> |
|
||||||
</li> |
|
||||||
<li><div> Problem solving – The agent uses a given set of facts and rules to deduct what state it is in. In every state, only a certain subset of reactions makes sense. The actual decision depends on the agent's goal. Examples: If target in range, attack or protect base or raise alarm. If idle, lay traps or heal oneself or recharge ammunition. If floor on fire, then danger. If danger, escape or kamikaze.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
There are lots of resources explaining interesting AI algorithms: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.policyalmanac.org/games/aStarTutorial.htm"><param name="text" value="<html><u>A* (A-Star) pathfinding for beginners</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://theory.stanford.edu/~amitp/GameProgramming/"><param name="text" value="<html><u>A* (A-star) pathfinding theory</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://hem.fyristorg.com/dawnbringer/z-path.html"><param name="text" value="<html><u>"Z-Path" algorithm</u></html>"><param name="textColor" value="blue"></object> (backwards pathfinding)</div> |
|
||||||
</li> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://web.media.mit.edu/~jorkin/goap.html"><param name="text" value="<html><u>Goal-Oriented Action Planning</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://neuroph.sourceforge.net/"><param name="text" value="<html><u>Java Neural Networks</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
<li><div> …</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:terminology?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:terminology?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,132 +1,61 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>The Scene Graph and Other jME3 Terminology</a></h1> |
name="the_scene_graph_and_other_jme3_terminology">The Scene Graph and Other jME3 Terminology</a></h1><div |
||||||
<div> |
class="level1"><p> Before you start making games, make sure you understand general <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/terminology.html">3D Gaming terminology</a>.</p><p> Second, if you are a beginner, we recommend our <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/jme3/scenegraph_for_dummies.html">Scene Graph for Dummies</a> presentation for a visual introduction to the concept of a scene graph.</p><p> Then continue learning about jME3 concepts here.</p></div><h2><a |
||||||
|
name="coordinate_system">Coordinate System</a></h2><div |
||||||
Before you start making games, make sure you understand general <a href="/com/jme3/gde/core/docs/jme3/terminology.html">3D Gaming terminology</a>. |
class="level2"><p> <a |
||||||
</p> |
href="/wiki/lib/exe/detail.php/jme3:intermediate:coordinate-system.png?id=jme3%3Athe_scene_graph"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/jme3/intermediate/coordinate-system.png?w=235&h=210" class="mediaright" align="right" alt="" width="235" height="210" /></a></p><p> The jMonkeyEngine uses a right-handed coordinate system, just as OpenGL does.</p><p> The coordinate system consists of:</p><ul><li |
||||||
<p> |
class="level1"><div |
||||||
Second, if you are a beginner, we recommend our <a href="/com/jme3/gde/core/docs/jme3/scenegraph_for_dummies.html">Scene Graph for Dummies</a> presentation for a visual introduction to the concept of a scene graph. |
class="li"> The origin, a single point in space.</div><ul><li |
||||||
</p> |
class="level2"><div |
||||||
|
class="li"> This point is always at coordinate (0,0,0)</div></li></ul></li><li |
||||||
<p> |
class="level1"><div |
||||||
Then continue learning about jME3 concepts here. |
class="li"> Three coordinate axes that are mutually perpendicular, and meet in the origin.</div><ul><li |
||||||
</p> |
class="level2"><div |
||||||
|
class="li"> The X axis is "right/left"</div></li><li |
||||||
</div> |
class="level2"><div |
||||||
|
class="li"> The Y axis is "up/down"</div></li><li |
||||||
<h2><a>Coordinate System</a></h2> |
class="level2"><div |
||||||
<div> |
class="li"> The Z axis is "towards you/away from you"</div></li></ul></li></ul><p> Every point in 3D space is defined by its (x,y,z) coordinates. The data type for vectors is com.jme3.math.Vector3f.</p><p> For your orientation, the default camera's location is (0.0f,0.0f,10.0f), and it is looking in the direction described by the unit vector (0.0f, 0.0f, -1.0f). This means your point of view is on the positive side of the Z axis, looking towards the origin, down the Z axis.</p><p> The unit of meassurement is <code>world unit</code> (wu). Typically, 1 wu is considered to be one meter. All scales, vectors and points are relative to this coordinate system.</p></div><h2><a |
||||||
|
name="scene_graph_and_rootnode">Scene Graph and RootNode</a></h2><div |
||||||
<p> |
class="level2"><p> The scene graph represents your 3D world. Objects in the jME3 scene graph are called <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/advanced/spatial.html">Spatial</a>s. Everything attached to the <em>rootNode</em> is part of the scene graph. <em>Attaching</em> a Spatial to the rootNode (or other nodes) adds the Spatial to the scene; <em>detaching</em> removes it.</p><p> <a |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/intermediate/coordinate-system.png"> |
href="/wiki/lib/exe/detail.php/jme3:intermediate:scene-graph.png?id=jme3%3Athe_scene_graph"><img |
||||||
</p> |
src="nbdocs:/com/jme3/gde/core/docs/jme3/intermediate/scene-graph.png" class="mediacenter" alt="" /></a></p></div><h2><a |
||||||
|
name="spatialsnode_vs_geometry">Spatials: Node vs Geometry</a></h2><div |
||||||
<p> |
class="level2"><p> A Spatial can be transformed, loaded and saved. There are two types of Spatials, <em>Nodes</em> and <em>Geometries</em>.</p><div |
||||||
The jMonkeyEngine uses a right-handed coordinate system, just as OpenGL does. |
class="table sectionedit1"><table |
||||||
</p> |
class="inline"><tr |
||||||
|
class="row0"><td |
||||||
<p> |
class="col0 leftalign"></td><th |
||||||
The coordinate system consists of: |
class="col1" colspan="2"> Spatial</th></tr><tr |
||||||
|
class="row1"><th |
||||||
</p> |
class="col0"> Purpose:</th><td |
||||||
<ul> |
class="col1" colspan="2"> A Spatial is an abstract data structure that stores transformations (translation, rotation, scale).</td></tr><tr |
||||||
<li><div> The origin, a single point in space.</div> |
class="row2"><td |
||||||
<ul> |
class="col0 leftalign"></td><th |
||||||
<li><div> This point is always at coordinate (0,0,0)</div> |
class="col1"> Geometry</th><th |
||||||
</li> |
class="col2"> Node</th></tr><tr |
||||||
</ul> |
class="row3"><th |
||||||
</li> |
class="col0"> Visibility:</th><td |
||||||
<li><div> Three coordinate axes that are mutually perpendicular, and meet in the origin. </div> |
class="col1"> A visible 3-D object.</td><td |
||||||
<ul> |
class="col2"> An invisible "handle" for a group of objects.</td></tr><tr |
||||||
<li><div> The X axis is “right/left”</div> |
class="row4"><th |
||||||
</li> |
class="col0"> Purpose:</th><td |
||||||
<li><div> The Y axis is “up/down”</div> |
class="col1"> Represents the "look" of an object: Shape, color, texture, opacity/transparency.</td><td |
||||||
</li> |
class="col2"> Groups Geometries and other Nodes together: You transform a Node to affect all attached Nodes.</td></tr><tr |
||||||
<li><div> The Z axis is “towards you/away from you”</div> |
class="row5"><th |
||||||
</li> |
class="col0"> Content:</th><td |
||||||
</ul> |
class="col1"> Transformations, mesh, material.</td><td |
||||||
</li> |
class="col2"> Transformations. No mesh, no material.</td></tr><tr |
||||||
</ul> |
class="row6"><th |
||||||
|
class="col0"> Examples:</th><td |
||||||
<p> |
class="col1"> A box, a sphere, player, a building, a piece of terrain, a vehicle, missiles, NPCs, etc…</td><td |
||||||
|
class="col2"> The rootNode, the guiNode, an audio node, a custom grouping node, etc.</td></tr></table></div></div><h2><a |
||||||
Every point in 3D space is defined by its (x,y,z) coordinates. The data type for vectors is com.jme3.math.Vector3f. |
name="how_to_use_this_knowledge">How to Use This Knowledge?</a></h2><div |
||||||
</p> |
class="level2"><p> Before you start creating your game, you should have completed the <a |
||||||
|
href="/com/jme3/gde/core/docs/jme3/beginner.html">Hello World tutorial series</a>. It shows how to load and create Spatials, how to lay out a scene by attaching and transforming Spatials, and how to add interaction and effects to a game.</p><p> The <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/jme3.html">intermediate and advanced documentation</a> gives you more details on how to put all the parts together to create an awesome Java 3D game!</p></div> |
||||||
For your orientation, the default camera's location is (0.0f,0.0f,10.0f), and it is looking in the direction described by the unit vector (0.0f, 0.0f, -1.0f). This means your point of view is on the positive side of the Z axis, looking towards the origin, down the Z axis. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
The unit of meassurement is <code>world unit</code> (wu). Typically, 1 wu is considered to be one meter. All scales, vectors and points are relative to this coordinate system. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Scene Graph and RootNode</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The scene graph represents your 3D world. Objects in the jME3 scene graph are called <a href="/com/jme3/gde/core/docs/jme3/advanced/spatial.html">Spatial</a>s. Everything attached to the <em>rootNode</em> is part of the scene graph. <em>Attaching</em> a Spatial to the rootNode (or other nodes) adds the Spatial to the scene; <em>detaching</em> removes it. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/jme3/intermediate/scene-graph.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Spatials: Node vs Geometry</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A Spatial can be transformed, loaded and saved. There are two types of Spatials, <em>Nodes</em> and <em>Geometries</em>. |
|
||||||
|
|
||||||
</p> |
|
||||||
<table> |
|
||||||
<tr> |
|
||||||
<td> </td><th> Spatial </th> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<th> Purpose: </th><td> A Spatial is an abstract data structure that stores transformations (translation, rotation, scale). </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<td> </td><th> Geometry </th><th> Node </th> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<th> Visibility: </th><td> A visible 3-D object. </td><td> An invisible “handle” for a group of objects. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<th> Purpose: </th><td> Represents the “look” of an object: Shape, color, texture, opacity/transparency. </td><td> Groups Geometries and other Nodes together: You transform a Node to affect all attached Nodes. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<th> Content: </th><td> Transformations, mesh, material. </td><td> Transformations. No mesh, no material. </td> |
|
||||||
</tr> |
|
||||||
<tr> |
|
||||||
<th> Examples: </th><td> A box, a sphere, player, a building, a piece of terrain, a vehicle, missiles, NPCs, etc… </td><td> The rootNode, the guiNode, an audio node, a custom grouping node, etc. </td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>How to Use This Knowledge?</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Before you start creating your game, you should have completed the <a href="/com/jme3/gde/core/docs/jme3/beginner.html">Hello World tutorial series</a>. It shows how to load and create Spatials, how to lay out a scene by attaching and transforming Spatials, and how to add interaction and effects to a game. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
The <a href="/com/jme3/gde/core/docs/jme3.html">intermediate and advanced documentation</a> gives you more details on how to put all the parts together to create an awesome Java 3D game! |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:the_scene_graph?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/jme3:the_scene_graph?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,312 +1,146 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jMonkeyPlatform: Application Deployment</a></h1> |
name="jmonkeyplatformapplication_deployment">jMonkeyPlatform: Application Deployment</a></h1><div |
||||||
<div> |
class="level1"><p> After you have written and tested your game, you want to brand it and distribute it to your users. If you use the build script provided by the jMonkeyPlatform's BaseGame, you have the following deployment options:</p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Desktop application (.JAR)</div></li><li |
||||||
|
class="level1"><div |
||||||
After you have written and tested your game, you want to brand it and distribute it to your users. If you use the build script provided by the jMonkeyPlatform's BaseGame, you have the following deployment options: |
class="li"> WebStart from <acronym |
||||||
|
title="Uniform Resource Locator">URL</acronym> (.JNLP + .JAR)</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> Applet in browser page (.JNLP + .JAR)</div></li><li |
||||||
<li><div> Desktop application (.JAR)</div> |
class="level1"><div |
||||||
</li> |
class="li"> Android Mobile phone (work in progress)</div></li></ul></div><h2><a |
||||||
<li><div> WebStart from <acronym title="Uniform Resource Locator">URL</acronym> (.JNLP + .JAR)</div> |
name="requirements">Requirements</a></h2><div |
||||||
</li> |
class="level2"><p> Since JAR files are platform independent, your customers can play your jMonkeyEngine application on Windows, Mac <acronym |
||||||
<li><div> Applet in browser page (.JNLP + .JAR)</div> |
title="Operating System">OS</acronym>, or Linux. The only requirement is that the user has the free Java 5 or 6 Runtime (or browser plugin) installed. For more information see <a |
||||||
</li> |
href="http://java.com">http://java.com</a>.</p></div><h2><a |
||||||
<li><div> Android Mobile phone (work in progress)</div> |
name="branding">Branding</a></h2><div |
||||||
</li> |
class="level2"><ol><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> Open your game project in the jMonkeyPlatform's Projects window.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Right-click the project and open the Properties</div></li><li |
||||||
<h2><a>Requirements</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> Open the properties → Application section. Here you do your branding:</div><ol><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> Title: the game's name</div></li><li |
||||||
|
class="level2"><div |
||||||
Since JAR files are platform independent, your customers can play your jMonkeyEngine application on Windows, Mac <acronym title="Operating System">OS</acronym>, or Linux. The only requirement is that the user has the free Java 5 or 6 Runtime (or browser plugin) installed. For more information see <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://java.com"><param name="text" value="<html><u>http://java.com</u></html>"><param name="textColor" value="blue"></object>. |
class="li"> Vendor: your name</div></li><li |
||||||
</p> |
class="level2"><div |
||||||
|
class="li"> Description: why your game is the coolest ever ;)</div></li><li |
||||||
</div> |
class="level2"><div |
||||||
|
class="li"> Homepage: Your web <acronym |
||||||
<h2><a>Branding</a></h2> |
title="Uniform Resource Locator">URL</acronym></div></li><li |
||||||
<div> |
class="level2"><div |
||||||
<ol> |
class="li"> Splashscreen: Browse to a picture that will be shown while the game loads.</div></li></ol></li><li |
||||||
<li><div> Open your game project in the jMonkeyPlatform's Projects window. </div> |
class="level1"><div |
||||||
</li> |
class="li"> Click OK.</div></li><li |
||||||
<li><div> Right-click the project and open the Properties</div> |
class="level1"><div |
||||||
</li> |
class="li"> Clean and Build.</div></li></ol></div><h2><a |
||||||
<li><div> Open the properties → Application section. Here you do your branding: </div> |
name="creating_the_distributable">Creating the Distributable</a></h2><div |
||||||
<ol> |
class="level2"><p> When you run the build script provided by the jMonkeyPlatform, it automatically compiles your classes, libraries, and assets. It creates a <code>dist</code> directory in your project directory which contains the executable JAR and a directory with libraries.</p><p> In the simplest case, you zip up the <code>dist</code> directory and distribute it to your customers. Companies often have additional tools to create executables and installers.</p><p> Here are your deployment options in detail:</p></div><h3><a |
||||||
<li><div> Title: the game's name</div> |
name="desktop_application_jar">Desktop Application (JAR)</a></h3><div |
||||||
</li> |
class="level3"><p> The JAR file is the most common deployment method for Java desktop applications. The user downloads the executable JAR file to his machine and runs it to start the game.</p><ol><li |
||||||
<li><div> Vendor: your name</div> |
class="level1"><div |
||||||
</li> |
class="li"> Right-click your project and open the Project Properties.</div></li><li |
||||||
<li><div> Description: why your game is the coolest ever ;)</div> |
class="level1"><div |
||||||
</li> |
class="li"> In the Application>Web Start category, make sure the box "Enable Web Start" is not checked. Click OK.</div></li><li |
||||||
<li><div> Homepage: Your web <acronym title="Uniform Resource Locator">URL</acronym></div> |
class="level1"><div |
||||||
</li> |
class="li"> Right-click your project and Clean and Build.</div></li><li |
||||||
<li><div> Splashscreen: Browse to a picture that will be shown while the game loads.</div> |
class="level1"><div |
||||||
</li> |
class="li"> If the build succeeds you see a line similar to <br/> <code>Building jar: /home/joe/jMonkeyPlatform/MySuperTestGame/dist/MySuperTestGame.jar</code> <br/> this means the executable JAR has been generated successfully in your project directory.</div></li><li |
||||||
</ol> |
class="level1"><div |
||||||
</li> |
class="li"> Zip up the <code>dist</code> directory and distribute it to your users. Make sure to keep the <code>lib</code> directory in it!</div></li></ol><p> Most operating systems execute a JAR when users double-click on it, but you can also create a launcher.</p></div><h3><a |
||||||
<li><div> Click OK. </div> |
name="desktop_executables">Desktop Executables</a></h3><div |
||||||
</li> |
class="level3"><p> jMonkeyPlatform allows you to create launchers for different desktop platforms, like an .exe file for Windows systems, an Application for MaxOSX and a launcher for Linux systems.</p><ol><li |
||||||
<li><div> Clean and Build.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Right-click your project and open the Project Properties.</div></li><li |
||||||
</ol> |
class="level1"><div |
||||||
|
class="li"> In the Application>Desktop category, select the checkboxes for the platforms you want to distribute to.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Click OK.</div></li></ol><p> When you build your project, zip files for each selected platform will be created in the <code>dist</code> folder that contain all that is needed to run your application on that platform.</p></div><h3><a |
||||||
<h2><a>Creating the Distributable</a></h2> |
name="web_start_jnlp">Web Start (JNLP)</a></h3><div |
||||||
<div> |
class="level3"><p> Web Start allows your users to start your application by simply clicking a link that you provide, for example in a button on your web page. The browser downloads the JAR file and then automatically runs your game in an extra window. The only requirement is that the user's browser has the Java plugin installed. This is a very user-friendly way for your customers to play your game without any extra steps to install it. Optionally, you can set it up so the file is saved to their desktop and can be restarted later, so they do not need to be online to play.</p><ol><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Right-click your project and open the Project Properties.</div><ol><li |
||||||
|
class="level2"><div |
||||||
When you run the build script provided by the jMonkeyPlatform, it automatically compiles your classes, libraries, and assets. It creates a <code>dist</code> directory in your project directory which contains the executable JAR and a directory with libraries. |
class="li"> In the Application>Web Start category, check the box to Enable Web Start.</div></li><li |
||||||
</p> |
class="level2"><div |
||||||
|
class="li"> Check the box to make the application self-signed. <img |
||||||
<p> |
src="/wiki/lib/images/smileys/icon_exclaim.gif" class="middle" alt=":!:" /></div></li><li |
||||||
In the simplest case, you zip up the <code>dist</code> directory and distribute it to your customers. Companies often have additional tools to create executables and installers. |
class="level2"><div |
||||||
</p> |
class="li"> Optionally, check the box to allow offline use.</div></li><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> Make sure <code>Application Descriptor</code> is activated. Click OK.</div></li></ol></li><li |
||||||
Here are your deployment options in detail: |
class="level1"><div |
||||||
|
class="li"> Right-click your project and Clean and Build. The <code>dist</code> directory is generated.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Upload the contents of the <code>dist</code> directory to a public http server</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Either edit the sample launch.html file, or simply add a standard link (A HREF) pointing to your .jnlp file to one of your web pages.</div></li><li |
||||||
<h3><a>Desktop Application (JAR)</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> Tell your users to open your page in a webbrowser, and click the link to webstart the application.</div></li></ol><p> Look at the sample launch.html, you can have any custom content around the link. Keep a copy of your launcher file because the jMonkeyPlatform will always regenerate its default launch.html.</p><p> Also, see this <a |
||||||
|
href="http://www.youtube.com/watch?v=oZnssg8TBWQ">demo video</a> on creating WebStarts.</p></div><h3><a |
||||||
<p> |
name="browser_applet">Browser Applet</a></h3><div |
||||||
|
class="level3"><p> A browser Applet is a Java application that runs in the web browser while the user is visiting your web page. The only requirement is that the user's browser has the Java plugin installed. There is no installation step, the user can play right away in the browser. The user will not be able to save the game to his harddrive, nor can he play offline.</p><p> These instrcutions assume that you have already written a game that you want to turn into an Applet. As opposed to other jME3 games, Applets cannot capture the mouse for navigation, so the camera will be switched to dragToRotate mode. The jMonkeyPlatform and the included build script already contain what you need.</p></div><h4><a |
||||||
The JAR file is the most common deployment method for Java desktop applications. The user downloads the executable JAR file to his machine and runs it to start the game. |
name="to_turn_a_project_into_an_applet">To Turn a Project Into an Applet</a></h4><div |
||||||
|
class="level4"><ol><li |
||||||
</p> |
class="level1"><div |
||||||
<ol> |
class="li"> Right-click your project and open the Project Properties.</div><ol><li |
||||||
<li><div> Right-click your project and open the Project Properties. </div> |
class="level2"><div |
||||||
</li> |
class="li"> In the Application>Applet category, check the box to enable Applet creation.</div></li><li |
||||||
<li><div> In the Application>Web Start category, make sure the box “Enable Web Start” is not checked. Click OK.</div> |
class="level2"><div |
||||||
</li> |
class="li"> Change the applet width and height as you want it.</div></li><li |
||||||
<li><div> Right-click your project and Clean and Build. </div> |
class="level2"><div |
||||||
</li> |
class="li"> Click OK.</div></li></ol></li><li |
||||||
<li><div> If the build succeeds you see a line similar to <br/> |
class="level1"><div |
||||||
<code>Building jar: /home/joe/jMonkeyPlatform/MySuperTestGame/dist/MySuperTestGame.jar</code> <br/> |
class="li"> Right-click your project and Clean and Build.</div></li></ol><p> The <code>dist/Applet</code> directory now contains all the files necessary for the game to run as Applet. To test the Applet-based game, run the project in the jMonkeyPlatform.</p></div><h4><a |
||||||
this means the executable JAR has been generated successfully in your project directory. </div> |
name="to_deploy_the_game_as_applet">To Deploy the Game as Applet</a></h4><div |
||||||
</li> |
class="level4"><ol><li |
||||||
<li><div> Zip up the <code>dist</code> directory and distribute it to your users. Make sure to keep the <code>lib</code> directory in it! </div> |
class="level1"><div |
||||||
</li> |
class="li"> Edit the <code>dist/Applet/run-applet.html</code> file in anyway you like. Just keep the Applet code.</div></li><li |
||||||
</ol> |
class="level1"><div |
||||||
|
class="li"> Upload the contents of the <code>dist/Applet</code> directory to a public http server.</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Access the run-applet.html file using a webbrowser</div></li><li |
||||||
Most operating systems execute a JAR when users double-click on it, but you can also create a launcher. |
class="level1"><div |
||||||
</p> |
class="li"> Click the link to web-start your application.</div></li></ol></div><h4><a |
||||||
|
name="to_troubleshoot_applets">To Troubleshoot Applets</a></h4><div |
||||||
</div> |
class="level4"><ul><li |
||||||
|
class="level1"><div |
||||||
<h3><a>Desktop Executables</a></h3> |
class="li"> Open the Java console for error messages.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> Depending on your settings, the browser caches the applet, the html page, and/or the jnlp file, even after you have cleaned and built the project. Make sure to empty the browser cache.</div></li></ul></div><h3><a |
||||||
<p> |
name="android">Android</a></h3><div |
||||||
|
class="level3"><p> TODO</p></div><h2><a |
||||||
jMonkeyPlatform allows you to create launchers for different desktop platforms, like an .exe file for Windows systems, an Application for MaxOSX and a launcher for Linux systems. |
name="tipswitching_build_configurations">Tip: Switching Build Configurations</a></h2><div |
||||||
|
class="level2"><p> The jMonkeyPlatform has a Run Configuration menu in the toolbar. Use it to save your various sets of Project Property configuations, and switch between them.</p><ol><li |
||||||
</p> |
class="level1"><div |
||||||
<ol> |
class="li"> Click the <code>Set Project Configuration</code> popup in the toolbar and choose Customize.</div></li><li |
||||||
<li><div> Right-click your project and open the Project Properties. </div> |
class="level1"><div |
||||||
</li> |
class="li"> The Project Properties Run section opens. Under Configuration, click New.</div></li><li |
||||||
<li><div> In the Application>Desktop category, select the checkboxes for the platforms you want to distribute to.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Name the saved configuration, for instance "my webstart" vs "my desktop app", or "development" vs "deployment". Click OK.</div></li><li |
||||||
<li><div> Click OK.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Make sure the new config is selected in the <code>Set Project Configuration</code> popup above the editor.</div></li><li |
||||||
</ol> |
class="level1"><div |
||||||
|
class="li"> Make changes to the Project Properties as described above.</div></li></ol><p> Now you can use the <code>Set Project Configuration</code> popup menu to switch between your run/build configurations.</p></div><h2><a |
||||||
<p> |
name="tipreducing_distribution_size">Tip: Reducing Distribution Size</a></h2><div |
||||||
|
class="level2"><p> There may be several parts of the full jMonkeyEngine library that you do not even use in your application. You should leave out the corresponding libraries from your distribution.</p><p> To remove unused libraries:</p><ol><li |
||||||
When you build your project, zip files for each selected platform will be created in the <code>dist</code> folder that contain all that is needed to run your application on that platform. |
class="level1"><div |
||||||
</p> |
class="li"> Right-click your project and select "Properties"</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Select "Libraries" on the left</div></li><li |
||||||
|
class="level1"><div |
||||||
<h3><a>Web Start (JNLP)</a></h3> |
class="li"> Select the "jme3-libraries" entry and press "remove". <br/> This library package contains <strong>all</strong> libraries for jME3 and is quite large.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> Press the "Add Library" button</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Select the "jme3-libraries-lwjgl-minimum" library</div></li><li |
||||||
Web Start allows your users to start your application by simply clicking a link that you provide, for example in a button on your web page. The browser downloads the JAR file and then automatically runs your game in an extra window. The only requirement is that the user's browser has the Java plugin installed. This is a very user-friendly way for your customers to play your game without any extra steps to install it. Optionally, you can set it up so the file is saved to their desktop and can be restarted later, so they do not need to be online to play. |
class="level1"><div |
||||||
|
class="li"> Add other jME3 libraries in the same way depending which features you use (jme3-libraries-gui, jme3-libraries-physics, jme3-libraries-video etc.)</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ol> |
class="li"> Click OK.</div></li><li |
||||||
<li><div> Right-click your project and open the Project Properties. </div> |
class="level1"><div |
||||||
<ol> |
class="li"> Clean, Build and Run the project and make sure you have not missed anything.</div></li></ol></div> |
||||||
<li><div> In the Application>Web Start category, check the box to Enable Web Start. </div> |
|
||||||
</li> |
|
||||||
<li><div> Check the box to make the application self-signed. <img src="/wiki/lib/images/smileys/icon_exclaim.gif" class="middle" alt=":!:" /> </div> |
|
||||||
</li> |
|
||||||
<li><div> Optionally, check the box to allow offline use. </div> |
|
||||||
</li> |
|
||||||
<li><div> Make sure <code>Application Descriptor</code> is activated. Click OK.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
<li><div> Right-click your project and Clean and Build. The <code>dist</code> directory is generated. </div> |
|
||||||
</li> |
|
||||||
<li><div> Upload the contents of the <code>dist</code> directory to a public http server</div> |
|
||||||
</li> |
|
||||||
<li><div> Either edit the sample launch.html file, or simply add a standard link (A HREF) pointing to your .jnlp file to one of your web pages.</div> |
|
||||||
</li> |
|
||||||
<li><div> Tell your users to open your page in a webbrowser, and click the link to webstart the application.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Look at the sample launch.html, you can have any custom content around the link. Keep a copy of your launcher file because the jMonkeyPlatform will always regenerate its default launch.html. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Also, see this <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.youtube.com/watch?v=oZnssg8TBWQ"><param name="text" value="<html><u>demo video</u></html>"><param name="textColor" value="blue"></object> on creating WebStarts. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Browser Applet</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A browser Applet is a Java application that runs in the web browser while the user is visiting your web page. The only requirement is that the user's browser has the Java plugin installed. There is no installation step, the user can play right away in the browser. The user will not be able to save the game to his harddrive, nor can he play offline. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
These instrcutions assume that you have already written a game that you want to turn into an Applet. As opposed to other jME3 games, Applets cannot capture the mouse for navigation, so the camera will be switched to dragToRotate mode. The jMonkeyPlatform and the included build script already contain what you need. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h4><a>To Turn a Project Into an Applet</a></h4> |
|
||||||
<div> |
|
||||||
<ol> |
|
||||||
<li><div> Right-click your project and open the Project Properties. </div> |
|
||||||
<ol> |
|
||||||
<li><div> In the Application>Applet category, check the box to enable Applet creation. </div> |
|
||||||
</li> |
|
||||||
<li><div> Change the applet width and height as you want it.</div> |
|
||||||
</li> |
|
||||||
<li><div> Click OK.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
<li><div> Right-click your project and Clean and Build. </div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The <code>dist/Applet</code> directory now contains all the files necessary for the game to run as Applet. To test the Applet-based game, run the project in the jMonkeyPlatform. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h4><a>To Deploy the Game as Applet</a></h4> |
|
||||||
<div> |
|
||||||
<ol> |
|
||||||
<li><div> Edit the <code>dist/Applet/run-applet.html</code> file in anyway you like. Just keep the Applet code.</div> |
|
||||||
</li> |
|
||||||
<li><div> Upload the contents of the <code>dist/Applet</code> directory to a public http server.</div> |
|
||||||
</li> |
|
||||||
<li><div> Access the run-applet.html file using a webbrowser</div> |
|
||||||
</li> |
|
||||||
<li><div> Click the link to web-start your application.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h4><a>To Troubleshoot Applets</a></h4> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> Open the Java console for error messages.</div> |
|
||||||
</li> |
|
||||||
<li><div> Depending on your settings, the browser caches the applet, the html page, and/or the jnlp file, even after you have cleaned and built the project. Make sure to empty the browser cache.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Android</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
TODO |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Tip: Switching Build Configurations</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The jMonkeyPlatform has a Run Configuration menu in the toolbar. Use it to save your various sets of Project Property configuations, and switch between them. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Click the <code>Set Project Configuration</code> popup in the toolbar and choose Customize.</div> |
|
||||||
</li> |
|
||||||
<li><div> The Project Properties Run section opens. Under Configuration, click New.</div> |
|
||||||
</li> |
|
||||||
<li><div> Name the saved configuration, for instance “my webstart” vs “my desktop app”, or “development” vs “deployment”. Click OK.</div> |
|
||||||
</li> |
|
||||||
<li><div> Make sure the new config is selected in the <code>Set Project Configuration</code> popup above the editor.</div> |
|
||||||
</li> |
|
||||||
<li><div> Make changes to the Project Properties as described above. </div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Now you can use the <code>Set Project Configuration</code> popup menu to switch between your run/build configurations. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Tip: Reducing Distribution Size</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
There may be several parts of the full jMonkeyEngine library that you do not even use in your application. You should leave out the corresponding libraries from your distribution. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
To remove unused libraries: |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Right-click your project and select “Properties”</div> |
|
||||||
</li> |
|
||||||
<li><div> Select “Libraries” on the left</div> |
|
||||||
</li> |
|
||||||
<li><div> Select the “jme3-libraries” entry and press “remove”. <br/> |
|
||||||
This library package contains <strong>all</strong> libraries for jME3 and is quite large.</div> |
|
||||||
</li> |
|
||||||
<li><div> Press the “Add Library” button</div> |
|
||||||
</li> |
|
||||||
<li><div> Select the “jme3-libraries-lwjgl-minimum” library</div> |
|
||||||
</li> |
|
||||||
<li><div> Add other jME3 libraries in the same way depending which features you use (jme3-libraries-gui, jme3-libraries-physics, jme3-libraries-video etc.) </div> |
|
||||||
</li> |
|
||||||
<li><div> Click OK.</div> |
|
||||||
</li> |
|
||||||
<li><div> Clean, Build and Run the project and make sure you have not missed anything.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:application_deployment?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:application_deployment?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,188 +1,61 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jMonkeyPlatform AssetPacks</a></h1> |
name="jmonkeyplatform_assetpacks">jMonkeyPlatform AssetPacks</a></h1><div |
||||||
<div> |
class="level1"><p> AssetPacks are a way to package jME3 compatible assets like models, textures, sounds and whole scenes into a package that contains publisher info, license info, descriptions etc. for all of the assets. An AssetPack basically consists of an <code>assetpack.xml</code> file that describes the content and an <code>assets</code> folder that contains the content. The integrated browser in jMP allows you to add the assets of installed AssetPacks to any project you are doing.</p></div><h2><a |
||||||
|
name="the_assetpack_browser">The AssetPack Browser</a></h2><div |
||||||
<p> |
class="level2"><p> <a |
||||||
AssetPacks are a way to package jME3 compatible assets like models, textures, sounds and whole scenes into a package that contains publisher info, license info, descriptions etc. for all of the assets. An AssetPack basically consists of an <code>assetpack.xml</code> file that describes the content and an <code>assets</code> folder that contains the content. The integrated browser in jMP allows you to add the assets of installed AssetPacks to any project you are doing. |
href="/wiki/lib/exe/fetch.php?hash=1ca01e&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fassetpackbrowser-300x166.jpg"><img |
||||||
</p> |
src="/wiki/lib/exe/fetch.php?hash=1ca01e&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fassetpackbrowser-300x166.jpg" class="mediaright" align="right" title="jmonkeyengine.org_wp-content_uploads_2010_10_assetpackbrowser-300x166.jpg" alt="jmonkeyengine.org_wp-content_uploads_2010_10_assetpackbrowser-300x166.jpg" /></a></p><p> The AssetPack browser in jMP makes browsing the installed AssetPacks easy. Browse categories, search for tags and find the right asset for your project. When you have found it, you can add it with one click to your current scene. The AssetPack manager will automagically copy all needed textures, sounds etc. to your projects assets folder.</p><p> You can also browse a selection of online assetpacks that are available on jMonkeyEngine.org for download and install them to your jMonkeyPlatforms AssetPack browser.</p><p> The AssetPack browser uses a predefined directory to store the AssetPacks which is also used for new AssetPack projects. You can see and change the folder path in the AssetPack preferences (jMonkeyPlatform→Settings).</p></div><h3><a |
||||||
|
name="using_the_browser">Using the browser</a></h3><div |
||||||
</div> |
class="level3"><p> To preview a model from the browser, right-click it and select "Preview Asset"</p><p> To add a model from the AssetPack browser to a scene do the following:</p><ol><li |
||||||
|
class="level1"><div |
||||||
<h2><a>The AssetPack Browser</a></h2> |
class="li"> Create a new scene (j3o) file or use an existing one</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> Open it in the SceneComposer by right-clicking it and selecting "Edit in SceneComposer"</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Select the root node of the scene (or another node you want to add the model to)</div></li><li |
||||||
<img src="/wiki/lib/exe/fetch.php"> |
class="level1"><div |
||||||
</p> |
class="li"> Right-click a model in the AssetBrowser and select "Add to SceneComposer"</div></li></ol><p> The model will be added to your scene and all needed texture files will be copied to your projects assets folder.</p></div><h2><a |
||||||
|
name="assetpack_projects">AssetPack Projects</a></h2><div |
||||||
<p> |
class="level2"><p> AssetPack projects are a way to create your own AssetPacks, either for personal use or for publishing. With this project type in jMonkeyPlatform you can create a library of assets on your computer that you can use in any of your projects via the AssetPack browser. |
||||||
The AssetPack browser in jMP makes browsing the installed AssetPacks easy. Browse categories, search for tags and find the right asset for your project. When you have found it, you can add it with one click to your current scene. The AssetPack manager will automagically copy all needed textures, sounds etc. to your projects assets folder. |
Editing of asset and project info, adding of new assets and setting their properties, everything you need to create and publish your AssetPacks is there.</p><ol><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Select "File → New Project"</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
You can also browse a selection of online assetpacks that are available on jMonkeyEngine.org for download and install them to your jMonkeyPlatforms AssetPack browser. |
class="li"> Select "AssetPack Project"</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Fill in the project info and press "finish"</div></li></ol><p> You can access and change the project properties by right-clicking the project and selecting "Properties".</p></div><h3><a |
||||||
<p> |
name="adding_assets">Adding Assets</a></h3><div |
||||||
The AssetPack browser uses a predefined directory to store the AssetPacks which is also used for new AssetPack projects. You can see and change the folder path in the AssetPack preferences (jMonkeyPlatform→Settings). |
class="level3"><p> <a |
||||||
</p> |
href="/wiki/lib/exe/fetch.php?hash=2edd4a&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fassetpackimport-300x222.jpg"><img |
||||||
|
src="/wiki/lib/exe/fetch.php?hash=2edd4a&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fassetpackimport-300x222.jpg" class="mediaright" align="right" title="jmonkeyengine.org_wp-content_uploads_2010_10_assetpackimport-300x222.jpg" alt="jmonkeyengine.org_wp-content_uploads_2010_10_assetpackimport-300x222.jpg" /></a></p><p> To add new assets to your AssetPack do the following:</p><ol><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Right-Click the "Assets" node of the AssetPack project</div></li><li |
||||||
<h3><a>Using the browser</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> Select "Add Asset.."</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Specify the info about your asset and press Next</div></li><li |
||||||
To preview a model from the browser, right-click it and select “Preview Asset” |
class="level1"><div |
||||||
</p> |
class="li"> Press the "add files" button and select all files belonging to your asset</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Select the "main" checkbox for the main model file if your asset is a model file</div></li><li |
||||||
To add a model from the AssetPack browser to a scene do the following: |
class="level1"><div |
||||||
</p> |
class="li"> Change the asset paths and types if needed and press "finish"</div></li></ol><p> The global asset type can be "model", "scene", "texture", "sound", "shader" or "other"</p><p> With the "model" or "scene" types, the AssetPack browser will try to load and add a model file from the selected assets when the user selects "Add to SceneComposer". Specify the "load this model with material" flag for the model file that should be loaded via the AssetManager, you can also specify multiple mesh or scene files to be loaded. All texture and other needed files will be copied to the users project folder.</p><p> On the "Add Files" page you define the path of the files in the AssetPack. The importer tries to generate a proper path from the info entered on the first page. Note that for j3o binary models, the texture paths have to be exactly like they were during conversion. The given paths will also be used when copying the data to the users "assets" folder.</p><p> With the "add files" button you can open a file browser to select files from your harddisk that will be copied into the <code>assets/</code> folder of the AssetPack project. With the "add existing" button you can add a file thats already in your AssetPack assets folder to a new asset item. This way you can reuse e.g. textures for asset items or make items for an existing collection of asset files that you copied to the projects assets folder.</p><p> <a |
||||||
<ol> |
href="/wiki/lib/exe/fetch.php?hash=8119b0&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fassetpackimport2-300x179.jpg"><img |
||||||
<li><div> Create a new scene (j3o) file or use an existing one</div> |
src="/wiki/lib/exe/fetch.php?hash=8119b0&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fassetpackimport2-300x179.jpg" class="mediaright" align="right" title="jmonkeyengine.org_wp-content_uploads_2010_10_assetpackimport2-300x179.jpg" alt="jmonkeyengine.org_wp-content_uploads_2010_10_assetpackimport2-300x179.jpg" /></a></p><p> You can specify a specific material to be used for the single mesh/scene files, just select it in the dropdown below the mesh or scene file. If you don't select a material file here, the first found material file is used or none if none is found.</p><p> If the material file is an Ogre material file (.material) it will be used for loading an Ogre scene or mesh file. If it is a jMonkeyEngine3 material file (.j3m), it will be applied to the mesh regardless of model type. Note that for j3o models you don't need material files as the material is stored inside the j3o file.</p><p> In your AssetPack Project, if you right-click your asset and select "preview asset" you should be able to see your model. If you do, it should work for the user as well.</p><p> You can change the single assets properties in the properties window after you have added them. Just select an asset and open the properties window (Windows→Properties).</p><p> Supported formats for models are:</p><ol><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Open it in the SceneComposer by right-clicking it and selecting “Edit in SceneComposer”</div> |
class="li"> OgreXML</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Select the root node of the scene (or another node you want to add the model to)</div> |
class="li"> Wavefront OBJ</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Right-click a model in the AssetBrowser and select “Add to SceneComposer”</div> |
class="li"> jMonkeyEngine3 j3o</div></li></ol></div><h3><a |
||||||
</li> |
name="assetpack_publishing">AssetPack Publishing</a></h3><div |
||||||
</ol> |
class="level3"><p> <a |
||||||
|
href="/wiki/lib/exe/fetch.php?hash=2498cf&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fassetpackdownload-263x300.jpg"><img |
||||||
<p> |
src="/wiki/lib/exe/fetch.php?hash=2498cf&media=http%3A%2F%2Fjmonkeyengine.org%2Fwp-content%2Fuploads%2F2010%2F10%2Fassetpackdownload-263x300.jpg" class="mediaright" align="right" title="jmonkeyengine.org_wp-content_uploads_2010_10_assetpackdownload-263x300.jpg" alt="jmonkeyengine.org_wp-content_uploads_2010_10_assetpackdownload-263x300.jpg" /></a></p><p> You can publish your AssetPacks either as a zip file or directly to jmonkeyengine.org, using your website user name and login. This means other jMonkeyPlatform users can download your AssetPacks and install them to their local database right off the AssetPack online packages browser.</p><p> To make sure you can upload, you have to be registered on jmonkeyengine.org and have to enter your login info in the AssetPack preferences (jMonkeyPlatform→Settings).</p><ol><li |
||||||
The model will be added to your scene and all needed texture files will be copied to your projects assets folder. |
class="level1"><div |
||||||
</p> |
class="li"> Right-Click your AssetPack project and select "Publish AssetPack.."</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Check the description etc. settings and press "Next"</div></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>AssetPack Projects</a></h2> |
class="li"> Select the checkbox for online and/or local publishing and press "finish"</div></li></ol></div> |
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
AssetPack projects are a way to create your own AssetPacks, either for personal use or for publishing. With this project type in jMonkeyPlatform you can create a library of assets on your computer that you can use in any of your projects via the AssetPack browser. |
|
||||||
Editing of asset and project info, adding of new assets and setting their properties, everything you need to create and publish your AssetPacks is there. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Select “File → New Project”</div> |
|
||||||
</li> |
|
||||||
<li><div> Select “AssetPack Project”</div> |
|
||||||
</li> |
|
||||||
<li><div> Fill in the project info and press “finish”</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You can access and change the project properties by right-clicking the project and selecting “Properties”. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Adding Assets</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="/wiki/lib/exe/fetch.php"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
To add new assets to your AssetPack do the following: |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Right-Click the “Assets” node of the AssetPack project</div> |
|
||||||
</li> |
|
||||||
<li><div> Select “Add Asset..”</div> |
|
||||||
</li> |
|
||||||
<li><div> Specify the info about your asset and press Next</div> |
|
||||||
</li> |
|
||||||
<li><div> Press the “add files” button and select all files belonging to your asset</div> |
|
||||||
</li> |
|
||||||
<li><div> Select the “main” checkbox for the main model file if your asset is a model file</div> |
|
||||||
</li> |
|
||||||
<li><div> Change the asset paths and types if needed and press “finish”</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The global asset type can be “model”, “scene”, “texture”, “sound”, “shader” or “other” |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
With the “model” or “scene” types, the AssetPack browser will try to load and add a model file from the selected assets when the user selects “Add to SceneComposer”. Specify the “load this model with material” flag for the model file that should be loaded via the AssetManager, you can also specify multiple mesh or scene files to be loaded. All texture and other needed files will be copied to the users project folder. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
On the “Add Files” page you define the path of the files in the AssetPack. The importer tries to generate a proper path from the info entered on the first page. Note that for j3o binary models, the texture paths have to be exactly like they were during conversion. The given paths will also be used when copying the data to the users “assets” folder. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
With the “add files” button you can open a file browser to select files from your harddisk that will be copied into the <code>assets/</code> folder of the AssetPack project. With the “add existing” button you can add a file thats already in your AssetPack assets folder to a new asset item. This way you can reuse e.g. textures for asset items or make items for an existing collection of asset files that you copied to the projects assets folder. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="/wiki/lib/exe/fetch.php"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
You can specify a specific material to be used for the single mesh/scene files, just select it in the dropdown below the mesh or scene file. If you don't select a material file here, the first found material file is used or none if none is found. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
If the material file is an Ogre material file (.material) it will be used for loading an Ogre scene or mesh file. If it is a jMonkeyEngine3 material file (.j3m), it will be applied to the mesh regardless of model type. Note that for j3o models you don't need material files as the material is stored inside the j3o file. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
In your AssetPack Project, if you right-click your asset and select “preview asset” you should be able to see your model. If you do, it should work for the user as well. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
You can change the single assets properties in the properties window after you have added them. Just select an asset and open the properties window (Windows→Properties). |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Supported formats for models are: |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> OgreXML</div> |
|
||||||
</li> |
|
||||||
<li><div> Wavefront OBJ</div> |
|
||||||
</li> |
|
||||||
<li><div> jMonkeyEngine3 j3o</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>AssetPack Publishing</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="/wiki/lib/exe/fetch.php"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
You can publish your AssetPacks either as a zip file or directly to jmonkeyengine.org, using your website user name and login. This means other jMonkeyPlatform users can download your AssetPacks and install them to their local database right off the AssetPack online packages browser. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
To make sure you can upload, you have to be registered on jmonkeyengine.org and have to enter your login info in the AssetPack preferences (jMonkeyPlatform→Settings). |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Right-Click your AssetPack project and select “Publish AssetPack..”</div> |
|
||||||
</li> |
|
||||||
<li><div> Check the description etc. settings and press “Next”</div> |
|
||||||
</li> |
|
||||||
<li><div> Select the checkbox for online and/or local publishing and press “finish”</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:asset_packs?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:asset_packs?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,252 +1,112 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jMonkeyPlatform: Code Editor and Palette</a></h1> |
name="jmonkeyplatformcode_editor_and_palette">jMonkeyPlatform: Code Editor and Palette</a></h1><div |
||||||
<div> |
class="level1"><p> The Source Code Editor is the central part of the jMonkeyPlatform. This documentation shows you how to make the most of the jMonkeyPlatform's assistive features.</p><p> Note: Since the jMonkeyPlatform is based on the NetBeans Platform framework, you can learn about certain jMonkeyPlatform features by reading the corresponding NetBeans IDE tutorials (in the "see also links").</p></div><h2><a |
||||||
|
name="code_completion_and_code_generation">Code Completion and Code Generation</a></h2><div |
||||||
<p> |
class="level2"><p> While typing Java code in the source code editor, you will see popups that help you to write more quickly by completing keywords, and generating code snippets. Additionally, they will let you see the javadoc for the classes you are working with.</p><p> <a |
||||||
|
href="/wiki/lib/exe/detail.php/sdk:netbeans_code_completion.png?id=sdk%3Acode_editor"><img |
||||||
The Source Code Editor is the central part of the jMonkeyPlatform. This documentation shows you how to make the most of the jMonkeyPlatform's assistive features. |
src="nbdocs:/com/jme3/gde/core/docs/sdk/netbeans_code_completion.png" class="mediaright" align="right" alt="" /></a></p><p> Code Completion</p><ul><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Complete keyword / method / variable: <strong>Ctrl-Space</strong> (Alternatively use <strong>Ctrl-\</strong>)</div><ul><li |
||||||
<p> |
class="level2"><div |
||||||
Note: Since the jMonkeyPlatform is based on the NetBeans Platform framework, you can learn about certain jMonkeyPlatform features by reading the corresponding NetBeans IDE tutorials (in the “see also links”). |
class="li"> Customize Code Completion options: Tools > Options > Editor > Code Completion</div></li></ul></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Show expected parameters of this method in a tooltip: <strong>Ctrl-P</strong></div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Complete any string (even non-Java) that has been used before: <strong>(Shift-)Ctrl-K</strong></div></li></ul><p> Code Generation</p><ul><li |
||||||
<h2><a>Code Completion and Code Generation</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> Auto-fix import statements: <strong>Ctrl-Shift-I</strong></div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Auto-generate getters/setters, try/catch, equals/hashCode: <strong>Alt-Insert</strong></div><ul><li |
||||||
|
class="level2"><div |
||||||
While typing Java code in the source code editor, you will see popups that help you to write more quickly by completing keywords, and generating code snippets. Additionally, they will let you see the javadoc for the classes you are working with. |
class="li"> Customize code completion: Choose Tools > Options > Editor > Code Completion</div></li></ul></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Auto-generate common code snippets such as loops, declarations, println, by typing the <strong>template name + TabKey</strong></div><ul><li |
||||||
<p> |
class="level2"><div |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/netbeans_code_completion.png"> |
class="li"> Customize code templates: Choose Tools > Options > Editor > Code Templates</div></li></ul></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Rename, move, or introduce methods, fields, and variables, without breaking the project: <strong>Refactoring menu</strong></div></li></ul></div><h2><a |
||||||
<p> |
name="semantic_and_syntactic_coloring">Semantic and Syntactic Coloring</a></h2><div |
||||||
Code Completion |
class="level2"><p> <a |
||||||
</p> |
href="/wiki/lib/exe/detail.php/sdk:jmonkeyplatform-docu-5.png?id=sdk%3Acode_editor"><img |
||||||
<ul> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-5.png?w=421&h=298" class="mediaright" align="right" alt="" width="421" height="298" /></a></p><p> The text color in the editor gives you important hints how the compiler will interpret what you typed, even before you compiled it.</p><p> Examples:</p><ul><li |
||||||
<li><div> Complete keyword / method / variable: <strong>Ctrl-Space</strong> (Alternatively use <strong>Ctrl-\</strong>)</div> |
class="level1"><div |
||||||
<ul> |
class="li"> Java keywords are <strong>blue</strong>, variables and fields are <strong>green</strong>, parameters are <strong>orange</strong>.</div></li><li |
||||||
<li><div> Customize Code Completion options: Tools > Options > Editor > Code Completion </div> |
class="level1"><div |
||||||
</li> |
class="li"> <del>Strikethrough</del> means deprecated method or field.</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
</li> |
class="li"> <em |
||||||
<li><div> Show expected parameters of this method in a tooltip: <strong>Ctrl-P</strong> </div> |
class="u">Gray underline</em> means unused variable or method.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Complete any string (even non-Java) that has been used before: <strong>(Shift-)Ctrl-K</strong></div> |
class="li"> Place the caret in a method or variable and all its ocurrences are marked <strong>tan</strong>.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Place the caret in a method's return type to highlight all exit points</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> and many more…</div></li></ul><p> To customize Colors and indentation:</p><ul><li |
||||||
|
class="level1"><div |
||||||
Code Generation |
class="li"> Tools > Options > Editor > Formatting.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> Tools > Options > Fonts and Colors.</div></li></ul></div><h2><a |
||||||
<li><div> Auto-fix import statements: <strong>Ctrl-Shift-I</strong></div> |
name="editor_hints_and_quick_fixes_aka_lightbulbs">Editor Hints and Quick Fixes (a.k.a. Lightbulbs)</a></h2><div |
||||||
</li> |
class="level2"><p> Editor hints and quick fixes show as lightbulbs along the left edge of the editor. They point out warnings and errors, and often propose useful solutions!</p><ul><li |
||||||
<li><div> Auto-generate getters/setters, try/catch, equals/hashCode: <strong>Alt-Insert</strong></div> |
class="level1"><div |
||||||
<ul> |
class="li"> Execute a quick fix: Place the caret in the line next to the lightbulb and press <strong>Alt-Enter</strong> (or click the lightbulb)</div><ul><li |
||||||
<li><div> Customize code completion: Choose Tools > Options > Editor > Code Completion</div> |
class="level2"><div |
||||||
</li> |
class="li"> Customize hints: Choose Tools > Options > Editor > Hints.</div></li></ul></li></ul></div><h2><a |
||||||
</ul> |
name="javadoc">Javadoc</a></h2><div |
||||||
</li> |
class="level2"><ul><li |
||||||
<li><div> Auto-generate common code snippets such as loops, declarations, println, by typing the <strong>template name + TabKey</strong> </div> |
class="level1"><div |
||||||
<ul> |
class="li"> Place the caret above a method or a class that has no Javadoc, type <code |
||||||
<li><div> Customize code templates: Choose Tools > Options > Editor > Code Templates</div> |
class="code html4strict">/**</code> and press Enter: The editor generates skeleton code for a Javadoc comment.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Right-click the project in the Projects window and choose Generate Javadoc.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Rename, move, or introduce methods, fields, and variables, without breaking the project: <strong>Refactoring menu</strong></div> |
class="li"> Right-click a file and choose Tools > Analyze Javadoc</div></li></ul><p> To display a javadoc popup in the editor, place the caret in a line and press <strong>Ctrl-Space</strong> (Alternatively use <strong>Ctrl-\</strong>).</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> If the javadoc popup doesn't work, make certain that</div><ul><li |
||||||
|
class="level2"><div |
||||||
</div> |
class="li"> You have the Java <acronym |
||||||
|
title="Java Development Kit">JDK</acronym> documentation installed and set up: Tools > Java Platforms</div></li><li |
||||||
<h2><a>Semantic and Syntactic Coloring</a></h2> |
class="level2"><div |
||||||
<div> |
class="li"> You downloaded and set up javadoc for third-party libraries: Project properties > Libraries > Edit</div></li></ul></li></ul></div><h2><a |
||||||
|
name="navigating_the_jme3_source">Navigating the jME3 Source</a></h2><div |
||||||
<p> |
class="level2"><p> When the JavaDoc does not deliver enough information, you can have a look at the source of every method or object of jME3 that you use. Just right-click the variable or method, select "Navigate > Go to source.." and an editor will open showing you the source file of jME3.</p></div><h2><a |
||||||
|
name="palette">Palette</a></h2><div |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-5.png"> |
class="level2"><p> <a |
||||||
</p> |
href="/wiki/lib/exe/detail.php/sdk:jmonkeyplatform-docu-4.png?id=sdk%3Acode_editor"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-4.png?w=421&h=298" class="mediaright" align="right" alt="" width="421" height="298" /></a></p><p> Choose Windows > Palette to open the context-sensitive Palette. The jMonkeyPlatform provides you with jme3 code snippets here that you can drag and drop into your source files.</p><ul><li |
||||||
<p> |
class="level1"><div |
||||||
The text color in the editor gives you important hints how the compiler will interpret what you typed, even before you compiled it. |
class="li"> Examples: Node and Model creation code snippets.</div></li></ul><p> Tip: Choose Tools > Add to Palette… from the menu to add your own code snippets to the Palette. (not available yet in alpha build)</p></div><h2><a |
||||||
</p> |
name="keyboard_shortcuts">Keyboard Shortcuts</a></h2><div |
||||||
|
class="level2"><p> Keyboard Shortcuts save you time when when you need to repeat common actions such as Build&Run or navigation to files.</p><ul><li |
||||||
<p> |
class="level1"><div |
||||||
Examples: |
class="li"> Go to File: <strong>Alt-Shift-O</strong></div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> Go to Type: <strong>Ctrl-O</strong></div></li><li |
||||||
<li><div> Java keywords are <strong>blue</strong>, variables and fields are <strong>green</strong>, parameters are <strong>orange</strong>. </div> |
class="level1"><div |
||||||
</li> |
class="li"> Open in Projects / Files / Favorites window: <strong>Ctrl-Shift-1 / 2 / 3</strong></div></li><li |
||||||
<li><div> <del>Strikethrough</del> means deprecated method or field. </div> |
class="level1"><div |
||||||
</li> |
class="li"> Build&Run Project / File: <strong>F6 / Shift-F6</strong></div></li><li |
||||||
<li><div> <em>Gray underline</em> means unused variable or method.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Switch to Editor / Projects / Files / Navigator: <strong>Ctrl-0 / 1 / 3 / 7</strong></div></li><li |
||||||
<li><div> Place the caret in a method or variable and all its ocurrences are marked <strong>tan</strong>.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Indent code: <strong>Ctrl-Shift-F</strong></div></li></ul><p> By default, jMonkeyEngine uses the same <a |
||||||
<li><div> Place the caret in a method's return type to highlight all exit points</div> |
href="http://netbeans.org/project_downloads/www/shortcuts-6.5.pdf">Editor Shortcuts</a> as the NetBeans IDE, but you can also switch to an Eclipse Keymap, or create your own set.</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> and many more…</div> |
class="li"> Customize keyboard shortcuts: Tools > Options > Keymap</div></li></ul></div><h2><a |
||||||
</li> |
name="tips_and_tricks">Tips and Tricks</a></h2><div |
||||||
</ul> |
class="level2"><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> To browse the physical file structure of your project, use the Files window: <strong>Ctrl-2</strong></div></li><li |
||||||
|
class="level1"><div |
||||||
To customize Colors and indentation: |
class="li"> To open a file that is not part of a Java project, add it to the Favorites window: <strong>Ctrl-3</strong></div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> If you cannot find a particular menu item or option panel, use the IDE Search box in the top right! <strong>Ctrl-i</strong></div></li><li |
||||||
<li><div> Tools > Options > Editor > Formatting.</div> |
class="level1"><div |
||||||
</li> |
class="li"> If a code block, class, or javadoc is quite long and you don't want to scroll over it, click the <strong>+/-</strong> signs to collapse (fold) the code block temporarily.</div></li><li |
||||||
<li><div> Tools > Options > Fonts and Colors.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Press <strong>F1</strong> for Help</div></li></ul><hr |
||||||
</ul> |
/><p> See also</p><ul><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> <a |
||||||
|
href="http://netbeans.org/kb/docs/java/editor-codereference.html">Code Assistance</a></div></li></ul></div> |
||||||
<h2><a>Editor Hints and Quick Fixes (a.k.a. Lightbulbs)</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Editor hints and quick fixes show as lightbulbs along the left edge of the editor. They point out warnings and errors, and often propose useful solutions! |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Execute a quick fix: Place the caret in the line next to the lightbulb and press <strong>Alt-Enter</strong> (or click the lightbulb)</div> |
|
||||||
<ul> |
|
||||||
<li><div> Customize hints: Choose Tools > Options > Editor > Hints.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Javadoc</a></h2> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> Place the caret above a method or a class that has no Javadoc, type <code>/**</code> and press Enter: The editor generates skeleton code for a Javadoc comment. </div> |
|
||||||
</li> |
|
||||||
<li><div> Right-click the project in the Projects window and choose Generate Javadoc.</div> |
|
||||||
</li> |
|
||||||
<li><div> Right-click a file and choose Tools > Analyze Javadoc</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
To display a javadoc popup in the editor, place the caret in a line and press <strong>Ctrl-Space</strong> (Alternatively use <strong>Ctrl-\</strong>). |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> If the javadoc popup doesn't work, make certain that</div> |
|
||||||
<ul> |
|
||||||
<li><div> You have the Java <acronym title="Java Development Kit">JDK</acronym> documentation installed and set up: Tools > Java Platforms </div> |
|
||||||
</li> |
|
||||||
<li><div> You downloaded and set up javadoc for third-party libraries: Project properties > Libraries > Edit</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Navigating the jME3 Source</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
When the JavaDoc does not deliver enough information, you can have a look at the source of every method or object of jME3 that you use. Just right-click the variable or method, select “Navigate > Go to source..” and an editor will open showing you the source file of jME3. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Palette</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-4.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Choose Windows > Palette to open the context-sensitive Palette. The jMonkeyPlatform provides you with jme3 code snippets here that you can drag and drop into your source files. |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Examples: Node and Model creation code snippets.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Tip: Choose Tools > Add to Palette… from the menu to add your own code snippets to the Palette. (not available yet in alpha build) |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Keyboard Shortcuts</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Keyboard Shortcuts save you time when when you need to repeat common actions such as Build&Run or navigation to files. |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Go to File: <strong>Alt-Shift-O</strong></div> |
|
||||||
</li> |
|
||||||
<li><div> Go to Type: <strong>Ctrl-O</strong></div> |
|
||||||
</li> |
|
||||||
<li><div> Open in Projects / Files / Favorites window: <strong>Ctrl-Shift-1 / 2 / 3</strong></div> |
|
||||||
</li> |
|
||||||
<li><div> Build&Run Project / File: <strong>F6 / Shift-F6</strong></div> |
|
||||||
</li> |
|
||||||
<li><div> Switch to Editor / Projects / Files / Navigator: <strong>Ctrl-0 / 1 / 3 / 7</strong></div> |
|
||||||
</li> |
|
||||||
<li><div> Indent code: <strong>Ctrl-Shift-F</strong></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
By default, jMonkeyEngine uses the same <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://netbeans.org/project_downloads/www/shortcuts-6.5.pdf"><param name="text" value="<html><u>Editor Shortcuts</u></html>"><param name="textColor" value="blue"></object> as the NetBeans IDE, but you can also switch to an Eclipse Keymap, or create your own set. |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Customize keyboard shortcuts: Tools > Options > Keymap</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Tips and Tricks</a></h2> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> To browse the physical file structure of your project, use the Files window: <strong>Ctrl-2</strong></div> |
|
||||||
</li> |
|
||||||
<li><div> To open a file that is not part of a Java project, add it to the Favorites window: <strong>Ctrl-3</strong></div> |
|
||||||
</li> |
|
||||||
<li><div> If you cannot find a particular menu item or option panel, use the IDE Search box in the top right! <strong>Ctrl-i</strong></div> |
|
||||||
</li> |
|
||||||
<li><div> If a code block, class, or javadoc is quite long and you don't want to scroll over it, click the <strong>+/-</strong> signs to collapse (fold) the code block temporarily.</div> |
|
||||||
</li> |
|
||||||
<li><div> Press <strong>F1</strong> for Help</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
<hr /> |
|
||||||
|
|
||||||
<p> |
|
||||||
See also |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://netbeans.org/kb/docs/java/editor-codereference.html"><param name="text" value="<html><u>Code Assistance</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:code_editor?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:code_editor?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,236 +1,112 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jMonkeyPlatform: Debugging, Profiling, Testing</a></h1> |
name="jmonkeyplatformdebugging_profiling_testing">jMonkeyPlatform: Debugging, Profiling, Testing</a></h1><div |
||||||
<div> |
class="level1"><p> Debugging, testing and profiling are important parts of the development cycle. This documentation shows you how to make the most of the jMonkeyPlatform's assistive features.</p><p> <br/></p><p> Note: Since the jMonkeyPlatform is based on the NetBeans Platform framework, you can learn about certain jMonkeyPlatform features by reading the corresponding NetBeans IDE tutorials (in the "see also links").</p></div><h2><a |
||||||
|
name="testing">Testing</a></h2><div |
||||||
<p> |
class="level2"><p> The jMonkeyPlatform supports the JUnit testing framework. It is a good practice to write tests (assertions) for each of your classes. Each test makes certain this "unit" (e.g. method) meets its design and behaves as intended. Run your tests after each major change and you immediately see if you broke something.</p></div><h4><a |
||||||
|
name="creating_tests">Creating Tests</a></h4><div |
||||||
Debugging, testing and profiling are important parts of the development cycle. This documentation shows you how to make the most of the jMonkeyPlatform's assistive features. |
class="level4"><ol><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Right-click in a java file in the Projects window and choose Tools > Create JUnit Tests.</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
<br/> |
class="li"> Click OK. The jMonkeyPlatform creates a JUnit test skeleton in the Test Package directory.</div></li><li |
||||||
|
class="level1"><div |
||||||
</p> |
class="li"> The body of each generated test method is provided solely as a guide. In their place, you need to write your actual test cases!</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> You can use tests such as <code>assertTrue(), assertFalse(), assertEquals()</code>, or <code>assert()</code>.</div><ul><li |
||||||
Note: Since the jMonkeyPlatform is based on the NetBeans Platform framework, you can learn about certain jMonkeyPlatform features by reading the corresponding NetBeans IDE tutorials (in the “see also links”). |
class="level2"><div |
||||||
</p> |
class="li"> Here is an example for assertions that test an addition method: <code>assert( add(1, 1) == 2); assert( add(2,-5) == -3); …</code></div></li></ul></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> "Optimally", you should write a test case for every method (100% coverage).</div></li></ol><p> <br/> Tip: Use the Navigate menu to jump from a test to its tested class, and back.</p></div><h4><a |
||||||
|
name="running_tests">Running Tests</a></h4><div |
||||||
<h2><a>Testing</a></h2> |
class="level4"><ol><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> Right-click the class in the Projects window and Choose Test File, or right-click the project and select Test to run all tests.</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Check the Test window to see successful test (green) and test failures (red).</div></li><li |
||||||
The jMonkeyPlatform supports the JUnit testing framework. It is a good practice to write tests (assertions) for each of your classes. Each test makes certain this “unit” (e.g. method) meets its design and behaves as intended. Run your tests after each major change and you immediately see if you broke something. |
class="level1"><div |
||||||
</p> |
class="li"> If a test fails that has succeeded before, you know that your latest changes broke something!</div></li></ol><p> Using unit tests regularly allows you to detect side-effects on classes that you thought were unaffected by a code change.</p><p> <br/> See also:</p><ul><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> <a |
||||||
|
href="http://netbeans.org/kb/docs/java/junit-intro.html">Writing JUnit Tests</a></div></li><li |
||||||
<h4><a>Creating Tests</a></h4> |
class="level1"><div |
||||||
<div> |
class="li"> <a |
||||||
<ol> |
href="http://www.junit.org">http://www.junit.org</a></div></li></ul></div><h2><a |
||||||
<li><div> Right-click in a java file in the Projects window and choose Tools > Create JUnit Tests.</div> |
name="debugging">Debugging</a></h2><div |
||||||
</li> |
class="level2"><p> In the jMonkeyPlatform, you have access to a debugger to examine your application for errors such as deadlocks and NullPointerExeptions. You can set breakpoints, watch variables, and execute your code line-by-line to identify the source of a problem.</p><ol><li |
||||||
<li><div> Click OK. The jMonkeyPlatform creates a JUnit test skeleton in the Test Package directory.</div> |
class="level1"><div |
||||||
</li> |
class="li"> First, you set breakpoints and/or watches before the problematic lines of code where you suspect the bug.</div><ul><li |
||||||
<li><div> The body of each generated test method is provided solely as a guide. In their place, you need to write your actual test cases!</div> |
class="level2"><div |
||||||
</li> |
class="li"> If you want to watch a variable's value: Right-click on a variable and select New Watch from the context menu.</div></li><li |
||||||
<li><div> You can use tests such as <code>assertTrue(), assertFalse(), assertEquals()</code>, or <code>assert()</code>.</div> |
class="level2"><div |
||||||
<ul> |
class="li"> If you want to step through the execution line by line: Right-click on a line and choose Toggle Line Breakpoint; a pink box appears as a mark.</div></li></ul></li><li |
||||||
<li><div> Here is an example for assertions that test an addition method: <code>assert( add(1, 1) == 2); assert( add(2,-5) == -3); …</code></div> |
class="level1"><div |
||||||
</li> |
class="li"> Choose "Debug > Debug Main Project" to start a debugger session for the whole project. Or, right-click in a file and select Debug File to debug only one file.</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
</li> |
class="li"> The application starts running normally. If you have set a breakpoint, the execution stops. Debugger windows open and print debugger output.</div></li><li |
||||||
<li><div> “Optimally”, you should write a test case for every method (100% coverage).</div> |
class="level1"><div |
||||||
</li> |
class="li"> You can do many things now to track down a bug:</div><ul><li |
||||||
</ol> |
class="level2"><div |
||||||
|
class="li"> Inspect the values of local variables.</div></li><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> Use the Step buttons in the top to step into, out of, and over expressions while you watch the execution.</div></li><li |
||||||
<br/> |
class="level2"><div |
||||||
|
class="li"> Navigate through your application's call stack. Right-click on threads to suspend or resume them.</div></li><li |
||||||
Tip: Use the Navigate menu to jump from a test to its tested class, and back. |
class="level2"><div |
||||||
</p> |
class="li"> Choose Debug > Evaluate Expression from the menu to evaluate an expression.</div></li><li |
||||||
|
class="level2"><div |
||||||
</div> |
class="li"> Move the mouse pointer over a variable to inspect its value in a tooltip.</div></li><li |
||||||
|
class="level2"><div |
||||||
<h4><a>Running Tests</a></h4> |
class="li"> Inspect the classes loaded on the heap and the percentage and number of object instances. Right-click a class in the Loaded Classes window and choose Show in Instances view (JDK6 only).</div></li><li |
||||||
<div> |
class="level2"><div |
||||||
<ol> |
class="li"> And more…</div></li></ul></li><li |
||||||
<li><div> Right-click the class in the Projects window and Choose Test File, or right-click the project and select Test to run all tests.</div> |
class="level1"><div |
||||||
</li> |
class="li"> To stop debugging, choose Debug > End Debugger Session from the menu.</div></li></ol></div><h2><a |
||||||
<li><div> Check the Test window to see successful test (green) and test failures (red). </div> |
name="profiling">Profiling</a></h2><div |
||||||
</li> |
class="level2"><p> The profiler tool is used to monitor thread states, CPU performance, and memory usage of your jme3 application. It helps you detect memory leaks and bottlenecks in your game while it's running. <br/></p></div><h4><a |
||||||
<li><div> If a test fails that has succeeded before, you know that your latest changes broke something!</div> |
name="installing_the_profiler">Installing the Profiler</a></h4><div |
||||||
</li> |
class="level4"><p> If you do not see a Profiler menu in the jMonkeyPlatform, you need to download the Profiler plugin first.</p><ol><li |
||||||
</ol> |
class="level1"><div |
||||||
|
class="li"> Open the Tools > Plugins menu, and got to the "Available plugins" tab</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Find the "Java Profiler" plugin ("Java SE" category) and check the Install box.</div></li><li |
||||||
Using unit tests regularly allows you to detect side-effects on classes that you thought were unaffected by a code change. |
class="level1"><div |
||||||
</p> |
class="li"> Click the install button and follow the instructions.</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> When you start the profiler for the first time, you are prompted to run a calibration once. Click OK in the "Profiler integration" dialog to complete the installation process.</div></li></ol></div><h4><a |
||||||
<br/> |
name="monitoring_and_analyzing">Monitoring and Analyzing</a></h4><div |
||||||
|
class="level4"><ol><li |
||||||
See also: |
class="level1"><div |
||||||
</p> |
class="li"> Choose Profile Project from the Profile menu.</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://netbeans.org/kb/docs/java/junit-intro.html"><param name="text" value="<html><u>Writing JUnit Tests</u></html>"><param name="textColor" value="blue"></object></div> |
class="li"> Select one of three tasks:</div><ul><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.junit.org"><param name="text" value="<html><u>http://www.junit.org</u></html>"><param name="textColor" value="blue"></object></div> |
class="li"> <strong>Monitor Application</strong> – Collect high-level information about properties of the target JVM, including thread activity and memory allocations.</div></li><li |
||||||
</li> |
class="level2"><div |
||||||
</ul> |
class="li"> <strong>Analyze CPU Performance</strong> – Collect detailed data on application performance, including the time to execute methods and the number of times the method is invoked.</div></li><li |
||||||
|
class="level2"><div |
||||||
</div> |
class="li"> <strong>Analyze Memory Usage</strong> – Collect detailed data on object allocation and garbage collection.</div></li></ul></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Debugging</a></h2> |
class="li"> Click Run. Your application starts and runs normally.</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> Use the Profiling window to track and collect live profiling results while you application is running.</div></li></ol></div><h4><a |
||||||
<p> |
name="comparing_snapshots">Comparing Snapshots</a></h4><div |
||||||
|
class="level4"><p> Click the Take Snapshot button to capture the profiling data for later!</p><ul><li |
||||||
In the jMonkeyPlatform, you have access to a debugger to examine your application for errors such as deadlocks and NullPointerExeptions. You can set breakpoints, watch variables, and execute your code line-by-line to identify the source of a problem. |
class="level1"><div |
||||||
|
class="li"> You can store and view snapshots in the Profiling window.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ol> |
class="li"> Choose Compare Snapshots from the profiler window to compare two selected snapshots</div></li></ul></div><h4><a |
||||||
<li><div> First, you set breakpoints and/or watches before the problematic lines of code where you suspect the bug.</div> |
name="using_profiling_points">Using Profiling Points</a></h4><div |
||||||
<ul> |
class="level4"><p> Profiling points are similar to debugger breakpoints: You place them directly in the source code and they can trigger profiling behaviour when hit.</p><ul><li |
||||||
<li><div> If you want to watch a variable's value: Right-click on a variable and select New Watch from the context menu.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Open a class in the browser, right-click in a line, and select Profiling > Insert Profiling Point to add a profiling point here.</div></li><li |
||||||
<li><div> If you want to step through the execution line by line: Right-click on a line and choose Toggle Line Breakpoint; a pink box appears as a mark.</div> |
class="level1"><div |
||||||
</li> |
class="li"> Use Profiling points if you need a trigger to reset profiling results, take a snapshot or heap dump, record the timestamp or execution time of a code fragment, stop and start a load generator script (requires the load generator plugin).</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
</li> |
class="li"> Open the Profiling Points window to view, modify and delete the Profiling Points in your projects.</div></li></ul><p> <br/> See also:</p><ul><li |
||||||
<li><div> Choose “Debug > Debug Main Project” to start a debugger session for the whole project. Or, right-click in a file and select Debug File to debug only one file. </div> |
class="level1"><div |
||||||
</li> |
class="li"> <a |
||||||
<li><div> The application starts running normally. If you have set a breakpoint, the execution stops. Debugger windows open and print debugger output. </div> |
href="http://netbeans.org/kb/docs/java/profiler-profilingpoints.html">Using Profiling Points</a></div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> You can do many things now to track down a bug:</div> |
class="li"> <a |
||||||
<ul> |
href="http://netbeans.org/kb/docs/java/profiler-intro.html">Introduction to Profiling Java Applications</a></div></li></ul></div> |
||||||
<li><div> Inspect the values of local variables.</div> |
|
||||||
</li> |
|
||||||
<li><div> Use the Step buttons in the top to step into, out of, and over expressions while you watch the execution.</div> |
|
||||||
</li> |
|
||||||
<li><div> Navigate through your application's call stack. Right-click on threads to suspend or resume them.</div> |
|
||||||
</li> |
|
||||||
<li><div> Choose Debug > Evaluate Expression from the menu to evaluate an expression. </div> |
|
||||||
</li> |
|
||||||
<li><div> Move the mouse pointer over a variable to inspect its value in a tooltip.</div> |
|
||||||
</li> |
|
||||||
<li><div> Inspect the classes loaded on the heap and the percentage and number of object instances. Right-click a class in the Loaded Classes window and choose Show in Instances view (JDK6 only). </div> |
|
||||||
</li> |
|
||||||
<li><div> And more…</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> To stop debugging, choose Debug > End Debugger Session from the menu.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Profiling</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The profiler tool is used to monitor thread states, CPU performance, and memory usage of your jme3 application. It helps you detect memory leaks and bottlenecks in your game while it's running. |
|
||||||
<br/> |
|
||||||
|
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h4><a>Installing the Profiler</a></h4> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
If you do not see a Profiler menu in the jMonkeyPlatform, you need to download the Profiler plugin first. |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Open the Tools > Plugins menu, and got to the “Available plugins” tab </div> |
|
||||||
</li> |
|
||||||
<li><div> Find the “Java Profiler” plugin (“Java SE” category) and check the Install box.</div> |
|
||||||
</li> |
|
||||||
<li><div> Click the install button and follow the instructions.</div> |
|
||||||
</li> |
|
||||||
<li><div> When you start the profiler for the first time, you are prompted to run a calibration once. Click OK in the “Profiler integration” dialog to complete the installation process.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h4><a>Monitoring and Analyzing</a></h4> |
|
||||||
<div> |
|
||||||
<ol> |
|
||||||
<li><div> Choose Profile Project from the Profile menu. </div> |
|
||||||
</li> |
|
||||||
<li><div> Select one of three tasks:</div> |
|
||||||
<ul> |
|
||||||
<li><div> <strong>Monitor Application</strong> – Collect high-level information about properties of the target JVM, including thread activity and memory allocations.</div> |
|
||||||
</li> |
|
||||||
<li><div> <strong>Analyze CPU Performance</strong> – Collect detailed data on application performance, including the time to execute methods and the number of times the method is invoked.</div> |
|
||||||
</li> |
|
||||||
<li><div> <strong>Analyze Memory Usage</strong> – Collect detailed data on object allocation and garbage collection.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> Click Run. Your application starts and runs normally. </div> |
|
||||||
</li> |
|
||||||
<li><div> Use the Profiling window to track and collect live profiling results while you application is running.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h4><a>Comparing Snapshots</a></h4> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Click the Take Snapshot button to capture the profiling data for later! |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> You can store and view snapshots in the Profiling window. </div> |
|
||||||
</li> |
|
||||||
<li><div> Choose Compare Snapshots from the profiler window to compare two selected snapshots</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h4><a>Using Profiling Points</a></h4> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Profiling points are similar to debugger breakpoints: You place them directly in the source code and they can trigger profiling behaviour when hit. |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Open a class in the browser, right-click in a line, and select Profiling > Insert Profiling Point to add a profiling point here.</div> |
|
||||||
</li> |
|
||||||
<li><div> Use Profiling points if you need a trigger to reset profiling results, take a snapshot or heap dump, record the timestamp or execution time of a code fragment, stop and start a load generator script (requires the load generator plugin).</div> |
|
||||||
</li> |
|
||||||
<li><div> Open the Profiling Points window to view, modify and delete the Profiling Points in your projects. </div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<br/> |
|
||||||
|
|
||||||
See also: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://netbeans.org/kb/docs/java/profiler-profilingpoints.html"><param name="text" value="<html><u>Using Profiling Points</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://netbeans.org/kb/docs/java/profiler-intro.html"><param name="text" value="<html><u>Introduction to Profiling Java Applications</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:debugging_profiling_testing?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:debugging_profiling_testing?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,93 +1,36 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Default Build Script</a></h1> |
name="default_build_script">Default Build Script</a></h1><div |
||||||
<div> |
class="level1"><p> If you use jME3 together with the jMonkeyPlatform (recommended) then you benefit from the provided build script. Every new project comes with a default Ant script. The toolbar buttons and clean/build/run actions in the jMonkeyPlatform are already pre-configured.</p></div><h2><a |
||||||
|
name="default_targets">Default Targets</a></h2><div |
||||||
<p> |
class="level2"><p> The build script includes targets for the following tasks:</p><ul><li |
||||||
|
class="level1"><div |
||||||
If you use jME3 together with the jMonkeyPlatform (recommended) then you benefit from the provided build script. Every new project comes with a default Ant script. The toolbar buttons and clean/build/run actions in the jMonkeyPlatform are already pre-configured. |
class="li"> clean – deletes the built classes and executables in the dist directory.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> jar – compiles the classes, builds the executable JAR in the dist directory, copies libraries.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> run – runs the executable JAR.</div></li><li |
||||||
<h2><a>Default Targets</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> javadoc – compiles javadoc from your java files into html files.</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> debug – used by the jMonkeyPlatform Debugger plugin.</div></li><li |
||||||
|
class="level1"><div |
||||||
The build script includes targets for the following tasks: |
class="li"> test – Used by the jMonkeyPlatform JUnit Test plugin.</div></li></ul><p> Usage on the command line:</p><pre>ant clean |
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> clean – deletes the built classes and executables in the dist directory.</div> |
|
||||||
</li> |
|
||||||
<li><div> jar – compiles the classes, builds the executable JAR in the dist directory, copies libraries.</div> |
|
||||||
</li> |
|
||||||
<li><div> run – runs the executable JAR.</div> |
|
||||||
</li> |
|
||||||
<li><div> javadoc – compiles javadoc from your java files into html files.</div> |
|
||||||
</li> |
|
||||||
<li><div> debug – used by the jMonkeyPlatform Debugger plugin.</div> |
|
||||||
</li> |
|
||||||
<li><div> test – Used by the jMonkeyPlatform JUnit Test plugin.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Usage on the command line: |
|
||||||
|
|
||||||
</p> |
|
||||||
<pre>ant clean |
|
||||||
ant jar |
ant jar |
||||||
ant run</pre> |
ant run</pre><p> Recommended Usage: Use the menu items or toolbar buttons in the jMonkeyPlatform to trigger clean, build, and run actions.</p></div><h2><a |
||||||
|
name="browsing_the_build_script">Browsing the Build Script</a></h2><div |
||||||
<p> |
class="level2"><p> To see the build script and the predefined tasks</p><ol><li |
||||||
Recommended Usage: Use the menu items or toolbar buttons in the jMonkeyPlatform to trigger clean, build, and run actions. |
class="level1"><div |
||||||
</p> |
class="li"> Open your project in the jMonkeyPlatform if it isn't already open (File > Open Project…)</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Open the Files window (Window > Files)</div></li><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Browsing the Build Script</a></h2> |
class="li"> Open the project node. You see <code>build.xml</code> listed.</div><ol><li |
||||||
<div> |
class="level2"><div |
||||||
|
class="li"> Double-click <code>build.xml</code> to see how the jme3-specify build targets were defined. You typically do not need to edit the existing ones, but you can.</div></li><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> Click the triangle next to <code>build.xml</code> to see all targets.</div><ol><li |
||||||
To see the build script and the predefined tasks |
class="level3"><div |
||||||
</p> |
class="li"> Double-click a target in the Files window, or the Navigator, to see how the target was defined. <br/> You will notice that the file <code>nbproject/build-impl.xml</code> opens. It contains very generic targets that you typically will never need to edit. Note that <code>build.xml</code> includes <code>build-impl.xml</code>!</div></li></ol></li></ol></li></ol></div><h2><a |
||||||
<ol> |
name="adding_custom_targets">Adding Custom Targets</a></h2><div |
||||||
<li><div> Open your project in the jMonkeyPlatform if it isn't already open (File > Open Project…)</div> |
class="level2"><p> The build script is a non-proprietary Apache Ant script. It will work out-of-the-box, but if necessary, you can extend and customize it.</p><p> Read the comments in <code>build.xml</code>, they explain how to override targets, or extend them, to customize the build process without breaking the existing functionality.</p></div> |
||||||
</li> |
|
||||||
<li><div> Open the Files window (Window > Files)</div> |
|
||||||
</li> |
|
||||||
<li><div> Open the project node. You see <code>build.xml</code> listed.</div> |
|
||||||
<ol> |
|
||||||
<li><div> Double-click <code>build.xml</code> to see how the jme3-specify build targets were defined. You typically do not need to edit the existing ones, but you can.</div> |
|
||||||
</li> |
|
||||||
<li><div> Click the triangle next to <code>build.xml</code> to see all targets.</div> |
|
||||||
<ol> |
|
||||||
<li><div> Double-click a target in the Files window, or the Navigator, to see how the target was defined. <br/> |
|
||||||
You will notice that the file <code>nbproject/build-impl.xml</code> opens. It contains very generic targets that you typically will never need to edit. Note that <code>build.xml</code> includes <code>build-impl.xml</code>!</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Adding Custom Targets</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The build script is a non-proprietary Apache Ant script. It will work out-of-the-box, but if necessary, you can extend and customize it. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Read the comments in <code>build.xml</code>, they explain how to override targets, or extend them, to customize the build process without breaking the existing functionality. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:default_build_script?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:default_build_script?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,89 +1,71 @@ |
|||||||
|
<h2><a |
||||||
<h2><a>Developing for jMonkeyPlatform</a></h2> |
name="developing_for_jmonkeyplatform">Developing for jMonkeyPlatform</a></h2><div |
||||||
<div> |
class="level2"><p> <em>Note that all info is subject to change while jMP is still in alpha!</em> In general, developing plugins for jMonkeyPlatform is not much different than creating plugins for the NetBeans Platform which in turn is not much different than creating Swing applications. You can use jMonkeyPlatform to develop plugins, be it for personal use or to contribute to the community. |
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<em>Note that all info is subject to change while jMP is still in alpha!</em> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
In general, developing plugins for jMonkeyPlatform is not much different than creating plugins for the NetBeans Platform which in turn is not much different than creating Swing applications. You can use jMonkeyPlatform to develop plugins, be it for personal use or to contribute to the community. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
If you feel like you want to make an addition to jMonkeyPlatform dont hesitate to contact the jme team regardless of your knowledge in NetBeans platform development. For new plugins, the basic project creation and layout of the plugin can always be handled by a core developer and you can go on from there fleshing out the plugin. |
If you feel like you want to make an addition to jMonkeyPlatform dont hesitate to contact the jme team regardless of your knowledge in NetBeans platform development. For new plugins, the basic project creation and layout of the plugin can always be handled by a core developer and you can go on from there fleshing out the plugin. |
||||||
</p> |
By using the Platform functions, your plugin feels more like a Platform application (global save button, file type support etc.).</p></div><h4><a |
||||||
|
name="creating_plugins_and_components">Creating plugins and components</a></h4><div |
||||||
<p> |
class="level4"><ul><li |
||||||
By using the Platform functions, your plugin feels more like a Platform application (global save button, file type support etc.). |
class="level1"><div |
||||||
</p> |
class="li"> <a |
||||||
|
href="/com/jme3/gde/core/docs/sdk/development/setup.html">Creating a plugin</a></div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
<h4><a>Creating plugins and components</a></h4> |
href="/com/jme3/gde/core/docs/sdk/development/general.html">Creating components</a></div></li></ul></div><h4><a |
||||||
<div> |
name="extending_jmonkeyplatform">Extending jMonkeyPlatform</a></h4><div |
||||||
<ul> |
class="level4"><ul><li |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/sdk/development/setup.html">Creating a plugin</a></div> |
class="level1"><div |
||||||
</li> |
class="li"> <a |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/sdk/development/general.html">Creating components</a></div> |
href="/com/jme3/gde/core/docs/sdk/development/scene.html">The Main Scene</a></div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> <a |
||||||
|
href="/com/jme3/gde/core/docs/sdk/development/sceneexplorer.html">The Scene Explorer</a></div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> <a |
||||||
<h4><a>Extending jMonkeyPlatform</a></h4> |
href="/com/jme3/gde/core/docs/sdk/development/projects_assets.html">Projects and Assets</a></div></li></ul></div><h4><a |
||||||
<div> |
name="recipes">Recipes</a></h4><div |
||||||
<ul> |
class="level4"><ul><li |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/sdk/development/scene.html">The Main Scene</a></div> |
class="level1"><div |
||||||
</li> |
class="li"> <a |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/sdk/development/sceneexplorer.html">The Scene Explorer</a></div> |
href="/com/jme3/gde/core/docs/sdk/development/extension_library.html">Create a library plugin from a jar file</a></div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/sdk/development/projects_assets.html">Projects and Assets</a></div> |
class="li"> <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/sdk/development/model_loader.html">Create a new or custom model filetype and loader</a></div></li></ul></div><h4><a |
||||||
</ul> |
name="general_notes">General Notes</a></h4><div |
||||||
|
class="level4"><ul><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> <strong>Remember the scene runs on the render thread and most everything you do in the plugin (button events etc.) runs on the AWT thread, always encapsulate calls to either side correctly via Callables/Runnables or register as an AppState to the SceneApplication to have an update() call by the render thread.</strong></div></li><li |
||||||
<h4><a>Recipes</a></h4> |
class="level1"><div |
||||||
<div> |
class="li"> Although the scene can be accessed at any time via SceneApplication.getApplication() it is not recommended to modify the scene like that. Other plugins might be accessing the scene and updates will not be properly recognized. Use the sceneRequest object and the lookup of selected nodes and files to access things like the assetManager etc.</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/sdk/development/extension_library.html">Create a library plugin from a jar file</a></div> |
class="li"> It became a standard in jMP to start the name of methods that execute directly on the OpenGL thread with \"do\" e.g \"doMoveSpatial\", this makes identifying threading issues easier.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/sdk/development/model_loader.html">Create a new or custom model filetype and loader</a></div> |
class="li"> The AssetManager of jme3 is threadsafe and can be used from any thread to load assets</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> You can get access to the ProjectAssetManager via the Lookup of a JmeSpatial and other objects</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Use org.openide.filesystems.FileObject instead of java.io.File for file access, it always uses system-independent \"/\" path separators and has some more advanced functions that make file handling easier.</div></li><li |
||||||
|
class="level1"><div |
||||||
<h4><a>General Notes</a></h4> |
class="li"> You can get a file from a string using Repository.getDefault().getDefaultFileSystem().getRoot().getFileObject(\"aaa/bbb/ccc/whatever\");</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
<ul> |
class="li"> You can convert a regular java File to a FileObject and vice versa using org.openide.filesystems.FileUtil</div></li><li |
||||||
<li><div> <em>Although the scene can be accessed at any time via SceneApplication.getApplication() it is not recommended to modify the scene like that. Other plugins might be accessing the scene and updates will not be properly recognized.</em></div> |
class="level1"><div |
||||||
</li> |
class="li"> If you have problems with unresolved classes, check if all needed Libraries are registered in the settings of your Project. To find out which library contains a certain class, just enter the name in the library search field.</div></li></ul></div><h4><a |
||||||
<li><div> <em>Remember the scene runs on the render thread and most everything you do in the plugin (button events etc.) runs on the AWT thread, always encapsulate calls to either side correctly via Callables/Runnables or register as an AppState to the SceneApplication to have an update() call by the render thread.</em></div> |
name="handy_things_in_jmonkeyplatform_core">Handy things in jMonkeyPlatform Core</a></h4><div |
||||||
</li> |
class="level4"><ul><li |
||||||
<li><div> <em>It became a standard in jMP to start the name of methods that execute directly on the OpenGL thread with “do” e.g “doMoveSpatial”, this makes identifying threading issues easier.</em></div> |
class="level1"><div |
||||||
</li> |
class="li"> com.jme3.gde.core.scene.controller</div><ul><li |
||||||
<li><div> <em>The AssetManager of jme3 is threadsafe and can be used from any thread to load assets</em></div> |
class="level2"><div |
||||||
</li> |
class="li"> AbstractCameraController → A basic camera control for plugins, used by SimpleSceneComposer and \"View Model\"</div></li><li |
||||||
<li><div> <em>You can get access to the ProjectAssetManager via the Lookup of a JmeSpatial and other objects</em></div> |
class="level2"><div |
||||||
</li> |
class="li"> SceneToolController → A basic controller for having selection, cursor etc. displayed in the scene, used by SimpleSceneComposer</div></li></ul></li><li |
||||||
<li><div> <em>Use org.openide.filesystems.FileObject instead of java.io.File for file access, it always uses system-independent ”/” path separators and has some more advanced functions that make file handling easier. |
class="level1"><div |
||||||
* You can get a file from a string using Repository.getDefault().getDefaultFileSystem().getRoot().getFileObject(“aaa/bbb/ccc/whatever”);</em></div> |
class="li"> com.jme3.gde.core.scene</div><ul><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> You can convert a regular java File to a FileObject and vice versa using org.openide.filesystems.FileUtil</div> |
class="li"> OffViewPanel → A panel that renders a 3d scene in a preview and displays it in a lightweight swing panel</div></li></ul></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <em>If you have problems with unresolved classes, check if all needed Libraries are registered in the settings of your Project. To find out which library contains a certain class, just enter the name in the library search field.</em></div> |
class="li"> com.jme3.gde.core.util</div><ul><li |
||||||
</li> |
class="level2"><div |
||||||
</ul> |
class="li"> DataObjectSaveNode → Allows enabling the save all button by using any file and implementing the SvaeCookie yourself.</div></li></ul></li></ul><p> Learn more about NetBeans Plugin Development at <a |
||||||
|
href="http://platform.netbeans.org">http://platform.netbeans.org</a> .\\<br/> Also check out this Essential NetBeans Platform Refcard: <a |
||||||
<p> |
href="http://refcardz.dzone.com/refcardz/essential-netbeans-platform">http://refcardz.dzone.com/refcardz/essential-netbeans-platform</a></p></div> |
||||||
|
|
||||||
Learn more about NetBeans Plugin Development at <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://platform.netbeans.org"><param name="text" value="<html><u>http://platform.netbeans.org</u></html>"><param name="textColor" value="blue"></object> .<br/> |
|
||||||
|
|
||||||
Also check out this Essential NetBeans Platform Refcard: <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://refcardz.dzone.com/refcardz/essential-netbeans-platform"><param name="text" value="<html><u>http://refcardz.dzone.com/refcardz/essential-netbeans-platform</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,79 +1,46 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Creating an extension library plugin</a></h1> |
name="creating_an_extension_library_plugin">Creating an extension library plugin</a></h1><div |
||||||
<div> |
class="level1"><p> This page describes how you can wrap any jar library into a plugin that a jMP user can download, install and then use the contained library in his own game projects.</p><p> <br/> Creating the plugin project (in jMP):</p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Create a new Module Suite (or use an existing one)</div></li><li |
||||||
This page describes how you can wrap any jar library into a plugin that a jMP user can download, install and then use the contained library in his own game projects. |
class="level1"><div |
||||||
</p> |
class="li"> Open the suite, right-click the "Modules" folder and select "Add new.."</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> For "Project Name" enter an all-lowercase name without spaces like <code>my-library</code></div></li><li |
||||||
<br/> |
class="level1"><div |
||||||
|
class="li"> Make sure the "Project Location" is inside the module suite folder and press "Next"</div></li><li |
||||||
Creating the plugin project (in jMP): |
class="level1"><div |
||||||
</p> |
class="li"> Enter the base java package for your plugin in "Code Name Base" like <code>com.mycompany.plugins.mylibrary</code></div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Create a new Module Suite (or use an existing one)</div> |
class="li"> Enter a "Module Display Name" for your plugin like "My Library"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Open the suite, right-click the “Modules” folder and select “Add new..”</div> |
class="li"> Check the "Generate <acronym |
||||||
</li> |
title="Extensible Markup Language">XML</acronym> Layer" checkbox</div></li><li |
||||||
<li><div> For “Project Name” enter an all-lowercase name without spaces like <code>my-library</code></div> |
class="level1"><div |
||||||
</li> |
class="li"> Press Finish</div></li></ul><p> Adding the library:</p><ul><li |
||||||
<li><div> Make sure the “Project Location” is inside the module suite folder and press “Next”</div> |
class="level1"><div |
||||||
</li> |
class="li"> Right click the Module Project and select "New→Other"</div></li><li |
||||||
<li><div> Enter the base java package for your plugin in “Code Name Base” like <code>com.mycompany.plugins.mylibrary</code></div> |
class="level1"><div |
||||||
</li> |
class="li"> Under "Module Development" select the "Java SE Library Descriptor" template and press "Next"</div></li><li |
||||||
<li><div> Enter a “Module Display Name” for your plugin like “My Library”</div> |
class="level1"><div |
||||||
</li> |
class="li"> If you dont have the external library registered in jMP yet, click "Manage Libraries" and do the following:</div><ul><li |
||||||
<li><div> Check the “Generate <acronym title="Extensible Markup Language">XML</acronym> Layer” checkbox</div> |
class="level2"><div |
||||||
</li> |
class="li"> Click "New Library", enter a name for the library and press OK</div></li><li |
||||||
<li><div> Press Finish</div> |
class="level2"><div |
||||||
</li> |
class="li"> In the "Classpath" tab, press "Add JAR/Folder" and select the jar file(s) needed for the library</div></li><li |
||||||
</ul> |
class="level2"><div |
||||||
|
class="li"> In the "JavaDoc" tab, press "Add ZIP/Folder" and add the javadoc for the library (zipped or folder)</div></li><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> In the "Sources" tab you can add a folder or jar file containing the source files of the library if available</div></li><li |
||||||
Adding the library: |
class="level2"><div |
||||||
</p> |
class="li"> Press OK</div></li></ul></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Right click the Module Project and select “New→Other”</div> |
class="li"> Select the external library from the list and press "Next"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Under “Module Development” select the “Java SE Library Descriptor” template and press “Next”</div> |
class="li"> Enter a name for the Library (used as filename for the description file)</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> If you dont have the external library registered in jMP yet, click “Manage Libraries” and do the following:</div> |
class="li"> Enter a display name for the Library (This is the name the user later sees in his library list)</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Click “New Library”, enter a name for the library and press OK</div> |
class="li"> Press OK</div></li></ul><p> You will notice a new file "MyLibrary.xml" is created in the plugins base package and linked to in the layer.xml file. This is basically it, you can configure a version number, license file (should be placed in Module root folder) and more via the Module Properties.</p><p> <br/> After you are done, you can <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/sdk/development/setup#jmp_contributions_update_center.html">contribute the plugin in the jMP contribution update center</a>.</p></div> |
||||||
<li><div> In the “Classpath” tab, press “Add JAR/Folder” and select the jar file(s) needed for the library</div> |
|
||||||
</li> |
|
||||||
<li><div> In the “JavaDoc” tab, press “Add ZIP/Folder” and add the javadoc for the library (zipped or folder)</div> |
|
||||||
</li> |
|
||||||
<li><div> In the “Sources” tab you can add a folder or jar file containing the source files of the library if available</div> |
|
||||||
</li> |
|
||||||
<li><div> Press OK</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> Select the external library from the list and press “Next”</div> |
|
||||||
</li> |
|
||||||
<li><div> Enter a name for the Library (used as filename for the description file)</div> |
|
||||||
</li> |
|
||||||
<li><div> Enter a display name for the Library (This is the name the user later sees in his library list)</div> |
|
||||||
</li> |
|
||||||
<li><div> Press OK</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You will notice a new file “MyLibrary.xml” is created in the plugins base package and linked to in the layer.xml file. This is basically it, you can configure a version number, license file (should be placed in Module root folder) and more via the Module Properties. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<br/> |
|
||||||
|
|
||||||
After you are done, you can <a href="/com/jme3/gde/core/docs/sdk/development/setup#jmp_contributions_update_center.html">contribute the plugin in the jMP contribution update center</a>. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:extension_library?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:extension_library?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,22 +1,8 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Creating plugin components</a></h1> |
name="creating_plugin_components">Creating plugin components</a></h1><div |
||||||
<div> |
class="level1"><p> For the most common extensions like Windows, File Types, Libraries etc. there exist templates that you can add to your plugin.</p><ol><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Right-click your Module Project and select New→Other</div></li><li |
||||||
For the most common extensions like Windows, File Types, Libraries etc. there exist templates that you can add to your plugin. |
class="level1"><div |
||||||
|
class="li"> Select "Module Development" to the left</div></li></ol><p> You will see a list of components you can add to your project. A wizard will guide you through the creation of the component.</p></div> |
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Right-click your Module Project and select New→Other</div> |
|
||||||
</li> |
|
||||||
<li><div> Select “Module Development” to the left</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You will see a list of components you can add to your project. A wizard will guide you through the creation of the component. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:general?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:general?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,41 +1,22 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Creating a model importer</a></h1> |
name="creating_a_model_importer">Creating a model importer</a></h1><div |
||||||
<div> |
class="level1"><ol><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Create plugin</div></li><li |
||||||
|
class="level1"><div |
||||||
TODO |
class="li"> Add importer jar file (wrap jar file)</div></li><li |
||||||
|
class="level1"><div |
||||||
</p> |
class="li"> Add filetype (Template)</div></li><li |
||||||
<ol> |
class="level1"><div |
||||||
<li><div> Create plugin</div> |
class="li"> Change DataObject to extend SpatialAssetDataObject</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Add importer jar file (wrap jar file)</div> |
class="li"> Implement loadAsset method in DataObject (if necessary, most model formats should load normally via the loader)</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Add filetype (Template)</div> |
class="li"> Create AssetManagerConfigurator \</div></li></ol><p> See also:</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Change DataObject to extend SpatialAssetDataObject</div> |
class="li"> <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/sdk/development/projects_assets.html">Projects and Assets</a></div></li><li |
||||||
<li><div> Implement loadAsset method in DataObject (if necessary)</div> |
class="level1"><div |
||||||
</li> |
class="li"> <a |
||||||
<li><div> Create AssetManagerConfiguratorSee also:</div> |
href="http://platform.netbeans.org/tutorials/nbm-filetype.html">http://platform.netbeans.org/tutorials/nbm-filetype.html</a></div></li></ul></div> |
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://platform.netbeans.org/tutorials/nbm-filetype.html"><param name="text" value="<html><u>http://platform.netbeans.org/tutorials/nbm-filetype.html</u></html>"><param name="textColor" value="blue"></object> |
|
||||||
</p> |
|
||||||
<div> |
|
||||||
<fieldset> |
|
||||||
<legend><img src="/wiki/lib/plugins/task/images/ics.gif"> Task</legend> |
|
||||||
<table> |
|
||||||
<tr> |
|
||||||
<th>Assigned to:</th><td><span>normen</span></td> |
|
||||||
</tr> |
|
||||||
</table> |
|
||||||
</fieldset> |
|
||||||
</div> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:model_loader?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:model_loader?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,44 +1,29 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Projects and Assets</a></h1> |
name="projects_and_assets">Projects and Assets</a></h1><div |
||||||
<div> |
class="level1"><p> The <acronym |
||||||
|
title="Software Development Kit">SDK</acronym> heavily uses the systems provided by the base platform for the handling of assets and projects and extends the system with jME3 specific features.</p></div><h2><a |
||||||
<p> |
name="projectassetmanager">ProjectAssetManager</a></h2><div |
||||||
The <acronym title="Software Development Kit">SDK</acronym> heavily uses the systems provided by the base platform for the handling of assets and projects and extends the system with jME3 specific features. |
class="level2"><p> All AssetDataObjects and SceneExplorerNodes allow access to the ProjectAssetManager of the project they were loaded from.</p><pre>ProjectAssetManager pm = node.getLookup().lookup(ProjectAssetManager.class)</pre><p> The ProjectAssetManager is basically a normal DesktopAssetManager for each project with some added functionality:</p><ul><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Access to the FileObject of the assets folder of the project to load and save data</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Convert absolute file paths to relative asset paths and vice versa</div></li><li |
||||||
<h2><a>AssetDataObject</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> Get lists of all textures, materials etc. in the project</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> more convenient stuff.. :)</div></li></ul></div><h2><a |
||||||
Most “files” that you encounter in the <acronym title="Software Development Kit">SDK</acronym> come in the form of AssetDataObjects. All Nodes that you encounter contain the AssetDataObject they were loaded from. It provides not just access to the FileObject of the specific file but also an AssetData object that allows access to jME specific properties and data. The AssetData object also allows loading the object via the jME3 assetManager. It is accessible via the lookup of the Node or AssetDataObject: |
name="assetdataobject">AssetDataObject</a></h2><div |
||||||
|
class="level2"><p> Most "files" that you encounter in the <acronym |
||||||
</p> |
title="Software Development Kit">SDK</acronym> come in the form of AssetDataObjects. All Nodes that you encounter contain the AssetDataObject they were loaded from. It provides not just access to the FileObject of the specific file but also an AssetData object that allows access to jME specific properties and data. The AssetData object also allows loading the object via the jME3 assetManager. It is accessible via the lookup of the Node or AssetDataObject:</p><pre>assetDataObject.getLookup().lookup(AssetData.class)</pre></div><h2><a |
||||||
<pre>assetDataObject.getLookup().lookup(AssetData.class)</pre> |
name="new_asset_file_types">New Asset File Types</a></h2><div |
||||||
</div> |
class="level2"><p> When you add a new file type for a model format or other asset file that can be loaded in jME3 you can start by using new file type template (New File→Module Development→File Type). Change the DataObject to extend AssetDataObject (general), SpatialAssetDataObject (some type of model) or BinaryModelDataObject (basically a j3o savable file). And possibly override the loadAsset and saveAsset methods which are used by the AssetData object.</p><pre>public class BlenderDataObject extends SpatialAssetDataObject { |
||||||
|
public BlenderDataObject(FileObject pf, MultiFileLoader loader) throws DataObjectExistsException, IOException { |
||||||
<h2><a>ProjectAssetManager</a></h2> |
super(pf, loader); |
||||||
<div> |
} |
||||||
|
}</pre><p> An AssetManagerConfigurator class can be created to configure the assetManager of the projects and model importer to use the new asset type:</p><pre>@org.openide.util.lookup.ServiceProvider(service = AssetManagerConfigurator.class) |
||||||
<p> |
public class BlenderAssetManagerConfigurator implements AssetManagerConfigurator { |
||||||
All AssetDataObjects and SceneExplorerNodes allow access to the ProjectAssetManager of the project they were loaded from. |
public void prepareManager(AssetManager manager) { |
||||||
|
manager.registerLoader(com.jme3.scene.plugins.blender.BlenderModelLoader.class, "blend"); |
||||||
</p> |
} |
||||||
<pre>ProjectAssetManager pm = node.getLookup().lookup(ProjectAssetManager.class)</pre> |
}</pre></div> |
||||||
<p> |
|
||||||
The ProjectAssetManager is basically a normal DesktopAssetManager for each project with some added functionality: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Access to the FileObject of the assets folder of the project to load and save data</div> |
|
||||||
</li> |
|
||||||
<li><div> Convert absolute file paths to relative asset paths and vice versa</div> |
|
||||||
</li> |
|
||||||
<li><div> Get lists of all textures, materials etc. in the project</div> |
|
||||||
</li> |
|
||||||
<li><div> more convenient stuff.. :)</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:projects_assets?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:projects_assets?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,118 +1,85 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Creating a jMP plugin</a></h1> |
name="creating_a_jmp_plugin">Creating a jMP plugin</a></h1><div |
||||||
<div> |
class="level1"><p> Note that the creation of a Module Suite is only necessary if you want to upload your plugin to the contribution update center.</p></div><h3><a |
||||||
|
name="using_jmp_for_development_preferred">Using jMP for development (preferred)</a></h3><div |
||||||
<p> |
class="level3"><ul><li |
||||||
Note that the creation of a Module Suite is only necessary if you want to upload your plugin to the contribution update center. |
class="level1"><div |
||||||
|
class="li"> Install the "Netbeans Plugin Development", "NetBeans <acronym |
||||||
</p> |
title="Application Programming Interface">API</acronym> Documentation" and "<acronym |
||||||
|
title="Graphical User Interface">GUI</acronym> Builder" plugins via Tools→Plugins</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Create a new "Module Suite" project (can be any name, this will be your local "collection" of plugins that you create)</div></li><li |
||||||
<h3><a>Using jMP for development (preferred)</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> Open the suite, right-click the "Modules" folder and select "Add new.."</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Install the “Netbeans Plugin Development”, “NetBeans <acronym title="Application Programming Interface">API</acronym> Documentation” and “<acronym title="Graphical User Interface">GUI</acronym> Builder” plugins via Tools→Plugins</div> |
class="li"> For "Project Name" enter an all-lowercase name without spaces like <code>my-library</code></div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Create a new “Module Suite” project (can be any name, this will be your local “collection” of plugins that you create)</div> |
class="li"> Make sure the "Project Location" is inside the module suite folder and press "Next"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Open the suite, right-click the “Modules” folder and select “Add new..”</div> |
class="li"> Enter the base java package for your plugin in "Code Name Base" like <code>com.mycompany.plugins.mylibrary</code></div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> For “Project Name” enter an all-lowercase name without spaces like <code>my-library</code></div> |
class="li"> Enter a "Module Display Name" for your plugin like "My Library"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Make sure the “Project Location” is inside the module suite folder and press “Next”</div> |
class="li"> Check the "Generate <acronym |
||||||
</li> |
title="Extensible Markup Language">XML</acronym> Layer" checkbox</div></li><li |
||||||
<li><div> Enter the base java package for your plugin in “Code Name Base” like <code>com.mycompany.plugins.mylibrary</code></div> |
class="level1"><div |
||||||
</li> |
class="li"> Press Finish</div></li><li |
||||||
<li><div> Enter a “Module Display Name” for your plugin like “My Library”</div> |
class="level1"><div |
||||||
</li> |
class="li"> To use core jMP or jME3 functions, add "jMonkeyPlatfom Core" and "jMonkeyPlatform Core jME3" via "Module Properties→Library→Add Dependency"</div></li><li |
||||||
<li><div> Check the “Generate <acronym title="Extensible Markup Language">XML</acronym> Layer” checkbox</div> |
class="level1"><div |
||||||
</li> |
class="li"> Write your plugin</div></li></ul></div><h3><a |
||||||
<li><div> Press Finish</div> |
name="using_netbeans_for_development">Using NetBeans for development</a></h3><div |
||||||
</li> |
class="level3"><ul><li |
||||||
<li><div> To use core jMP or jME3 functions, add “jMonkeyPlatfom Core” and “jMonkeyPlatform Core jME3” via “Module Properties→Library→Add Dependency”</div> |
class="level1"><div |
||||||
</li> |
class="li"> Download the jMP source from svn, then open and compile the project</div></li><li |
||||||
<li><div> Write your plugin </div> |
class="level1"><div |
||||||
</li> |
class="li"> Create a new "Module Suite" project (can be any name, this will be your local "collection" of plugins that you create)</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> In the Suites Properties, under "Libraries", press "Add Project" and select the jMP project folder.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Open the suite, right-click the "Modules" folder and select "Add new.."</div></li><li |
||||||
<h3><a>Using NetBeans for development</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> For "Project Name" enter an all-lowercase name for your plugin without spaces like <code>my-library</code></div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Download the jMP source from svn, then open and compile the project</div> |
class="li"> Make sure the "Project Location" is inside the module suite folder and press "Next"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Create a new “Module Suite” project (can be any name, this will be your local “collection” of plugins that you create)</div> |
class="li"> Enter the base java package for your plugin in "Code Name Base" like <code>com.mycompany.plugins.mylibrary</code></div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> In the Suites Properties, under “Libraries”, press “Add Project” and select the jMP project folder.</div> |
class="li"> Enter a "Module Display Name" for your plugin like "My Library"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Open the suite, right-click the “Modules” folder and select “Add new..”</div> |
class="li"> Check the "Generate <acronym |
||||||
</li> |
title="Extensible Markup Language">XML</acronym> Layer" checkbox</div></li><li |
||||||
<li><div> For “Project Name” enter an all-lowercase name for your plugin without spaces like <code>my-library</code></div> |
class="level1"><div |
||||||
</li> |
class="li"> Press Finish</div></li><li |
||||||
<li><div> Make sure the “Project Location” is inside the module suite folder and press “Next”</div> |
class="level1"><div |
||||||
</li> |
class="li"> To use core jMP or jME3 functions, add "jMonkeyPlatfom Core" and "jMonkeyPlatform Core jME3" via "Module Properties→Library→Add Dependency"</div></li><li |
||||||
<li><div> Enter the base java package for your plugin in “Code Name Base” like <code>com.mycompany.plugins.mylibrary</code></div> |
class="level1"><div |
||||||
</li> |
class="li"> Write your plugin</div></li></ul></div><h3><a |
||||||
<li><div> Enter a “Module Display Name” for your plugin like “My Library”</div> |
name="jmp_contributions_update_center">jMP Contributions Update Center</a></h3><div |
||||||
</li> |
class="level3"><p> If you want your plugin to appear in the "jMP Contributions Update Center" so users can download, install and update it easily via the plugin manager, you can host your plugin in the contributions update center svn repository. The contributions update center is based on a googlecode project for contributed plugins which will be automatically compiled, version-labeled and added to the contributions update center like the core jMP plugins.</p><p> <br/> To add your plugin to the repository, do the following:</p><ul><li |
||||||
<li><div> Check the “Generate <acronym title="Extensible Markup Language">XML</acronym> Layer” checkbox</div> |
class="level1"><div |
||||||
</li> |
class="li"> Make sure the plugin is part of a "Module Suite" and that its located in the folder of the suite (this saves you from problems with the svn and local version not being configured the same)</div></li><li |
||||||
<li><div> Press Finish</div> |
class="level1"><div |
||||||
</li> |
class="li"> In "Module Properties→Sources" set the "Source Level" to 1.5 if possible (jMP is compatible to Java 1.5)</div></li><li |
||||||
<li><div> To use core jMP or jME3 functions, add “jMonkeyPlatfom Core” and “jMonkeyPlatform Core jME3” via “Module Properties→Library→Add Dependency”</div> |
class="level1"><div |
||||||
</li> |
class="li"> In "Module Properties→<acronym |
||||||
<li><div> Write your plugin </div> |
title="Application Programming Interface">API</acronym> Versioning" set a specification version for your plugin (like 0.8.1)</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Set the "implementation version" to "0" and select "append implementation versions automatically"</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Ask the managers or developers for access to the gc project</div></li><li |
||||||
|
class="level1"><div |
||||||
<h3><a>jMP Contributions Update Center</a></h3> |
class="li"> Commit <strong>only the module project</strong> to trunk:</div><ul><li |
||||||
<div> |
class="level2"><div |
||||||
|
class="li"> Right click the Plugin Project and select "Versioning → Import into Subversion Repository"</div></li><li |
||||||
<p> |
class="level2"><div |
||||||
If you want your plugin to appear in the “jMP Contributions Update Center” so users can download, install and update it easily via the plugin manager, you can host your plugin in the contributions update center svn repository. The contributions update center is based on a googlecode project for contributed plugins which will be automatically compiled, version-labeled and added to the contributions update center like the core jMP plugins. |
class="li"> Enter <code><a |
||||||
</p> |
href="https://jmonkeyplatform-contributions.googlecode.com/svn/trunk">https://jmonkeyplatform-contributions.googlecode.com/svn/trunk</a></code> in the <acronym |
||||||
|
title="Uniform Resource Locator">URL</acronym> field</div></li><li |
||||||
<p> |
class="level2"><div |
||||||
<br/> |
class="li"> Enter your googlecode username and commit password (different than login pass!) and press "Next"</div></li><li |
||||||
|
class="level2"><div |
||||||
To add your plugin to the repository, do the following: |
class="li"> Check that the "Repository Folder" is <code>trunk/mypluginfolder</code> and enter an import message</div></li><li |
||||||
</p> |
class="level2"><div |
||||||
<ul> |
class="li"> Press "Finish"</div></li></ul></li></ul><p> And thats it, from now on each time you commit changes to your module it will be built and added to the contributions center automatically and the version number will be extended by the svn revision number (e.g. 0.8.1.1234)</p></div> |
||||||
<li><div> Make sure the plugin is part of a “Module Suite” and that its located in the folder of the suite (this saves you from problems with the svn and local version not being configured the same)</div> |
|
||||||
</li> |
|
||||||
<li><div> In “Module Properties→Sources” set the “Source Level” to 1.5 if possible (jMP is compatible to Java 1.5)</div> |
|
||||||
</li> |
|
||||||
<li><div> In “Module Properties→<acronym title="Application Programming Interface">API</acronym> Versioning” set a specification version for your plugin (like 0.8.1)</div> |
|
||||||
</li> |
|
||||||
<li><div> Set the “implementation version” to “0” and select “append implementation versions automatically”</div> |
|
||||||
</li> |
|
||||||
<li><div> Ask the managers or developers for access to the gc project</div> |
|
||||||
</li> |
|
||||||
<li><div> Commit <strong>only the module project</strong> to trunk:</div> |
|
||||||
<ul> |
|
||||||
<li><div> Right click the Plugin Project and select “Versioning → Import into Subversion Repository”</div> |
|
||||||
</li> |
|
||||||
<li><div> Enter <code><object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="https://jmonkeyplatform-contributions.googlecode.com/svn/trunk"><param name="text" value="<html><u>https://jmonkeyplatform-contributions.googlecode.com/svn/trunk</u></html>"><param name="textColor" value="blue"></object></code> in the <acronym title="Uniform Resource Locator">URL</acronym> field</div> |
|
||||||
</li> |
|
||||||
<li><div> Enter your googlecode username and commit password (different than login pass!) and press “Next”</div> |
|
||||||
</li> |
|
||||||
<li><div> Check that the “Repository Folder” is <code>trunk/mypluginfolder</code> and enter an import message</div> |
|
||||||
</li> |
|
||||||
<li><div> Press “Finish”</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
And thats it, from now on each time you commit changes to your module it will be built and added to the contributions center automatically and the version number will be extended by the svn revision number (e.g. 0.8.1.1234) |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:setup?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:development:setup?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,108 +1,52 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>The Material Editor</a></h1> |
name="the_material_editor">The Material Editor</a></h1><div |
||||||
<div> |
class="level1"></div><h2><a |
||||||
|
name="materials">Materials</a></h2><div |
||||||
</div> |
class="level2"><p> The jMonkeyEngine uses a special Material format, which comes in .j3m files. You use .j3m files to store sets of material properties that you use repeatedly. This enables you write one short line of code that simply loads the presets from a custom j3m file. Without a .j3m file you need to write several lines of material property setters every time when you want to use a non-default material.</p></div><h2><a |
||||||
|
name="creating_j3m_materials">Creating .j3m Materials</a></h2><div |
||||||
<h2><a>Materials</a></h2> |
class="level2"><p> <a |
||||||
<div> |
href="/wiki/lib/exe/detail.php/sdk:material-editor.png?id=sdk%3Amaterial_editing"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/sdk/material-editor.png?w=306&h=395" class="mediaright" align="right" alt="" width="306" height="395" /></a></p><p> To create new .j3m files,</p><ol><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> Right-click the <code>assets/Materials</code> directory and choose New… > Other.</div></li><li |
||||||
The jMonkeyEngine uses a special Material format, which comes in .j3m files. You use .j3m files to store sets of material properties that you use repeatedly. This enables you write one short line of code that simply loads the presets from a custom j3m file. Without a .j3m file you need to write several lines of material property setters every time when you want to use a non-default material. |
class="level1"><div |
||||||
|
class="li"> In the New File Wizard, choose Material > Empty Material File, and click Next.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Give the file a name, for example <code>mat_wall</code> for a wall material.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> A new file <code>mat_wall.j3m</code> is created in the Materials directory and opens in the Material Editor.</div></li></ol><p> You can edit the source of the material, or use the user-friendly visual editor to set the properties of the material. Set the properties to the same values as you would otherwise specify with setters on a Material object in Java code:</p><pre>Material mat_wall = new Material( |
||||||
<h2><a>Creating .j3m Materials</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/material-editor.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
To create new .j3m files, |
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Right-click the <code>assets/Materials</code> directory and choose New… > Other.</div> |
|
||||||
</li> |
|
||||||
<li><div> In the New File Wizard, choose Material > Empty Material File, and click Next.</div> |
|
||||||
</li> |
|
||||||
<li><div> Give the file a name, for example <code>mat_wall</code> for a wall material.</div> |
|
||||||
</li> |
|
||||||
<li><div> A new file <code>mat_wall.j3m</code> is created in the Materials directory and opens in the Material Editor.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You can edit the source of the material, or use the user-friendly visual editor to set the properties of the material. Set the properties to the same values as you would otherwise specify with setters on a Material object in Java code: |
|
||||||
</p> |
|
||||||
<pre>Material mat_wall = new Material( |
|
||||||
assetManager, "Common/MatDefs/Light/Lighting.j3md"); |
assetManager, "Common/MatDefs/Light/Lighting.j3md"); |
||||||
mat_wall.setTexture("DiffuseMap", |
mat_wall.setTexture("DiffuseMap", |
||||||
assetManager.loadTexture("Textures/wall.png")); |
assetManager.loadTexture("Textures/wall.png")); |
||||||
mat_wall.setTexture("NormalMap", |
mat_wall.setTexture("NormalMap", |
||||||
assetManager.loadTexture("Textures/wall-normals.png")); |
assetManager.loadTexture("Textures/wall-normals.png")); |
||||||
mat_wall.setFloat("Shininess", 5f);</pre> |
mat_wall.setFloat("Shininess", 5f);</pre><p> The source code of the j3m file is always accessible and can be modified in the "source" tab of the editor.</p></div><h2><a |
||||||
<p> |
name="using_j3m_materials">Using .j3m Materials</a></h2><div |
||||||
The source code of the j3m file is always accessible and can be modified in the “source” tab of the editor. |
class="level2"><p> <a |
||||||
</p> |
href="/wiki/lib/exe/detail.php/sdk:applymaterial.jpg?id=sdk%3Amaterial_editing"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/sdk/applymaterial.jpg?w=180&h=300" class="mediaright" align="right" title="applymaterial.jpg" alt="applymaterial.jpg" width="180" height="300" /></a></p><p> When the material is ready and saved into your projects assets directory, you can assign the .j3m to a Geometry.</p><p> In the jMonkeyPlatform</p><ol><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Right-click the j3o file and select "Edit in SceneComposer"</div></li><li |
||||||
<h2><a>Using .j3m Materials</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> Open the SceneExplorer window</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> In the SceneExplorer, click the geometry to which you want to assign the material.</div></li><li |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/applymaterial.jpg"> |
class="level1"><div |
||||||
</p> |
class="li"> Open the Properties window</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Assign the .j3m material to the .j3o in the Properties>Geometry>Material section</div></li><li |
||||||
When the material is ready and saved into your projects assets directory, you can assign the .j3m to a Geometry. |
class="level1"><div |
||||||
</p> |
class="li"> Save the j3o and load it into you game.</div></li></ol><p> Or in your Java code</p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Use a loader and a setter to assign the material to a Geometry</div></li></ul><pre>mywall.setMaterial(assetManager.loadAsset( "Materials/mat_wall.j3m"));</pre><hr |
||||||
In the jMonkeyPlatform |
/><p> See also</p><ul><li |
||||||
</p> |
class="level1"><div |
||||||
<ol> |
class="li"> <a |
||||||
<li><div> Right-click the j3o file and select “Edit in SceneComposer”</div> |
href="/com/jme3/gde/core/docs/jme3/beginner/hello_material.html">Hello Material</a></div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Open the SceneExplorer window</div> |
class="li"> <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a></div></li><li |
||||||
<li><div> In the SceneExplorer, click the geometry to which you want to assign the material.</div> |
class="level1"><div |
||||||
</li> |
class="li"> <a |
||||||
<li><div> Open the Properties window</div> |
href="/com/jme3/gde/core/docs/sdk/neotexture.html">Neotexture</a> (Procedural textures)</div></li></ul></div> |
||||||
</li> |
|
||||||
<li><div> Assign the .j3m material to the .j3o in the Properties>Geometry>Material section</div> |
|
||||||
</li> |
|
||||||
<li><div> Save the j3o and load it into you game.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Or in your Java code |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Use a loader and a setter to assign the material to a Geometry</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
<pre>mywall.setMaterial(assetManager.loadAsset( "Materials/mat_wall.j3m"));</pre><hr /> |
|
||||||
|
|
||||||
<p> |
|
||||||
See also |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/beginner/hello_material.html">Hello Material</a></div> |
|
||||||
</li> |
|
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/advanced/materials_overview.html">Materials Overview</a></div> |
|
||||||
</li> |
|
||||||
<li><div> <a href="/com/jme3/gde/core/docs/sdk/neotexture.html">Neotexture</a> (Procedural textures)</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:material_editing?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:material_editing?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,169 +1,72 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jMonkeyPlatform: Importing and Viewing Models</a></h1> |
name="jmonkeyplatformimporting_and_viewing_models">jMonkeyPlatform: Importing and Viewing Models</a></h1><div |
||||||
<div> |
class="level1"><p> JMonkeyPlatform imports models from your project and stores them in the assets folder. The imported models are converted to a jME3 compatible binary format called .j3o. Double-click .j3o files in the jMonkeyPlatform to display them in the SceneViewer, or load them in-game using the AssetManager.</p><p> Presently, <a |
||||||
|
href="http://www.blender.org/">Blender 3D</a> is the preferred modelling tool for jME3 as it is also Open-Source Software and an exporter for OgreXML files exists. Note that the OgreXML exporter is not yet compatible with Blender 2.5alpha!</p><p> Also, see this <a |
||||||
<p> |
href="http://www.youtube.com/watch?v=nL7woH40i5c">demo video</a> on importing models.</p></div><h3><a |
||||||
|
name="installing_the_ogrexml_exporter_in_blender">Installing the OgreXML Exporter in Blender</a></h3><div |
||||||
JMonkeyPlatform imports models from your project and stores them in the assets folder. The imported models are converted to a jME3 compatible binary format called .j3o. Double-click .j3o files in the jMonkeyPlatform to display them in the SceneViewer, or load them in-game using the AssetManager. |
class="level3"><p> jMonkeyPlatform includes a tool to install the correct exporter tools in Blender to export OgreXML files. To install the exporter, do the following:</p><ol><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Select "Tools"→"OgreXML"→"Install Blender OgreXML" in the jMonkeyPlatform Menu</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
Presently, <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.blender.org/"><param name="text" value="<html><u>Blender 3D</u></html>"><param name="textColor" value="blue"></object> is the preferred modelling tool for jME3 as it is also Open-Source Software and an exporter for OgreXML files exists. Note that the OgreXML exporter is not yet compatible with Blender 2.5alpha! |
class="li"> If you are presented a filechooser, select the folder where your blender scripts reside</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Press "Install" in the window that opens</div></li></ol></div><h2><a |
||||||
<p> |
name="importing_and_viewing_a_model">Importing and Viewing a Model</a></h2><div |
||||||
Also, see this <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://www.youtube.com/watch?v=nL7woH40i5c"><param name="text" value="<html><u>demo video</u></html>"><param name="textColor" value="blue"></object> on importing models. |
class="level2"></div><h3><a |
||||||
</p> |
name="using_the_model_importer_tool">Using the Model Importer Tool</a></h3><div |
||||||
|
class="level3"><p> jMonkeyPlatform includes a model importer tool that allows you to preview and import supported models into your jMonkeyEngine3 project.</p><p> <a |
||||||
</div> |
href="/wiki/lib/exe/detail.php/wp-uploads:2010:11:jmonkeyplatform003-300x117.jpg?id=sdk%3Amodel_loader_and_viewer"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/wp-uploads/2010/11/jmonkeyplatform003-300x117.jpg" class="media" title="jmonkeyplatform003-300x117.jpg" alt="jmonkeyplatform003-300x117.jpg" /></a> <a |
||||||
<h3><a>Installing the OgreXML Exporter in Blender</a></h3> |
href="/wiki/lib/exe/detail.php/wp-uploads:2010:11:jmonkeyplatform002-300x218.jpg?id=sdk%3Amodel_loader_and_viewer"><img |
||||||
<div> |
src="nbdocs:/com/jme3/gde/core/docs/wp-uploads/2010/11/jmonkeyplatform002-300x218.jpg" class="mediaright" align="right" title="jmonkeyplatform002-300x218.jpg" alt="jmonkeyplatform002-300x218.jpg" /></a></p><ol><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Select the project you want to import your model to</div></li><li |
||||||
|
class="level1"><div |
||||||
jMonkeyPlatform includes a tool to install the correct exporter tools in Blender to export OgreXML files. To install the exporter, do the following: |
class="li"> Click the "Import Model" button in the toolbar</div></li><li |
||||||
|
class="level1"><div |
||||||
</p> |
class="li"> Click "open model.." and select the main model file</div></li><li |
||||||
<ol> |
class="level1"><div |
||||||
<li><div> Select “Tools”→“OgreXML”→“Install Blender OgreXML” in the jMonkeyPlatform Menu</div> |
class="li"> Check the preview and file list and press "Next"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> If you are presented a filechooser, select the folder where your blender scripts reside</div> |
class="li"> Check and change the import path if necessary</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Press “Install” in the window that opens</div> |
class="li"> If you want to copy the original model files as well, check the checkbox</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ol> |
class="li"> Press "finish"</div></li></ol><p> The model is converted to j3o and all necessary files are copied to the project assets folder. If you have specified the corresponding option, all original model files will also be copied to your assets folder.</p></div><h3><a |
||||||
|
name="using_the_model_files_directly">Using the model files directly</a></h3><div |
||||||
</div> |
class="level3"><p> <a |
||||||
|
href="/wiki/lib/exe/detail.php/sdk:jmonkeyplatform-docu-2.png?id=sdk%3Amodel_loader_and_viewer"><img |
||||||
<h2><a>Importing and Viewing a Model</a></h2> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-2.png?w=421&h=298" class="mediaright" align="right" alt="" width="421" height="298" /></a></p><ol><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> Create a separate folder for each model in the <code>assets</code> folder of your project.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Export the model from Blender as OgreXML into its subfolder in <strong>the <code>asset</code> folder of your project</strong>,</div></li><li |
||||||
<h3><a>Using the Model Importer Tool</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> Make sure that the OgreXML material file has the same name as the exported mesh or scene file!</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> In the Projects Explorer Assets node, select the model that you want to import.</div></li><li |
||||||
jMonkeyPlatform includes a model importer tool that allows you to preview and import supported models into your jMonkeyEngine3 project. |
class="level1"><div |
||||||
</p> |
class="li"> Double-click the model or right-click and select "Convert to JME binary" from the context-menu.</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> In the Projects Explorer Assets node you should see your model j3o file.</div></li><li |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/wp-uploads/2010/11/jmonkeyplatform003-300x117.jpg"> |
class="level1"><div |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/wp-uploads/2010/11/jmonkeyplatform002-300x218.jpg"> |
class="li"> Double-click it to view it in the SceneViewer.</div></li><li |
||||||
|
class="level1"><div |
||||||
</p> |
class="li"> Click on the lightbulb to turn on the light if you cannot see your model</div></li></ol><p> Note: It is important that you copy the model file and its textures to the correct assets folder before creating the j3o file because the paths for textures (and possibly other things) will be stored as absolute (to the assets folder root) when you convert that model. This means the texture location should not change after the import.</p></div><h2><a |
||||||
<ol> |
name="working_with_a_model">Working With a Model</a></h2><div |
||||||
<li><div> Select the project you want to import your model to</div> |
class="level2"><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Click the “Import Model” button in the toolbar</div> |
class="li"> Open Windows>SceneExplorer to view sub-nodes of the model</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Click “open model..” and select the main model file</div> |
class="li"> Open Windows>Properties to view the properties of the model's nodes.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Check the preview and file list and press “Next”</div> |
class="li"> Click the cube button in the SceneViewer to toggle between Wireframe mode and Textured mode.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Check and change the import path if necessary</div> |
class="li"> Click the lightbulb to view Materials that require a light source</div></li></ul></div><h2><a |
||||||
</li> |
name="notes_about_model_assets">Notes About Model Assets</a></h2><div |
||||||
<li><div> If you want to copy the original model files as well, check the checkbox</div> |
class="level2"><p> The original OgreXML <code>.mesh.xml</code>, <code>.scene</code>, <code>.material</code> and <code>.skeleton.xml</code> model files <strong>will not be included</strong> in the distribution <code>assets.jar</code> file of your distributed game, they are only available in the assets folder so you are able to recreate the <code>.j3o</code> file from the original if you ever come to change it in blender and have to export it again.</p></div><h2><a |
||||||
</li> |
name="about_the_sceneviewer_and_sceneexplorer_window">About the SceneViewer and SceneExplorer window</a></h2><div |
||||||
<li><div> Press “finish”</div> |
class="level2"><p> The SceneViewer and SceneExplorer windows are shared among plugins to save system resources. This means that you will have to keep an eye on what plugin is using the scene right now and what you are actually modifying in these windows.</p><p> Most plugins will deliver their own UI elements to modify the scene so the SceneExplorer is more of a global tool. The simple SceneComposer however heavily relies on its functions as other plugins might too in the future.</p></div><h3><a |
||||||
</li> |
name="about_the_projects_assetmanager">About the projects AssetManager</a></h3><div |
||||||
</ol> |
class="level3"><p> Each jMP project has its own internal AssetManager that has the projects assets folder registered as a FileLocator. When the project is run, the assets folder is compressed into a jar file and added to the projects main jar classpath. This way the editors in jMP and the running game have the same asset folder structure.</p><p> You might wonder why jMP requires you to copy the model that is to be converted to j3o into the assets folder before. The Model Import Tool also copies the model and associated files to the project directory before converting. To load the model it needs to be in a folder (or jar etc..) that belongs to the projects AssetManager root. To load a model from some other folder of the filesystem, that folder would have to be added to the AssetManager root. If every folder that contains a model was in the root of the AssetManager, all textures named "hull.jpg" for example would be the same for the AssetManager and it would only deliver the texture of the first model folder that was added.</p><p> To have a valid jME3 object, the paths to textures and other assets belonging to the model have to be read with the correct, final path that can then be stored in the j3o object. The j3o object will use those paths when it is loaded with the AssetManager and it requires the AssetManager to deliver the assets on those paths, this is why the folder structure while converting has to be the same as when loading.</p></div> |
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The model is converted to j3o and all necessary files are copied to the project assets folder. If you have specified the corresponding option, all original model files will also be copied to your assets folder. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Using the model files directly</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-2.png"> |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Create a separate folder for each model in the <code>assets</code> folder of your project.</div> |
|
||||||
</li> |
|
||||||
<li><div> Export the model from Blender as OgreXML into its subfolder in <strong>the <code>asset</code> folder of your project</strong>, </div> |
|
||||||
</li> |
|
||||||
<li><div> Make sure that the OgreXML material file has the same name as the exported mesh or scene file!</div> |
|
||||||
</li> |
|
||||||
<li><div> In the Projects Explorer Assets node, select the model that you want to import.</div> |
|
||||||
</li> |
|
||||||
<li><div> Double-click the model or right-click and select “Convert to JME binary” from the context-menu.</div> |
|
||||||
</li> |
|
||||||
<li><div> In the Projects Explorer Assets node you should see your model j3o file.</div> |
|
||||||
</li> |
|
||||||
<li><div> Double-click it to view it in the SceneViewer.</div> |
|
||||||
</li> |
|
||||||
<li><div> Click on the lightbulb to turn on the light if you cannot see your model</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Note: It is important that you copy the model file and its textures to the correct assets folder before creating the j3o file because the paths for textures (and possibly other things) will be stored as absolute (to the assets folder root) when you convert that model. This means the texture location should not change after the import. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Working With a Model</a></h2> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> Open Windows>SceneExplorer to view sub-nodes of the model</div> |
|
||||||
</li> |
|
||||||
<li><div> Open Windows>Properties to view the properties of the model's nodes.</div> |
|
||||||
</li> |
|
||||||
<li><div> Click the cube button in the SceneViewer to toggle between Wireframe mode and Textured mode.</div> |
|
||||||
</li> |
|
||||||
<li><div> Click the lightbulb to view Materials that require a light source</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Notes About Model Assets</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The original OgreXML <code>.mesh.xml</code>, <code>.scene</code>, <code>.material</code> and <code>.skeleton.xml</code> model files <strong>will not be included</strong> in the distribution <code>assets.jar</code> file of your distributed game, they are only available in the assets folder so you are able to recreate the <code>.j3o</code> file from the original if you ever come to change it in blender and have to export it again. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>About the SceneViewer and SceneExplorer window</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
The SceneViewer and SceneExplorer windows are shared among plugins to save system resources. This means that you will have to keep an eye on what plugin is using the scene right now and what you are actually modifying in these windows. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Most plugins will deliver their own UI elements to modify the scene so the SceneExplorer is more of a global tool. The simple SceneComposer however heavily relies on its functions as other plugins might too in the future. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>About the projects AssetManager</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
Each jMP project has its own internal AssetManager that has the projects assets folder registered as a FileLocator. When the project is run, the assets folder is compressed into a jar file and added to the projects main jar classpath. This way the editors in jMP and the running game have the same asset folder structure. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
You might wonder why jMP requires you to copy the model that is to be converted to j3o into the assets folder before. The Model Import Tool also copies the model and associated files to the project directory before converting. To load the model it needs to be in a folder (or jar etc..) that belongs to the projects AssetManager root. To load a model from some other folder of the filesystem, that folder would have to be added to the AssetManager root. If every folder that contains a model was in the root of the AssetManager, all textures named “hull.jpg” for example would be the same for the AssetManager and it would only deliver the texture of the first model folder that was added. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
To have a valid jME3 object, the paths to textures and other assets belonging to the model have to be read with the correct, final path that can then be stored in the j3o object. The j3o object will use those paths when it is loaded with the AssetManager and it requires the AssetManager to deliver the assets on those paths, this is why the folder structure while converting has to be the same as when loading. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:model_loader_and_viewer?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:model_loader_and_viewer?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,259 +1,151 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jMonkeyPlatform: Creating Projects</a></h1> |
name="jmonkeyplatformcreating_projects">jMonkeyPlatform: Creating Projects</a></h1><div |
||||||
<div> |
class="level1"><p> The jMonkeyPlatform makes it easy to get started with developing 3-D games based on the jMonkeyEngine.</p></div><h2><a |
||||||
|
name="creating_a_new_jmonkeyengine_project">Creating a New jMonkeyEngine Project</a></h2><div |
||||||
<p> |
class="level2"><ol><li |
||||||
|
class="level1"><div |
||||||
The jMonkeyPlatform makes it easy to get started with developing 3-D games based on the jMonkeyEngine. |
class="li"> Choose File > New Project from the main menu.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> In the New Project Wizard, select the template JME3 > Basic Game</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Click next to specify a project name, and the path where to store your new project.</div></li><li |
||||||
<h2><a>Creating a New jMonkeyEngine Project</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> Click Finish. A skeleton application is created and opens in the Project Explorer.</div><ul><li |
||||||
<ol> |
class="level2"><div |
||||||
<li><div> Choose File > New Project from the main menu.</div> |
class="li"> This basic jme3 application is based on the SimpleApplication class to allow an easy start with jme3.</div></li><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> In the New Project Wizard, select the template JME3 > Basic Game</div> |
class="li"> You can click the run button to run it: You will see a jMonkey cube.</div></li></ul></li></ol></div><h4><a |
||||||
</li> |
name="project_structure">Project Structure</a></h4><div |
||||||
<li><div> Click next to specify a project name, and the path where to store your new project.</div> |
class="level4"><p> <a |
||||||
</li> |
href="/wiki/lib/exe/detail.php/sdk:jmonkeyplatform-docu-4.png?id=sdk%3Aproject_creation"><img |
||||||
<li><div> Click Finish. A skeleton application is created and opens in the Project Explorer.</div> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-4.png?w=421&h=298" class="mediaright" align="right" alt="" width="421" height="298" /></a></p><p> Let's have a look at the abstract project structure in the Project Explorer (ctrl-1).</p><ul><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> This basic jme3 application is based on the SimpleApplication class to allow an easy start with jme3.</div> |
class="li"> <strong>Project Assets node:</strong> These directories have been created for you to store your games assets, such as fonts, materials, models, shaders, sounds, and textures. For a newly created project, these directories are empty.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> You can click the run button to run it: You will see a jMonkey cube.</div> |
class="li"> <strong>Source Packages node:</strong> This is where you manage your packages and classes. For a newly created project, it contains one package and one class, <code>Main.java</code>. Double click <code>Main.java</code> to open it in the editor.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> <strong>Libraries node:</strong> An overview of all libraies on your game's classpath. The classpath is already set-up for the jme3 framework (including LWJGL, JOGG, JOAL, JOGL, etc).</div></li></ul></div><h4><a |
||||||
</li> |
name="directory_structure">Directory Structure</a></h4><div |
||||||
</ol> |
class="level4"><p> Now let's have a look at the project's file structure in the File Explorer (ctrl-2). This explorer shows the physical directory structure on your hard drive.</p><ul><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> <strong>assets</strong> – This directory corresponds to the Project Assets node. It is needed for the assetManager. This is the recommended internal structure:</div><ul><li |
||||||
|
class="level2"><div |
||||||
<h4><a>Project Structure</a></h4> |
class="li"> <code>assets/Interface</code></div></li><li |
||||||
<div> |
class="level2"><div |
||||||
|
class="li"> <code>assets/MatDefs</code></div></li><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> <code>assets/Materials</code></div></li><li |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-4.png"> |
class="level2"><div |
||||||
</p> |
class="li"> <code>assets/Models</code></div></li><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> <code>assets/Scenes</code></div></li><li |
||||||
Let's have a look at the abstract project structure in the Project Explorer (ctrl-1). |
class="level2"><div |
||||||
|
class="li"> <code>assets/Shaders</code></div></li><li |
||||||
</p> |
class="level2"><div |
||||||
<ul> |
class="li"> <code>assets/Sounds</code></div></li><li |
||||||
<li><div> <strong>Project Assets node:</strong> These directories have been created for you to store your games assets, such as fonts, materials, models, shaders, sounds, and textures. For a newly created project, these directories are empty.</div> |
class="level2"><div |
||||||
</li> |
class="li"> <code>assets/Textures</code></div></li></ul></li><li |
||||||
<li><div> <strong>Source Packages node:</strong> This is where you manage your packages and classes. For a newly created project, it contains one package and one class, <code>Main.java</code>. Double click <code>Main.java</code> to open it in the editor.</div> |
class="level1"><div |
||||||
</li> |
class="li"> <strong>src</strong> – This directory corresponds to the Source Packages node. Your sources code goes here.</div></li><li |
||||||
<li><div> <strong>Libraries node:</strong> An overview of all libraies on your game's classpath. The classpath is already set-up for the jme3 framework (including LWJGL, JOGG, JOAL, JOGL, etc).</div> |
class="level1"><div |
||||||
</li> |
class="li"> <strong>nbproject</strong> – This is meta data used by the jMonkeyPlatform (don't edit).</div></li><li |
||||||
</ul> |
class="level1"><div |
||||||
|
class="li"> <strong>build.xml</strong> – This is an Ant build script that is hooked up to the clean/build/run/test actions in the jMonkeyPlatform. It loads a default build script, and allows you to further customize the build process. The Ant script also assures that you are able to clean/build/run/test your application outside of the jMonkeyPlatform – e.g. from the command line.</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> <strong>build</strong> – This directory contains the compiled classes. (Will be generated by the jMonkeyPlatform when you build the project.)</div></li><li |
||||||
<h4><a>Directory Structure</a></h4> |
class="level1"><div |
||||||
<div> |
class="li"> <strong>dist</strong> – This directory contains the executable JAR files. (Will be generated by the jMonkeyPlatform when you build the project.)</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> <strong>test</strong> – The jMonkeyPlatform will store JUnit tests here if you create any. (Optional.)</div></li></ul></div><h2><a |
||||||
|
name="working_with_your_game_project">Working With Your Game Project</a></h2><div |
||||||
Now let's have a look at the project's file structure in the File Explorer (ctrl-2). This explorer shows the physical directory structure on your hard drive. |
class="level2"></div><h3><a |
||||||
|
name="project_configuration">Project Configuration</a></h3><div |
||||||
</p> |
class="level3"><p> Right-Click the project to open the Project properties.</p><ul><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> <strong>assets</strong> – This directory corresponds to the Project Assets node. It is needed for the assetManager. This is the recommended internal structure:</div> |
class="li"> In the Run section, specify the main class of your project.</div></li><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> <code>assets/Interface</code></div> |
class="li"> In the Run section, you can optionally configure JVM options and command line parameters.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <code>assets/MatDefs</code></div> |
class="li"> In the Application section, specify the game title (by default the game will be named <code>BasicGame</code>).</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <code>assets/Materials</code></div> |
class="li"> In the Application section, specify the vendor name (your name), a short description, your project's homepage, and a splash screen.</div></li></ul></div><h3><a |
||||||
</li> |
name="adding_external_jar_libraries">Adding external jar libraries</a></h3><div |
||||||
<li><div> <code>assets/Models</code></div> |
class="level3"><p> Add the library to the global library list:</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <code>assets/Scenes</code></div> |
class="li"> Select Tools→Libraries in the main menu.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <code>assets/Shaders</code></div> |
class="li"> Click "New Library", enter a name for the library and press OK</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <code>assets/Sounds</code></div> |
class="li"> In the "Classpath" tab, press "Add JAR/Folder" and select the jar file(s) needed for the library</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <code>assets/Textures</code></div> |
class="li"> In the "JavaDoc" tab, press "Add ZIP/Folder" and select the javadoc for the library (zipped or folder)</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> In the "Sources" tab you can select a folder or jar file containing the source files of the library if available</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <strong>src</strong> – This directory corresponds to the Source Packages node. Your sources code goes here.</div> |
class="li"> Press OK</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <strong>nbproject</strong> – This is meta data used by the jMonkeyPlatform (don't edit).</div> |
class="li"> Right-Click your project</div></li></ul><p> Add the library to a project:</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <strong>build.xml</strong> – This is an Ant build script that is hooked up to the clean/build/run/test actions in the jMonkeyPlatform. It loads a default build script, and allows you to further customize the build process. The Ant script also assures that you are able to clean/build/run/test your application outside of the jMonkeyPlatform – e.g. from the command line.</div> |
class="li"> Right-Click your project and select "Properties"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <strong>build</strong> – This directory contains the compiled classes. (Will be generated by the jMonkeyPlatform when you build the project.)</div> |
class="li"> Select "Libaries" on the left and then press "Add Library"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> <strong>dist</strong> – This directory contains the executable JAR files. (Will be generated by the jMonkeyPlatform when you build the project.)</div> |
class="li"> Select the library from the list and press OK</div></li></ul><p> Thats it, your project can now use the external library.</p></div><h3><a |
||||||
</li> |
name="development_process">Development Process</a></h3><div |
||||||
<li><div> <strong>test</strong> – The jMonkeyPlatform will store JUnit tests here if you create any. (Optional.)</div> |
class="level3"><ul><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> <strong>Creating new files and packages:</strong> Select the Source Packages node (or any of its subnodes), and press ctrl-N (File>New File): Use the New File wizard to create new Java classes, Java packages, Java beans, Swing forms, Junit files, JME3 Materials and Models, and many more.</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> <strong>Editing files:</strong> Open the Projects Explorer and double-click a Java file from the Source Packages to open it in the Editor. The <a |
||||||
|
href="/com/jme3/gde/core/docs/sdk/code_editor.html">jMonkeyPlatform Editor</a> assists you in many ways, including Syntactic and semantic code coloring, code completion, and javadoc. <a |
||||||
<h2><a>Working With Your Game Project</a></h2> |
href="/com/jme3/gde/core/docs/sdk/code_editor.html">(More...)</a></div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> <strong>Adding Assets:</strong></div><ul><li |
||||||
</div> |
class="level2"><div |
||||||
|
class="li"> You can <a |
||||||
<h3><a>Project Configuration</a></h3> |
href="/com/jme3/gde/core/docs/sdk/model_loader_and_viewer.html">import models, scenes, and materials</a> as assets into your project.</div></li><li |
||||||
<div> |
class="level2"><div |
||||||
|
class="li"> To add sound files and images, use your operating system's file explorer and copy the files into your project's asset directory.</div></li></ul></li><li |
||||||
<p> |
class="level1"><div |
||||||
|
class="li"> <strong>ToDo List:</strong> The tasks window automatically lists all lines containing errors and warnings, and all lines that you have marked with comment keywords such as <code |
||||||
Right-Click the project to open the Project properties. |
class="code html4strict">FIXME</code>, @todo, TODO.</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> <strong>Integrated tools:</strong> <a |
||||||
<li><div> In the Run section, specify the main class of your project. </div> |
href="/com/jme3/gde/core/docs/sdk/debugging_profiling_testing.html">Debugging, Testing, Profiling</a>.</div></li></ul></div><h3><a |
||||||
</li> |
name="clean_build_and_run_cycle">Clean, Build and Run Cycle</a></h3><div |
||||||
<li><div> In the Run section, you can optionally configure JVM options and command line parameters.</div> |
class="level3"><p> <a |
||||||
</li> |
href="/wiki/lib/exe/detail.php/sdk:jmonkeyplatform-docu-5.png?id=sdk%3Aproject_creation"><img |
||||||
<li><div> In the Application section, specify the game title (by default the game will be named <code>BasicGame</code>).</div> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-5.png?w=421&h=298" class="mediaright" align="right" alt="" width="421" height="298" /></a></p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> In the Application section, specify the vendor name (your name), a short description, your project's homepage, and a splash screen.</div> |
class="li"> Right-Click the project and use the context-menu to clean all generated classes and JARs.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> Right-Click individual files with a main method to build and run them. (Shift-F6)</div></li><li |
||||||
|
class="level1"><div |
||||||
</div> |
class="li"> Press the Run button (green arrow in the toolbar) to build and run the project. (F6)</div></li></ul><p> <strong>More than one project open?</strong> The toolbar buttons and the F-keys are bound to the main project, which is shown in bold in the Project Explorer. Right-click a project and select Set As Main Project to make it respond to the toolbar buttons and F-keys.</p><p> <strong>Worried About Proprietary Lock-in?</strong> You are never locked into the jMonkeyPlatform: At any time, you can change into your project directory on the command line, and clean, build, and run your project, using non-proprietary Apache Ant commands:</p><pre>ant clean; ant jar; ant run;</pre></div><h3><a |
||||||
|
name="application_deployment">Application Deployment</a></h3><div |
||||||
<h3><a>Adding external jar libraries</a></h3> |
class="level3"><ul><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> You can <a |
||||||
<p> |
href="/com/jme3/gde/core/docs/sdk/application_deployment.html">deploy</a> your game as desktop application (JAR), browser applet, WebStart (JNLP), or on the Android platform. <a |
||||||
|
href="/com/jme3/gde/core/docs/sdk/application_deployment.html">(More...)</a></div></li></ul></div><h2><a |
||||||
Add the library to the global library list: |
name="running_sample_projects">Running Sample Projects</a></h2><div |
||||||
</p> |
class="level2"><ol><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Select Tools→Libraries in the main menu.</div> |
class="li"> Choose File > New Project from the main menu.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Click “New Library”, enter a name for the library and press OK</div> |
class="li"> In the New Project Wizard, select JME3 > JME3 Tests</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> In the “Classpath” tab, press “Add JAR/Folder” and select the jar file(s) needed for the library</div> |
class="li"> Click next to pick a path where to store the <code>JME3Tests</code> project.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> In the “JavaDoc” tab, press “Add ZIP/Folder” and select the javadoc for the library (zipped or folder)</div> |
class="li"> Click Finish. The sample project opens.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> In the “Sources” tab you can select a folder or jar file containing the source files of the library if available</div> |
class="li"> Right-click the <code>JME3Tests</code> project and choose Run.</div><ul><li |
||||||
</li> |
class="level2"><div |
||||||
<li><div> Press OK</div> |
class="li"> Use the TestChooser to try out the included jMonkeyEngine demos!</div></li></ul></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Right-Click your project</div> |
class="li"> Open the Source Packages node of the sample's project.</div><ul><li |
||||||
</li> |
class="level2"><div |
||||||
</ul> |
class="li"> Browse a demo's source code to learn how a feature is implemented.</div></li><li |
||||||
|
class="level2"><div |
||||||
<p> |
class="li"> Feel free to modify the code samples and experiment! If you break something, you can always recreate the packaged samples from the <code>JME3 Tests</code> template.</div></li></ul></li></ol></div> |
||||||
|
|
||||||
Add the library to a project: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Right-Click your project and select “Properties”</div> |
|
||||||
</li> |
|
||||||
<li><div> Select “Libaries” on the left and then press “Add Library”</div> |
|
||||||
</li> |
|
||||||
<li><div> Select the library from the list and press OK</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Thats it, your project can now use the external library. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Development Process</a></h3> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> <strong>Creating new files and packages:</strong> Select the Source Packages node (or any of its subnodes), and press ctrl-N (File>New File): Use the New File wizard to create new Java classes, Java packages, Java beans, Swing forms, Junit files, JME3 Materials and Models, and many more.</div> |
|
||||||
</li> |
|
||||||
<li><div> <strong>Editing files:</strong> Open the Projects Explorer and double-click a Java file from the Source Packages to open it in the Editor. The <a href="/com/jme3/gde/core/docs/sdk/code_editor.html">jMonkeyPlatform Editor</a> assists you in many ways, including Syntactic and semantic code coloring, code completion, and javadoc. <a href="/com/jme3/gde/core/docs/sdk/code_editor.html">(More...)</a></div> |
|
||||||
</li> |
|
||||||
<li><div> <strong>Adding Assets:</strong></div> |
|
||||||
<ul> |
|
||||||
<li><div> You can <a href="/com/jme3/gde/core/docs/sdk/model_loader_and_viewer.html">import models, scenes, and materials</a> as assets into your project.</div> |
|
||||||
</li> |
|
||||||
<li><div> To add sound files and images, use your operating system's file explorer and copy the files into your project's asset directory.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> <strong>ToDo List:</strong> The tasks window automatically lists all lines containing errors and warnings, and all lines that you have marked with comment keywords such as <code>FIXME</code>, @todo, TODO.</div> |
|
||||||
</li> |
|
||||||
<li><div> <strong>Integrated tools:</strong> <a href="/com/jme3/gde/core/docs/sdk/debugging_profiling_testing.html">Debugging, Testing, Profiling</a>.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Clean, Build and Run Cycle</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-5.png"> |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Right-Click the project and use the context-menu to clean all generated classes and JARs.</div> |
|
||||||
</li> |
|
||||||
<li><div> Right-Click individual files with a main method to build and run them. (Shift-F6)</div> |
|
||||||
</li> |
|
||||||
<li><div> Press the Run button (green arrow in the toolbar) to build and run the project. (F6)</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<strong>More than one project open?</strong> The toolbar buttons and the F-keys are bound to the main project, which is shown in bold in the Project Explorer. Right-click a project and select Set As Main Project to make it respond to the toolbar buttons and F-keys. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
<strong>Worried About Proprietary Lock-in?</strong> You are never locked into the jMonkeyPlatform: At any time, you can change into your project directory on the command line, and clean, build, and run your project, using non-proprietary Apache Ant commands: |
|
||||||
</p> |
|
||||||
<pre>ant clean; ant jar; ant run;</pre> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Application Deployment</a></h3> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> You can <a href="/com/jme3/gde/core/docs/sdk/application_deployment.html">deploy</a> your game as desktop application (JAR), browser applet, WebStart (JNLP), or on the Android platform. <a href="/com/jme3/gde/core/docs/sdk/application_deployment.html">(More...)</a> </div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Running Sample Projects</a></h2> |
|
||||||
<div> |
|
||||||
<ol> |
|
||||||
<li><div> Choose File > New Project from the main menu.</div> |
|
||||||
</li> |
|
||||||
<li><div> In the New Project Wizard, select JME3 > JME3 Tests</div> |
|
||||||
</li> |
|
||||||
<li><div> Click next to pick a path where to store the <code>JME3Tests</code> project.</div> |
|
||||||
</li> |
|
||||||
<li><div> Click Finish. The sample project opens. </div> |
|
||||||
</li> |
|
||||||
<li><div> Right-click the <code>JME3Tests</code> project and choose Run.</div> |
|
||||||
<ul> |
|
||||||
<li><div> Use the TestChooser to try out the included jMonkeyEngine demos!</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> Open the Source Packages node of the sample's project.</div> |
|
||||||
<ul> |
|
||||||
<li><div> Browse a demo's source code to learn how a feature is implemented.</div> |
|
||||||
</li> |
|
||||||
<li><div> Feel free to modify the code samples and experiment! If you break something, you can always recreate the packaged samples from the <code>JME3 Tests</code> template.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:project_creation?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:project_creation?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,198 +1,74 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Scene Composer</a></h1> |
name="scene_composer">Scene Composer</a></h1><div |
||||||
<div> |
class="level1"><p> SceneComposer allows you to edit scenes stored in j3o files and add content or modify existing content. Please note that the Scene Composer and Explorer are a work in progress and will provide more powerful functions in the future. Also other plugins will allow creation of more specific game type scenes in jMP.</p><p> Most buttons in the SceneComposer have tooltips that appear when you hover the mouse over the button for a short while.</p></div><h3><a |
||||||
|
name="mouse_cursor_controls">Mouse/Cursor Controls</a></h3><div |
||||||
<p> |
class="level3"><ul><li |
||||||
|
class="level1"><div |
||||||
SceneComposer allows you to edit scenes stored in j3o files and add content or modify existing content. Please note that the Scene Composer and Explorer are a work in progress and will provide more powerful functions in the future. Also other plugins will allow creation of more specific game type scenes in jMP. |
class="li"> Left-click and drag to rotate the camera around the cam center</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Right-click and drag to move the cam center</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
Most buttons in the SceneComposer have tooltips that appear when you hover the mouse over the button for a short while. |
class="li"> Scoll the mouse wheel to zoom in/out the cam center</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Left-click a geometry to select it</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Right-click a geometry to place the cursor</div></li></ul><p> In the SceneComposer toolbar are buttons to snap the camera to the cursor, snap the cursor to the selection and etc.</p></div><h3><a |
||||||
<h3><a>Mouse/Cursor Controls</a></h3> |
name="creating_a_scene_file">Creating a scene file</a></h3><div |
||||||
<div> |
class="level3"><p> jMP stores the scene in a j3o file, this binary file contains the whole scenegraph including all settings for spatials, materials, physics, effects etc. Textures are not stored in the j3o file but as absolute locators to the textures.</p><p> To create a blank scene file do the following:</p><ol><li |
||||||
<ul> |
class="level1"><div |
||||||
<li><div> Left-click and drag to rotate the camera around the cam center</div> |
class="li"> Right click the "Scenes" folder in your Project Assets and select "New→Other"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Right-click and drag to move the cam center</div> |
class="li"> Select "Scene" to the left then select "Empty jME3 Scene" and press "Next"</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Scoll the mouse wheel to zoom in/out the cam center</div> |
class="li"> Enter a file name for your scene like "MyScene" and press "OK"</div></li></ol></div><h3><a |
||||||
</li> |
name="loading_the_scene">Loading the scene</a></h3><div |
||||||
<li><div> Left-click a geometry to select it</div> |
class="level3"><p> <a |
||||||
</li> |
href="/wiki/lib/exe/detail.php/sdk:jmonkeyplatform-docu-2.png?id=sdk%3Ascene_composer"><img |
||||||
<li><div> Right-click a geometry to place the cursor</div> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-2.png?w=421&h=298" class="mediaright" align="right" alt="" width="421" height="298" /></a></p><p> To open a scene</p><ol><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> In the Project Explorer, right-click the *.j3o file of the scene</div></li><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Choose "Open in SceneComposer"</div></li></ol><p> Now the SceneComposer window opens at the bottom and displays the scene in the SceneViewer. The SceneExplorer displays the contained scene graph as a tree and when selecting a node, you can edit the properties of the corresponding scene graph object in the Properties window.</p><p> For now, you only see the cursor in the SceneViewer and a single node (the root node of the scene) in the SceneExplorer.</p></div><h3><a |
||||||
|
name="adding_light_to_the_scene">Adding light to the scene</a></h3><div |
||||||
In the SceneComposer toolbar are buttons to snap the camera to the cursor, snap the cursor to the selection and etc. |
class="level3"><ol><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Select the root node in the SceneExplorer</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Select "Directional Light" in the SceneComposer window</div></li><li |
||||||
<h3><a>Creating a scene file</a></h3> |
class="level1"><div |
||||||
<div> |
class="li"> Press the "+" button in the SceneComposer window</div></li></ol><p> A directional light has been added to your scene, you can see it in the SceneExplorer.</p></div><h3><a |
||||||
|
name="adding_effects_etc_to_the_scene">Adding effects etc. to the scene</a></h3><div |
||||||
<p> |
class="level3"><p> You can add a variety of special objects with the SceneComposer, including lights, effects, audio etc.</p><ol><li |
||||||
|
class="level1"><div |
||||||
jMP stores the scene in a j3o file, this binary file contains the whole scenegraph including all settings for spatials, materials, physics, effects etc. Textures are not stored in the j3o file but as absolute locators to the textures. |
class="li"> Select root Node in the SceneExplorer</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Select the object type in the list displayed in the SceneComposer window</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
To create a blank scene file do the following: |
class="li"> Press the "+ cursor" button in the SceneComposer window</div></li></ol></div><h3><a |
||||||
</p> |
name="adding_models_to_the_scene">Adding Models to the scene</a></h3><div |
||||||
<ol> |
class="level3"><p> <a |
||||||
<li><div> Right click the “Scenes” folder in your Project Assets and select “New→Other”</div> |
href="/wiki/lib/exe/detail.php/sdk:jmonkeyplatform-docu-3.png?id=sdk%3Ascene_composer"><img |
||||||
</li> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-3.png?w=421&h=298" class="mediaright" align="right" alt="" width="421" height="298" /></a></p><p> You can directly import 3d models to your scene so that they will be part of your scene file. To be able to import for example an OgreXML file, first export it from your 3D editor to a separate folder in the assets folder of your project (e.g. assets/Models/MyModel/).</p><ol><li |
||||||
<li><div> Select “Scene” to the left then select “Empty jME3 Scene” and press “Next”</div> |
class="level1"><div |
||||||
</li> |
class="li"> Place the SceneComposer cursor where you want the model to be</div></li><li |
||||||
<li><div> Enter a file name for your scene like “MyScene” and press “OK”</div> |
class="level1"><div |
||||||
</li> |
class="li"> Select the parent Node for the model in the SceneExplorer</div></li><li |
||||||
</ol> |
class="level1"><div |
||||||
|
class="li"> In the Project Explorer right-click the model file you want to import</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Choose "Add to SceneComposer"</div></li></ol><p> Note that when importing a model the texture paths are stored absolute, so the folder you import the model from will later only be a textures folder because the original model file is not included in the release.</p><p> Also note that when adding models this way, changes in the original model file will not be reflected in the scene file as its a complete copy of the original file. If you change the original model, delete the models node from the scene and import it again.</p></div><h3><a |
||||||
<h3><a>Loading the scene</a></h3> |
name="linking_models_to_the_scene">Linking Models to the scene</a></h3><div |
||||||
<div> |
class="level3"><p> You can also link models/objects into your scene, this way they are reloaded dynamically from the other/original file.</p><ol><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Place the SceneComposer cursor where you want the model to be</div></li><li |
||||||
|
class="level1"><div |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-2.png"> |
class="li"> Select the parent Node for the model in the SceneExplorer</div></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> In the Project Explorer right-click the model file you want to link</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
To open a scene |
class="li"> Choose "Link in SceneComposer"</div></li></ol><p> Note that when linking objects this way, you cannot edit them as part of the scene. To change the model you have to change the original j3o file.</p><p> Also note that although it its possible to directly link external model files (OgreXML, OBJ etc.), this is not recommended. Convert the original file to a j3o file by right-clicking it and selecting "Convert to jME Binary" before linking it. This is required because the original model files are not included in the release version of the application.</p></div><h3><a |
||||||
</p> |
name="saving_the_scene">Saving the Scene</a></h3><div |
||||||
<ol> |
class="level3"><ol><li |
||||||
<li><div> In the Project Explorer, right-click the *.j3o file of the scene</div> |
class="level1"><div |
||||||
</li> |
class="li"> When a scene has been changed, press the "save" button in the main toolbar or press [Ctrl-S] / [Apple-S] to save it.</div></li></ol></div> |
||||||
<li><div> Choose “Open in SceneComposer”</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Now the SceneComposer window opens at the bottom and displays the scene in the SceneViewer. The SceneExplorer displays the contained scene graph as a tree and when selecting a node, you can edit the properties of the corresponding scene graph object in the Properties window. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
For now, you only see the cursor in the SceneViewer and a single node (the root node of the scene) in the SceneExplorer. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Adding light to the scene</a></h3> |
|
||||||
<div> |
|
||||||
<ol> |
|
||||||
<li><div> Select the root node in the SceneExplorer</div> |
|
||||||
</li> |
|
||||||
<li><div> Select “Directional Light” in the SceneComposer window</div> |
|
||||||
</li> |
|
||||||
<li><div> Press the ”+” button in the SceneComposer window</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
A directional light has been added to your scene, you can see it in the SceneExplorer. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Adding effects etc. to the scene</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You can add a variety of special objects with the SceneComposer, including lights, effects, audio etc. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Select root Node in the SceneExplorer</div> |
|
||||||
</li> |
|
||||||
<li><div> Select the object type in the list displayed in the SceneComposer window</div> |
|
||||||
</li> |
|
||||||
<li><div> Press the ”+ cursor” button in the SceneComposer window</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Adding Models to the scene</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-docu-3.png"> |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
You can directly import 3d models to your scene so that they will be part of your scene file. To be able to import for example an OgreXML file, first export it from your 3D editor to a separate folder in the assets folder of your project (e.g. assets/Models/MyModel/). |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Place the SceneComposer cursor where you want the model to be</div> |
|
||||||
</li> |
|
||||||
<li><div> Select the parent Node for the model in the SceneExplorer</div> |
|
||||||
</li> |
|
||||||
<li><div> In the Project Explorer right-click the model file you want to import</div> |
|
||||||
</li> |
|
||||||
<li><div> Choose “Add to SceneComposer”</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Note that when importing a model the texture paths are stored absolute, so the folder you import the model from will later only be a textures folder because the original model file is not included in the release. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Also note that when adding models this way, changes in the original model file will not be reflected in the scene file as its a complete copy of the original file. If you change the original model, delete the models node from the scene and import it again. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Linking Models to the scene</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
You can also link models/objects into your scene, this way they are reloaded dynamically from the other/original file. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Place the SceneComposer cursor where you want the model to be</div> |
|
||||||
</li> |
|
||||||
<li><div> Select the parent Node for the model in the SceneExplorer</div> |
|
||||||
</li> |
|
||||||
<li><div> In the Project Explorer right-click the model file you want to link</div> |
|
||||||
</li> |
|
||||||
<li><div> Choose “Link in SceneComposer”</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Note that when linking objects this way, you cannot edit them as part of the scene. To change the model you have to change the original j3o file. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
Also note that although it its possible to directly link external model files (OgreXML, OBJ etc.), this is not recommended. Convert the original file to a j3o file by right-clicking it and selecting “Convert to jME Binary” before linking it. This is required because the original model files are not included in the release version of the application. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Saving the Scene</a></h3> |
|
||||||
<div> |
|
||||||
<ol> |
|
||||||
<li><div> When a scene has been changed, press the “save” button in the main toolbar or press [Ctrl-S] / [Apple-S] to save it.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:scene_composer?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:scene_composer?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,65 +1,26 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jMonkeyPlatform: Scene Explorer</a></h1> |
name="jmonkeyplatformscene_explorer">jMonkeyPlatform: Scene Explorer</a></h1><div |
||||||
<div> |
class="level1"></div><h2><a |
||||||
|
name="about_the_sceneexplorer_window">About the SceneExplorer window</a></h2><div |
||||||
</div> |
class="level2"><p> The SceneExplorer gives you a structural overview of the currently edited scene and is active among all plugins</p><p> Most plugins will deliver their own UI elements to modify the scene so the SceneExplorer is more of a global tool. The simple SceneComposer however heavily relies on its functions as other plugins might too in the future.</p></div><h2><a |
||||||
|
name="using_the_sceneexplorer">Using the SceneExplorer</a></h2><div |
||||||
<h2><a>About the SceneExplorer window</a></h2> |
class="level2"><p> <a |
||||||
<div> |
href="/wiki/lib/exe/detail.php/sdk:jmonkeyplatform-sceneexplorer-add.jpg?id=sdk%3Ascene_explorer"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-sceneexplorer-add.jpg" class="mediaright" align="right" title="jmonkeyplatform-sceneexplorer-add.jpg" alt="jmonkeyplatform-sceneexplorer-add.jpg" /></a> The SceneExplorer displays Nodes in a tree that represents the tree of Spatials in your scene. Spatial controls, lights and geometry meshes are also displayed in the tree.</p></div><h3><a |
||||||
<p> |
name="editing_objects_in_the_scene">Editing Objects in the scene</a></h3><div |
||||||
The SceneExplorer gives you a structural overview of the currently edited scene and is active among all plugins |
class="level3"><ol><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> Select a node in the SceneExplorer window (Open via Window→SceneExplorer if not open)</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
Most plugins will deliver their own UI elements to modify the scene so the SceneExplorer is more of a global tool. The simple SceneComposer however heavily relies on its functions as other plugins might too in the future. |
class="li"> Edit the node in the Properties window (Open via Window→Properties if not open)</div></li><li |
||||||
|
class="level1"><div |
||||||
</p> |
class="li"> You can rename a Spatial by right clicking it or by slowly double-clicking the node</div></li></ol></div><h3><a |
||||||
|
name="reorganizing_objects_in_the_scene">Reorganizing Objects in the scene</a></h3><div |
||||||
</div> |
class="level3"><ol><li |
||||||
|
class="level1"><div |
||||||
<h2><a>Using the SceneExplorer</a></h2> |
class="li"> You can cut, copy and paste Nodes in the SceneExplorer with the normal keyboard commands or the right-click menu of the Nodes</div></li><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> You can move single object within the SceneExplorer tree by dragging&dropping them</div></li></ol></div><h3><a |
||||||
<p> |
name="adding_objects_to_the_scene">Adding Objects to the scene</a></h3><div |
||||||
|
class="level3"><p> Right-click a Spatial or Node in the SceneExplorer to add other Spatials like ParticleEmitters or Lights, you can also add UserData to a Spatial that can be read during runtime.</p></div> |
||||||
<img src="nbdocs:/com/jme3/gde/core/docs/sdk/jmonkeyplatform-sceneexplorer-add.jpg"> |
|
||||||
The SceneExplorer displays Nodes in a tree that represents the tree of Spatials in your scene. Spatial controls, lights and geometry meshes are also displayed in the tree. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Editing Objects in the scene</a></h3> |
|
||||||
<div> |
|
||||||
<ol> |
|
||||||
<li><div> Select a node in the SceneExplorer window (Open via Window→SceneExplorer if not open)</div> |
|
||||||
</li> |
|
||||||
<li><div> Edit the node in the Properties window (Open via Window→Properties if not open)</div> |
|
||||||
</li> |
|
||||||
<li><div> You can rename a Spatial by right clicking it or by slowly double-clicking the node</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Reorganizing Objects in the scene</a></h3> |
|
||||||
<div> |
|
||||||
<ol> |
|
||||||
<li><div> You can cut, copy and paste Nodes in the SceneExplorer with the normal keyboard commands or the right-click menu of the Nodes</div> |
|
||||||
</li> |
|
||||||
<li><div> You can move single object within the SceneExplorer tree by dragging&dropping them</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Adding Objects to the scene</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Right-click a Spatial or Node in the SceneExplorer to add other Spatials like ParticleEmitters or Lights, you can also add UserData to a Spatial that can be read during runtime. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:scene_explorer?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:scene_explorer?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,162 +1,74 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Overview</a></h1> |
name="overview">Overview</a></h1><div |
||||||
<div> |
class="level1"><p> The terrain lets you create, modify, and paint terrain.</p></div><h1><a |
||||||
|
name="controls">Controls</a></h1><div |
||||||
<p> |
class="level1"><p> Terrain controls are the same as the Scene Composer, you rotate the camera with the left mouse button and pan the camera with the right mouse button. Until you select one of the terrain tools in the toolbar, then the controls change for that tool. Then left mouse button will use that tool: painting, raising/lowering terrain, etc. The right mouse button might do something, depending on the tool.</p></div><h1><a |
||||||
The terrain lets you create, modify, and paint terrain. |
name="add_light_to_your_scene">Add light to your scene</a></h1><div |
||||||
</p> |
class="level1"><p> In order to see the terrain, you will need to add light to your scene. To do this you will need to head to the Scene Composer:<br/> <a |
||||||
|
href="/wiki/lib/exe/detail.php/sdk:tut-selectscenecomposer.png?id=sdk%3Aterrain_editor"><img |
||||||
</div> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/tut-selectscenecomposer.png" class="media" alt="" /></a><br/> Then, from the Palette list, select 'Directional Light'<br/> <a |
||||||
|
href="/wiki/lib/exe/detail.php/sdk:tut-scenecomposerdirlight.png?id=sdk%3Aterrain_editor"><img |
||||||
<h1><a>Controls</a></h1> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/tut-scenecomposerdirlight.png" class="media" alt="" /></a><br/> Then, hit the 'add selected item' button.<br/> <a |
||||||
<div> |
href="/wiki/lib/exe/detail.php/sdk:tut-scenecomposeradd.png?id=sdk%3Aterrain_editor"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/sdk/tut-scenecomposeradd.png" class="media" alt="" /></a><br/> Save your scene.<br/> You now have light in your scene and will be able to see your terrain.</p></div><h1><a |
||||||
<p> |
name="creating_terrain">Creating Terrain</a></h1><div |
||||||
Terrain controls are the same as the Scene Composer, you rotate the camera with the left mouse button and pan the camera with the right mouse button. Until you select one of the terrain tools in the toolbar, then the controls change for that tool. Then left mouse button will use that tool: painting, raising/lowering terrain, etc. The right mouse button might do something, depending on the tool. |
class="level1"><p> To create terrain, first select a node (probably your root node) in your scene.<br/> <a |
||||||
</p> |
href="/wiki/lib/exe/detail.php/sdk:tut-selectnode.png?id=sdk%3Aterrain_editor"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/sdk/tut-selectnode.png" class="media" alt="" /></a><br/> Then click the add terrain button.<br/> <a |
||||||
</div> |
href="/wiki/lib/exe/detail.php/sdk:tut-addterrain.png?id=sdk%3Aterrain_editor"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/sdk/tut-addterrain.png" class="media" alt="" /></a><br/> This will pop up the Create Terrain wizard that will walk you through the steps for creating terrain. Make sure you decide now how large you want your terrain to be and how detailed you want the textures to be as you cannot change it later on!</p></div><h5><a |
||||||
<h1><a>Creating Terrain</a></h1> |
name="step_1terrain_size">Step 1: Terrain Size</a></h5><div |
||||||
<div> |
class="level5"><p> Here you determine the size of your terrain, the total size and the patch size. You should probably leave the patch size alone. But the total size should be defined; this is how big your terrain is.</p></div><h5><a |
||||||
|
name="step_2heightmap">Step 2: Heightmap</a></h5><div |
||||||
<p> |
class="level5"><p> Here you can select a heightmap generation technique to give you a default/random look of the terrain. You can also select a heightmap image to pre-define how your terrain looks. |
||||||
To create terrain, first select a node (probably your root node) in your scene. Then click the add terrain button. |
By default, it will give you a flat terrain.</p></div><h5><a |
||||||
This will pop up the Create Terrain wizard that will walk you through the steps for creating terrain. Make sure you decide now how large you want your terrain to be and how detailed you want the textures to be as you cannot change it later on! |
name="step_3alpha_image_detail">Step 3: Alpha Image Detail</a></h5><div |
||||||
</p> |
class="level5"><p> This step determines how large the alpha blend images are for your terrain. The smaller the alpha image, the less detailed you can paint the terrain. Play around with this to see how big you need it to be. Remember that terrain does not have to be that detailed, and is often covered by vegetation, rocks, and other items. So having a really detailed texture is not always necessary.</p></div><h1><a |
||||||
|
name="modifying_terrain">Modifying Terrain</a></h1><div |
||||||
</div> |
class="level1"><p> Right now there are two terrain modification tools: raise and lower terrain.<br/> <a |
||||||
|
href="/wiki/lib/exe/detail.php/sdk:terrain-raise-lower.png?id=sdk%3Aterrain_editor"><img |
||||||
<h5><a>Step 1: Terrain Size</a></h5> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/terrain-raise-lower.png" class="media" alt="" /></a><br/> There are two sliders that affect how these tools operate:</p><ul><li |
||||||
<div> |
class="level1"><div |
||||||
|
class="li"> Radius: how big the brush is</div></li><li |
||||||
<p> |
class="level1"><div |
||||||
Here you determine the size of your terrain, the total size and the patch size. You should probably leave the patch size alone. But the total size should be defined; this is how big your terrain is. |
class="li"> Weight/Height: how much impact the brush has</div></li></ul><p> Once a tool is selected, you will see the tool marker (now an ugly wire sphere) on the map where your mouse is. Click and drag on the terrain to see the tool change the height of the terrain.</p></div><h1><a |
||||||
</p> |
name="painting_terrain">Painting Terrain</a></h1><div |
||||||
|
class="level1"><p> Your terrain comes with one diffuse default texture, and you can have up to 12 total diffuse textures. It also allows you to add normal maps to each texture layer. |
||||||
</div> |
|
||||||
|
|
||||||
<h5><a>Step 2: Heightmap</a></h5> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
Here you can select a heightmap generation technique to give you a default/random look of the terrain. You can also select a heightmap image to pre-define how your terrain looks. |
|
||||||
By default, it will give you a flat terrain. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h5><a>Step 3: Alpha Image Detail</a></h5> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
This step determines how large the alpha blend images are for your terrain. The smaller the alpha image, the less detailed you can paint the terrain. Play around with this to see how big you need it to be. Remember that terrain does not have to be that detailed, and is often covered by vegetation, rocks, and other items. So having a really detailed texture is not always necessary. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h1><a>Modifying Terrain</a></h1> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
Right now there are two terrain modification tools: raise and lower terrain. |
|
||||||
There are two sliders that affect how these tools operate: |
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Radius: how big the brush is</div> |
|
||||||
</li> |
|
||||||
<li><div> Weight/Height: how much impact the brush has</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Once a tool is selected, you will see the tool marker (now an ugly wire sphere) on the map where your mouse is. Click and drag on the terrain to see the tool change the height of the terrain. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h1><a>Painting Terrain</a></h1> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
Your terrain comes with one diffuse default texture, and you can have up to 12 total diffuse textures. It also allows you to add normal maps to each texture layer. |
|
||||||
All of the textures can be controlled in the Texture Layer table by clicking on the textures. |
All of the textures can be controlled in the Texture Layer table by clicking on the textures. |
||||||
</p> |
There are two sliders that affect how the paint tool operates:</p><ul><li |
||||||
|
class="level1"><div |
||||||
<p> |
class="li"> Radius: how big the brush is</div></li><li |
||||||
There are two sliders that affect how the paint tool operates: |
class="level1"><div |
||||||
</p> |
class="li"> Weight/Height: how much impact the brush has</div></li></ul></div><h5><a |
||||||
<ul> |
name="adding_a_new_texture_layer">Adding a new texture layer</a></h5><div |
||||||
<li><div> Radius: how big the brush is</div> |
class="level5"><p> Adds a new texture layer to the terrain. The will be drawn over top of the other texture layers listed above it in the list.<br/> <a |
||||||
</li> |
href="/wiki/lib/exe/detail.php/sdk:terrain-addtexture.png?id=sdk%3Aterrain_editor"><img |
||||||
<li><div> Weight/Height: how much impact the brush has</div> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/terrain-addtexture.png" class="media" alt="" /></a><br/></p></div><h5><a |
||||||
</li> |
name="changing_the_diffuse_texture">Changing the diffuse texture</a></h5><div |
||||||
</ul> |
class="level5"><p> Click on the diffuse texture image in the texture table. This will pop up a window with the available textures in your assets directory.<br/> <a |
||||||
|
href="/wiki/lib/exe/detail.php/sdk:terrain-editdiffuse.png?id=sdk%3Aterrain_editor"><img |
||||||
</div> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/terrain-editdiffuse.png" class="media" alt="" /></a><br/></p></div><h5><a |
||||||
|
name="adding_a_normal_map_to_the_texture_layer">Adding a normal map to the texture layer</a></h5><div |
||||||
<h5><a>Adding a new texture layer</a></h5> |
class="level5"><p> When you add a texture layer, by default it does not add a normal map for you. To add one, click on the button next to the diffuse texture for that texture layer. This will pop up the texture browser. Select a texture and hit Ok, and you are done.<br/> <a |
||||||
<div> |
href="/wiki/lib/exe/detail.php/sdk:terrain-addnormaltexture.png?id=sdk%3Aterrain_editor"><img |
||||||
|
src="nbdocs:/com/jme3/gde/core/docs/sdk/terrain-addnormaltexture.png" class="media" alt="" /></a><br/></p></div><h5><a |
||||||
</div> |
name="removing_a_normal_map_from_the_texture_layer">Removing a normal map from the texture layer</a></h5><div |
||||||
|
class="level5"><p> To remove a normal map from the texture layer, hit the normal map button for that texture layer again, and deselect the texture. Then hit Ok and the texture should be removed.</p></div><h5><a |
||||||
<h5><a>Changing the diffuse texture</a></h5> |
name="changing_the_texture_scale">Changing the texture scale</a></h5><div |
||||||
<div> |
class="level5"><p> The field in the table to the right of the diffuse and normal textures for your texture layer is the scale. Changing that value changes the scale of the texture.<br/> <a |
||||||
|
href="/wiki/lib/exe/detail.php/sdk:terrain-texturescale.png?id=sdk%3Aterrain_editor"><img |
||||||
</div> |
src="nbdocs:/com/jme3/gde/core/docs/sdk/terrain-texturescale.png" class="media" alt="" /></a><br/> You will notice that the scale changes when you switch between Tri-Planar and normal texture mapping. Tri-planar mapping does not use the texture coordinates of the geometry, but real world coordinates. And because of this, in order for the texture to look the same when you switch between the two texture mapping methods, the terrain editor will automatically convert the scales for you. |
||||||
|
Essentially if your scale in normal texture coordinates is 16, then for tri-planar gets converted like this: 1/terrainSize/16</p></div><h5><a |
||||||
<h5><a>Adding a normal map to the texture layer</a></h5> |
name="tri-planar_texture_mapping">Tri-planar texture mapping</a></h5><div |
||||||
<div> |
class="level5"><p> Tri-planar texture mapping is recommended if you have lots of near-vertical terrain. With normal texture mapping the textures can look stretched because it is rendered on the one plane: X-Z. Tri-planar mapping renders the textures on three planes: X-Z, X-Y, Z-Y; and blends them together based on what plane the normal of the triangle is facing most on. |
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h5><a>Removing a normal map from the texture layer</a></h5> |
|
||||||
<div> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h5><a>Changing the texture scale</a></h5> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
The field in the table to the right of the diffuse and normal textures for your texture layer is the scale. Changing that value changes the scale of the texture. |
|
||||||
You will notice that the scale changes when you switch between Tri-Planar and normal texture mapping. Tri-planar mapping does not use the texture coordinates of the geometry, but real world coordinates. And because of this, in order for the texture to look the same when you switch between the two texture mapping methods, the terrain editor will automatically convert the scales for you. |
|
||||||
Essentially if your scale in normal texture coordinates is 16, then for tri-planar gets converted like this: 1/terrainSize/16 |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h5><a>Tri-planar texture mapping</a></h5> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
Tri-planar texture mapping is recommended if you have lots of near-vertical terrain. With normal texture mapping the textures can look stretched because it is rendered on the one plane: X-Z. Tri-planar mapping renders the textures on three planes: X-Z, X-Y, Z-Y; and blends them together based on what plane the normal of the triangle is facing most on. |
|
||||||
This makes the terrain look much better, but it does have a performance hit! |
This makes the terrain look much better, but it does have a performance hit! |
||||||
Here is an article on tri-planar mapping: <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://http.developer.nvidia.com/GPUGems3/gpugems3_ch01.html"><param name="text" value="<html><u>http://http.developer.nvidia.com/GPUGems3/gpugems3_ch01.html</u></html>"><param name="textColor" value="blue"></object> |
Here is an article on tri-planar mapping: <a |
||||||
</p> |
href="http://http.developer.nvidia.com/GPUGems3/gpugems3_ch01.html">http://http.developer.nvidia.com/GPUGems3/gpugems3_ch01.html</a></p></div><h5><a |
||||||
|
name="total_texture_count">Total texture count</a></h5><div |
||||||
</div> |
class="level5"><p> Terrain will support a maximum of 12 diffuse texture. And a combined total of 13 diffuse and normal maps. |
||||||
|
Most video cards are limited to 16 texture units (textures), and 3 are used behind the scenes of the terrain material for alpha blending of the textures, so you are left with a maximum of 13 textures.</p></div><h1><a |
||||||
<h5><a>Total texture count</a></h5> |
name="generating_terrain_entropies_for_lod">Generating Terrain Entropies for LOD</a></h1><div |
||||||
<div> |
class="level1"><p> If you are using the recommended PerspectiveLodCalculator for calculating LOD levels of the terrain, then you will want to pre-generate the entropy levels for the terrain. This is a slow process. If they are not pre-generated, the LOD control will generate them for you, but this will lag the user when they load the scene, and the terrain will flicker. |
||||||
|
|
||||||
<p> |
|
||||||
Terrain will support a maximum of 12 diffuse texture. And a combined total of 13 diffuse and normal maps. |
|
||||||
Most video cards are limited to 16 texture units (textures), and 3 are used behind the scenes of the terrain material for alpha blending of the textures, so you are left with a maximum of 13 textures. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h1><a>Generating Terrain Entropies for LOD</a></h1> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
If you are using the recommended PerspectiveLodCalculator for calculating LOD levels of the terrain, then you will want to pre-generate the entropy levels for the terrain. This is a slow process. If they are not pre-generated, the LOD control will generate them for you, but this will lag the user when they load the scene, and the terrain will flicker. |
|
||||||
Use the 'Generate Entropies' button to pre-generate the entropies for the terrain, they will be saved with it. |
Use the 'Generate Entropies' button to pre-generate the entropies for the terrain, they will be saved with it. |
||||||
Note that whenever you modify the height of the terrain, you should re-generate the entropies. Of course, don't do this every time, but maybe just before you are ready to send the map out for testing. |
Note that whenever you modify the height of the terrain, you should re-generate the entropies. Of course, don't do this every time, but maybe just before you are ready to send the map out for testing.</p></div> |
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:terrain_editor?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:terrain_editor?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,17 +1,8 @@ |
|||||||
|
<h2><a |
||||||
<h2><a>Troubleshooting jMonkeyEngine3 SDK</a></h2> |
name="troubleshooting_jmonkeyengine3_sdk">Troubleshooting jMonkeyEngine3 SDK</a></h2><div |
||||||
<div> |
class="level2"></div><h3><a |
||||||
|
name="specifying_the_jdk_location">Specifying the JDK location</a></h3><div |
||||||
</div> |
class="level3"><p> If jMonkeyPlatform cannot find a valid <acronym |
||||||
|
title="Java Development Kit">JDK</acronym> although you have it installed you have to specify the location manually. |
||||||
<h3><a>Specifying the JDK location</a></h3> |
To do that edit the file <code>jmonkeyplatform.conf</code> in the <code>etc</code> directory of your jMonkeyPlatform installation location. Mac users have to right-click the application and select "Show package contents" and then navigate to <code>Contents/Resources/jmonkeyplatform</code>.</p></div> |
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
If jMonkeyPlatform cannot find a valid <acronym title="Java Development Kit">JDK</acronym> although you have it installed you have to specify the location manually. |
|
||||||
To do that edit the file <code>jmonkeyplatform.conf</code> in the <code>etc</code> directory of your jMonkeyPlatform installation location. Mac users have to right-click the application and select “Show package contents” and then navigate to <code>Contents/Resources/jmonkeyplatform</code>. |
|
||||||
|
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:troubleshooting?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:troubleshooting?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,38 +1,35 @@ |
|||||||
|
<h2><a |
||||||
<h2><a>How to integrate your own jME3 compile in jMP projects</a></h2> |
name="how_to_integrate_your_own_jme3_compile_in_jmp_projects">How to integrate your own jME3 compile in jMP projects</a></h2><div |
||||||
<div> |
class="level2"><ol><li |
||||||
<ol> |
class="level1"><div |
||||||
<li><div> <a href="/com/jme3/gde/core/docs/jme3/build_jme3_sources_with_netbeans.html">Download jme3 project from svn</a></div> |
class="li"> <a |
||||||
</li> |
href="/com/jme3/gde/core/docs/jme3/build_jme3_sources_with_netbeans.html">Download jme3 project from svn</a></div></li><li |
||||||
<li><div> Make your changes</div> |
class="level1"><div |
||||||
</li> |
class="li"> Make your changes</div></li><li |
||||||
<li><div> Compile jme3 project</div> |
class="level1"><div |
||||||
</li> |
class="li"> Compile jme3 project</div></li><li |
||||||
<li><div> Go to Tools → Libraries</div> |
class="level1"><div |
||||||
</li> |
class="li"> Go to Tools → Libraries</div></li><li |
||||||
<li><div> Press “New Library”</div> |
class="level1"><div |
||||||
</li> |
class="li"> Press "New Library"</div></li><li |
||||||
<li><div> Name it “jme3-modified”</div> |
class="level1"><div |
||||||
</li> |
class="li"> Name it "jme3-modified"</div></li><li |
||||||
<li><div> Press “Add Jar/Folder”</div> |
class="level1"><div |
||||||
</li> |
class="li"> Press "Add Jar/Folder"</div></li><li |
||||||
<li><div> Select <code>jMonkeyEngine3.jar</code> from the <code>dist</code> dir of the compiled jme3 version</div> |
class="level1"><div |
||||||
</li> |
class="li"> Select <code>jMonkeyEngine3.jar</code> from the <code>dist</code> dir of the compiled jme3 version</div></li><li |
||||||
<li><div> Add the <code>src</code> folder of the jme3 project in the “sources” tab</div> |
class="level1"><div |
||||||
</li> |
class="li"> Add the <code>src</code> folder of the jme3 project in the "sources" tab</div></li><li |
||||||
<li><div> Optionally javadoc in the “javadoc” tab</div> |
class="level1"><div |
||||||
</li> |
class="li"> Optionally javadoc in the "javadoc" tab</div></li><li |
||||||
<li><div> Press “OK”</div> |
class="level1"><div |
||||||
</li> |
class="li"> Press "OK"</div></li><li |
||||||
<li><div> Right-click your project and select “Properties”</div> |
class="level1"><div |
||||||
</li> |
class="li"> Right-click your project and select "Properties"</div></li><li |
||||||
<li><div> Select “Libraries” to the left</div> |
class="level1"><div |
||||||
</li> |
class="li"> Select "Libraries" to the left</div></li><li |
||||||
<li><div> Remove the “jme3” library</div> |
class="level1"><div |
||||||
</li> |
class="li"> Remove the "jme3" library</div></li><li |
||||||
<li><div> Press “Add Library” and select the “jme3-modified” library</div> |
class="level1"><div |
||||||
</li> |
class="li"> Press "Add Library" and select the "jme3-modified" library</div></li></ol></div> |
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:use_own_jme?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:use_own_jme?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,214 +1,100 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>jMonkeyPlatform: Version Control</a></h1> |
name="jmonkeyplatformversion_control">jMonkeyPlatform: Version Control</a></h1><div |
||||||
<div> |
class="level1"><p> Whether you work in a development team or alone: File versioning is a handy method to keep your code consistent, compare files line-by-line, and even roll back unwanted changes. This documentation shows you how to make the most of the jMonkeyPlatform's integrated version control features for Subversion, Mercurial, and <acronym |
||||||
|
title="Concurrent Versions System">CVS</acronym>.</p><p> <br/></p><p> Note: Since the jMonkeyPlatform is based on the NetBeans Platform framework, you can learn about certain jMonkeyPlatform features by reading the corresponding NetBeans IDE tutorials (in the "see also links").</p></div><h2><a |
||||||
<p> |
name="version_control_systems">Version Control Systems</a></h2><div |
||||||
|
class="level2"><p> The jMonkeyPlatform supports various Version Control Systems such as Subversion, Mercurial, and <acronym |
||||||
Whether you work in a development team or alone: File versioning is a handy method to keep your code consistent, compare files line-by-line, and even roll back unwanted changes. This documentation shows you how to make the most of the jMonkeyPlatform's integrated version control features for Subversion, Mercurial, and <acronym title="Concurrent Versions System">CVS</acronym>. |
title="Concurrent Versions System">CVS</acronym>. No matter which of them you use, they all share a common user interface.</p><p> You can use file versioning alone or in a team. The advantages are that you can keep track of changes (who did it, when, and why), you can compare versions line-by-line, you can revert changes to files and lines, merge multiple changes to one file, and you can even undelete files.</p></div><h2><a |
||||||
</p> |
name="creating_a_repository_upload">Creating a Repository (Upload)</a></h2><div |
||||||
|
class="level2"><p> Requirements:</p><ul><li |
||||||
<p> |
class="level1"><div |
||||||
<br/> |
class="li"> You must have a project that you want to version.</div></li><li |
||||||
|
class="level1"><div |
||||||
</p> |
class="li"> You must have version control software installed (Subversion, Mercurial, or <acronym |
||||||
|
title="Concurrent Versions System">CVS</acronym>) and have initialized a repository.</div><ul><li |
||||||
<p> |
class="level2"><div |
||||||
Note: Since the jMonkeyPlatform is based on the NetBeans Platform framework, you can learn about certain jMonkeyPlatform features by reading the corresponding NetBeans IDE tutorials (in the “see also links”). |
class="li"> Tip: For Subversion, the init command looks like this example: <code>svnadmin create /home/joe/mysvnrepo</code></div></li></ul></li><li |
||||||
</p> |
class="level1"><div |
||||||
|
class="li"> The computer where the repository is to be hosted must be available in your network, or you will only be able to use your repo locally.</div><ul><li |
||||||
</div> |
class="level2"><div |
||||||
|
class="li"> Tip: Hosts such as SourceForge, GoogleCode, dev.java.net offer free version control services for open-source projects.</div></li></ul></li></ul><p> Now you create a repository to store your project's files.</p><ol><li |
||||||
<h2><a>Version Control Systems</a></h2> |
class="level1"><div |
||||||
<div> |
class="li"> In the jMonkeyPlatform, right-click the project in the Projects window and choose Versioning > Import Into <acronym |
||||||
|
title="Concurrent Versions System">CVS</acronym>/Subversion Repository (or initialize Mercurial Project, respectively).</div><ul><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> Tip: If you haven't evaluated yet which system to choose, start with Subversion for now.</div></li></ul></li><li |
||||||
The jMonkeyPlatform supports various Version Control Systems such as Subversion, Mercurial, and <acronym title="Concurrent Versions System">CVS</acronym>. No matter which of them you use, they all share a common user interface. |
class="level1"><div |
||||||
</p> |
class="li"> Go through the wizard and fill in the fields to set up the repository.</div></li></ol></div><h2><a |
||||||
|
name="checking_out_a_repository_download">Checking Out a Repository (Download)</a></h2><div |
||||||
<p> |
class="level2"><p> You and your team mates check out (download) the repository to their individual workstations.</p><ol><li |
||||||
You can use file versioning alone or in a team. The advantages are that you can keep track of changes (who did it, when, and why), you can compare versions line-by-line, you can revert changes to files and lines, merge multiple changes to one file, and you can even undelete files. |
class="level1"><div |
||||||
</p> |
class="li"> Go to the Team menu and choose Subversion > Checkout (or <acronym |
||||||
|
title="Concurrent Versions System">CVS</acronym>/Mercurial>Checkout respectively)</div></li><li |
||||||
</div> |
class="level1"><div |
||||||
|
class="li"> Fill in your repo data into the wizard and click Finish.</div><ul><li |
||||||
<h2><a>Creating a Repository (Upload)</a></h2> |
class="level2"><div |
||||||
<div> |
class="li"> A typical repository <acronym |
||||||
|
title="Uniform Resource Locator">URL</acronym> looks like this example: <code><a |
||||||
<p> |
href="http://jmonkeyengine.googlecode.com/svn/trunk/engine">http://jmonkeyengine.googlecode.com/svn/trunk/engine</a></code></div></li><li |
||||||
|
class="level2"><div |
||||||
Requirements: |
class="li"> If you want to be able to submit changes, you must have a username and password to this repository. Otherwise leave these fields blank.</div></li></ul></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ul> |
class="li"> The repository is downloaded and stored in the location you chose.</div></li><li |
||||||
<li><div> You must have a project that you want to version. </div> |
class="level1"><div |
||||||
</li> |
class="li"> Use the File > Open Project menu to open the checkout as project and start working.</div><ul><li |
||||||
<li><div> You must have version control software installed (Subversion, Mercurial, or <acronym title="Concurrent Versions System">CVS</acronym>) and have initialized a repository.</div> |
class="level2"><div |
||||||
<ul> |
class="li"> If the checkout is not recognized you need to choose File > New Project from Existing Sources</div></li></ul></li></ol><p> <br/> Of course you can also check out existing repositories and access code from other open-source projects (e.g. SourceForge, GoogleCode, dev.java.net).</p></div><h2><a |
||||||
<li><div> Tip: For Subversion, the init command looks like this example: <code>svnadmin create /home/joe/mysvnrepo</code></div> |
name="updating_and_committing_changes_send_and_receive">Updating and Committing Changes (Send and Receive)</a></h2><div |
||||||
</li> |
class="level2"><p> Receiving the latest changes from the team's repository is referred to as <code>updating</code>. Sending your changes to the team's repository is refered to as <code>commiting</code>.</p><ol><li |
||||||
</ul> |
class="level1"><div |
||||||
</li> |
class="li"> Before making changes, right-click the project and select Subversion > Update to make sure you have the latest revision.</div><ul><li |
||||||
<li><div> The computer where the repository is to be hosted must be available in your network, or you will only be able to use your repo locally.</div> |
class="level2"><div |
||||||
<ul> |
class="li"> Get in the habit of updating regularly, always before you edit a version controlled file. It will spare you much grief.</div></li></ul></li><li |
||||||
<li><div> Tip: Hosts such as SourceForge, GoogleCode, dev.java.net offer free version control services for open-source projects.</div> |
class="level1"><div |
||||||
</li> |
class="li"> After making changes to the project, make certain your change did not break anything.</div><ol><li |
||||||
</ul> |
class="level2"><div |
||||||
</li> |
class="li"> Update, build, run, test.</div></li><li |
||||||
</ul> |
class="level2"><div |
||||||
|
class="li"> Look at the red/green/blue marks in the editor to review what you have deleted/added/changed. Click the marks to review all differences in a file.</div></li><li |
||||||
<p> |
class="level2"><div |
||||||
|
class="li"> Choose Subversion > Show Changes to see all files that were recently changed – by you and other team members.</div></li><li |
||||||
Now you create a repository to store your project's files. |
class="level2"><div |
||||||
|
class="li"> <em>Update again</em> in case your team mates made changes while you were reviewing.</div></li></ol></li><li |
||||||
</p> |
class="level1"><div |
||||||
<ol> |
class="li"> If there are no conflicts and you want to commit your changes, choose Subversion > Commit from the menu.</div></li><li |
||||||
<li><div> In the jMonkeyPlatform, right-click the project in the Projects window and choose Versioning > Import Into <acronym title="Concurrent Versions System">CVS</acronym>/Subversion Repository (or initialize Mercurial Project, respectively). </div> |
class="level1"><div |
||||||
<ul> |
class="li"> Write a commit message describing what you changed.</div><ul><li |
||||||
<li><div> Tip: If you haven't evaluated yet which system to choose, start with Subversion for now.</div> |
class="level2"><div |
||||||
</li> |
class="li"> Remember, you are writing "a message to your future self". Never write redundant stuff like "I changed something".</div></li></ul></li></ol></div><h2><a |
||||||
</ul> |
name="comparing_and_reverting_changes">Comparing and Reverting Changes</a></h2><div |
||||||
</li> |
class="level2"><ul><li |
||||||
<li><div> Go through the wizard and fill in the fields to set up the repository.</div> |
class="level1"><div |
||||||
</li> |
class="li"> If you and another committer edited the same line, there is a conflict, and the jMonkeyPlatform will show an error message.</div><ul><li |
||||||
</ol> |
class="level2"><div |
||||||
|
class="li"> Right-click a file Choose Subversion > Resolve Conflict</div><ol><li |
||||||
</div> |
class="level3"><div |
||||||
|
class="li"> Compare the conflicting versions. Press the buttons to accept or reject each change individually.</div></li><li |
||||||
<h2><a>Checking Out a Repository (Download)</a></h2> |
class="level3"><div |
||||||
<div> |
class="li"> After the resolver shows green, save the resolution.</div></li><li |
||||||
|
class="level3"><div |
||||||
<p> |
class="li"> Build and test the resolution, update, and commit.</div></li></ol></li></ul></li><li |
||||||
|
class="level1"><div |
||||||
You and your team mates check out (download) the repository to their individual workstations. |
class="li"> Right-click a file and choose Subversion > Search History.</div><ul><li |
||||||
|
class="level2"><div |
||||||
</p> |
class="li"> You can inspect a file's history and see who changed what, why, and when.</div></li><li |
||||||
<ol> |
class="level2"><div |
||||||
<li><div> Go to the Team menu and choose Subversion > Checkout (or <acronym title="Concurrent Versions System">CVS</acronym>/Mercurial>Checkout respectively)</div> |
class="li"> You can roll back a file to a historic version if necessary.</div></li></ul></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Fill in your repo data into the wizard and click Finish.</div> |
class="li"> In general, you can choose Subversion > Diff for any file to see two versions of a file next to each other.</div></li></ul></div><h2><a |
||||||
<ul> |
name="no_version_control_local_history">No Version Control? Local History!</a></h2><div |
||||||
<li><div> A typical repository <acronym title="Uniform Resource Locator">URL</acronym> looks like this example: <code><object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://jmonkeyengine.googlecode.com/svn/trunk/engine"><param name="text" value="<html><u>http://jmonkeyengine.googlecode.com/svn/trunk/engine</u></html>"><param name="textColor" value="blue"></object></code></div> |
class="level2"><p> If you do not use any version control, you can still track changes in projects to a certain degree.</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> If you want to be able to submit changes, you must have a username and password to this repository. Otherwise leave these fields blank.</div> |
class="li"> Right-click a file or directory and choose Local History to show or revert changes, or undelete files.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
</ul> |
class="li"> You can also select any two files in the Project window and choose Tools > Diff to compare them.</div></li><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> The repository is downloaded and stored in the location you chose. </div> |
class="li"> Local History only works for files edited in jMonkeyPlatform Projects (It does not work for other files, e.g. in the Favorites window.)</div></li></ul><p> <br/> See also:</p><ul><li |
||||||
</li> |
class="level1"><div |
||||||
<li><div> Use the File > Open Project menu to open the checkout as project and start working. </div> |
class="li"> <a |
||||||
<ul> |
href="http://netbeans.org/kb/docs/ide/subversion.html">Source Code Management with Subversion</a></div></li></ul></div> |
||||||
<li><div> If the checkout is not recognized you need to choose File > New Project from Existing Sources</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
<br/> |
|
||||||
|
|
||||||
Of course you can also check out existing repositories and access code from other open-source projects (e.g. SourceForge, GoogleCode, dev.java.net). |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Updating and Committing Changes (Send and Receive)</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Receiving the latest changes from the team's repository is referred to as <code>updating</code>. Sending your changes to the team's repository is refered to as <code>commiting</code>. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ol> |
|
||||||
<li><div> Before making changes, right-click the project and select Subversion > Update to make sure you have the latest revision.</div> |
|
||||||
<ul> |
|
||||||
<li><div> Get in the habit of updating regularly, always before you edit a version controlled file. It will spare you much grief.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> After making changes to the project, make certain your change did not break anything.</div> |
|
||||||
<ol> |
|
||||||
<li><div> Update, build, run, test.</div> |
|
||||||
</li> |
|
||||||
<li><div> Look at the red/green/blue marks in the editor to review what you have deleted/added/changed. Click the marks to review all differences in a file.</div> |
|
||||||
</li> |
|
||||||
<li><div> Choose Subversion > Show Changes to see all files that were recently changed – by you and other team members. </div> |
|
||||||
</li> |
|
||||||
<li><div> <em>Update again</em> in case your team mates made changes while you were reviewing.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
<li><div> If there are no conflicts and you want to commit your changes, choose Subversion > Commit from the menu.</div> |
|
||||||
</li> |
|
||||||
<li><div> Write a commit message describing what you changed. </div> |
|
||||||
<ul> |
|
||||||
<li><div> Remember, you are writing “a message to your future self”. Never write redundant stuff like “I changed something”.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>Comparing and Reverting Changes</a></h2> |
|
||||||
<div> |
|
||||||
<ul> |
|
||||||
<li><div> If you and another committer edited the same line, there is a conflict, and the jMonkeyPlatform will show an error message. </div> |
|
||||||
<ul> |
|
||||||
<li><div> Right-click a file Choose Subversion > Resolve Conflict</div> |
|
||||||
<ol> |
|
||||||
<li><div> Compare the conflicting versions. Press the buttons to accept or reject each change individually. </div> |
|
||||||
</li> |
|
||||||
<li><div> After the resolver shows green, save the resolution.</div> |
|
||||||
</li> |
|
||||||
<li><div> Build and test the resolution, update, and commit.</div> |
|
||||||
</li> |
|
||||||
</ol> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> Right-click a file and choose Subversion > Search History.</div> |
|
||||||
<ul> |
|
||||||
<li><div> You can inspect a file's history and see who changed what, why, and when. </div> |
|
||||||
</li> |
|
||||||
<li><div> You can roll back a file to a historic version if necessary.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
</li> |
|
||||||
<li><div> In general, you can choose Subversion > Diff for any file to see two versions of a file next to each other.</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h2><a>No Version Control? Local History!</a></h2> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
If you do not use any version control, you can still track changes in projects to a certain degree. |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> Right-click a file or directory and choose Local History to show or revert changes, or undelete files.</div> |
|
||||||
</li> |
|
||||||
<li><div> You can also select any two files in the Project window and choose Tools > Diff to compare them.</div> |
|
||||||
</li> |
|
||||||
<li><div> Local History only works for files edited in jMonkeyPlatform Projects (It does not work for other files, e.g. in the Favorites window.)</div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
<p> |
|
||||||
<br/> |
|
||||||
|
|
||||||
See also: |
|
||||||
|
|
||||||
</p> |
|
||||||
<ul> |
|
||||||
<li><div> <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://netbeans.org/kb/docs/ide/subversion.html"><param name="text" value="<html><u>Source Code Management with Subversion</u></html>"><param name="textColor" value="blue"></object></div> |
|
||||||
</li> |
|
||||||
</ul> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:version_control?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/sdk:version_control?do=export_xhtmlbody">view online version</a></em></p> |
||||||
@ -1,39 +1,14 @@ |
|||||||
|
<h1><a |
||||||
<h1><a>Compression</a></h1> |
name="compression">Compression</a></h1><div |
||||||
<div> |
class="level1"><p><p><div |
||||||
|
class="notewarning">This article covers a deprecated <acronym |
||||||
<p> |
title="Application Programming Interface">API</acronym>! See <a |
||||||
<p><div>This article covers a deprecated <acronym title="Application Programming Interface">API</acronym>! See <a href="/com/jme3/gde/core/docs/jme3/advanced/networking.html">networking</a> for current documentation. |
href="/com/jme3/gde/core/docs/jme3/advanced/networking.html">networking</a> for current documentation.</div></p> Now this is going to be a real simply tutorial but still I wanted this in a separate article. Why you may ask? Simply because it's a feature that requires some explanation, since it has some caveats that I'll discuss. Also, I'll cover writing your own compression message.</p><p> First off - there are two compression types in SpiderMonkey, they are GZip and Zip. Could've added more, but didn't want to have a dependency for just a compression method. Both are used by wrapping your message in the appropriate compression message:</p><pre>MyMessage msg = new MyMessage(); |
||||||
</div></p> |
|
||||||
Now this is going to be a real simply tutorial but still I wanted this in a separate article. Why you may ask? Simply because it's a feature that requires some explanation, since it has some caveats that I'll discuss. Also, I'll cover writing your own compression message. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
First off - there are two compression types in SpiderMonkey, they are GZip and Zip. Could've added more, but didn't want to have a dependency for just a compression method. Both are used by wrapping your message in the appropriate compression message: |
|
||||||
|
|
||||||
</p> |
|
||||||
<pre>MyMessage msg = new MyMessage(); |
|
||||||
client.send(new GZIPCompressedMessage(msg)); |
client.send(new GZIPCompressedMessage(msg)); |
||||||
// or |
// or |
||||||
client.send(new ZIPCompressedMessage(msg));</pre> |
client.send(new ZIPCompressedMessage(msg));</pre><p> Really simple, but ZIP requires some explanation. The ZIPCompressedMessage class also has two extra methods; setLevel(int) and getLevel(). These methods are for setting the compression level, where 1 is best compression but slowest, and where 9 is weakest compression but fastest. Please note that 9 is <strong>not</strong> the so called 'store' ZIP method, which simply stores file in the ZIP, instead of compressing it. This 'store' feature is not in SpiderMonkey since otherwise it would not have been called compression.</p></div><h3><a |
||||||
<p> |
name="writing_your_own">Writing your own</a></h3><div |
||||||
|
class="level3"><p> Now of course I'd love to see more compression methods in SpiderMonkey, so I'll discuss how to write your own. Let's just take GZIPCompressedMessage as example, since that one is the most straightforward. What I've done, is I've just created a GZIPCompressedMessage which extends CompressedMessage. It does not contain any extra messages, so the GZIPCompressedMessage class is practically 'empty'. The magic happens at the serializer, which is called the GZIPSerializer (you can read about writing your own serializer <a |
||||||
Really simple, but ZIP requires some explanation. The ZIPCompressedMessage class also has two extra methods; setLevel(int) and getLevel(). These methods are for setting the compression level, where 1 is best compression but slowest, and where 9 is weakest compression but fastest. Please note that 9 is <strong>not</strong> the so called 'store' ZIP method, which simply stores file in the ZIP, instead of compressing it. This 'store' feature is not in SpiderMonkey since otherwise it would not have been called compression. |
href="/com/jme3/gde/core/docs/spidermonkey/tutorial/serializing.html">here</a>). Then I just registered the GZIPSerializer to GZIPCompressedMessage and presto - you're done. Don't forget that in the Serializer you need to use writeClassAndObject first and then compress that data, and for read you'd need to use readClassAndObject after you've uncompressed (inflated) the message. For this to be clear, it may be useful to read <a |
||||||
</p> |
href="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/networking/com/jme3/network/serializing/serializers/GZIPSerializer.java">the GZIPSerializer class</a>.</p><p> That's that! Next tutorial we're going to discuss how to use the Service system.</p></div> |
||||||
|
|
||||||
</div> |
|
||||||
|
|
||||||
<h3><a>Writing your own</a></h3> |
|
||||||
<div> |
|
||||||
|
|
||||||
<p> |
|
||||||
|
|
||||||
Now of course I'd love to see more compression methods in SpiderMonkey, so I'll discuss how to write your own. Let's just take GZIPCompressedMessage as example, since that one is the most straightforward. What I've done, is I've just created a GZIPCompressedMessage which extends CompressedMessage. It does not contain any extra messages, so the GZIPCompressedMessage class is practically 'empty'. The magic happens at the serializer, which is called the GZIPSerializer (you can read about writing your own serializer <a href="/com/jme3/gde/core/docs/spidermonkey/tutorial/serializing.html">here</a>). Then I just registered the GZIPSerializer to GZIPCompressedMessage and presto - you're done. Don't forget that in the Serializer you need to use writeClassAndObject first and then compress that data, and for read you'd need to use readClassAndObject after you've uncompressed (inflated) the message. For this to be clear, it may be useful to read <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"><param name="content" value="http://code.google.com/p/jmonkeyengine/source/browse/trunk/engine/src/networking/com/jme3/network/serializing/serializers/GZIPSerializer.java"><param name="text" value="<html><u>the GZIPSerializer class</u></html>"><param name="textColor" value="blue"></object>. |
|
||||||
</p> |
|
||||||
|
|
||||||
<p> |
|
||||||
That's that! Next tutorial we're going to discuss how to use the Service system. |
|
||||||
</p> |
|
||||||
|
|
||||||
</div> |
|
||||||
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/spidermonkey:tutorial:compression?do=export_xhtmlbody">view online version</a></em></p> |
<p><em><a href="http://jmonkeyengine.org/wiki/doku.php/spidermonkey:tutorial:compression?do=export_xhtmlbody">view online version</a></em></p> |
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue