From 6dbc85234fc1019c68ce18eafd21f1a48ce391d6 Mon Sep 17 00:00:00 2001 From: "nor..67" Date: Mon, 18 Jun 2012 17:20:30 +0000 Subject: [PATCH] SDK: - update manual git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@9510 75d07b2b-3a1a-0410-a2c5-0572b91ccdca --- .../gde/core/docs/jme3/advanced/audio.html | 31 ++++--- .../docs/jme3/advanced/input_handling.html | 37 +++++--- .../docs/jme3/advanced/loading_screen.html | 14 +-- .../gde/core/docs/jme3/advanced/logging.html | 8 +- .../core/docs/jme3/advanced/monkey_zone.html | 2 +- .../jme3/advanced/nifty_gui_java_layout.html | 12 +-- .../jme3/advanced/nifty_gui_scenarios.html | 2 +- .../jme3/advanced/nifty_gui_xml_layout.html | 28 +++--- .../docs/jme3/advanced/particle_emitters.html | 2 +- .../core/docs/jme3/advanced/swing_canvas.html | 15 ++- .../core/docs/jme3/beginner/hello_audio.html | 17 ++-- .../core/docs/jme3/beginner/hello_node.html | 33 +++---- .../docs/jme3/external/blender-material-1.png | Bin 0 -> 57720 bytes .../docs/jme3/external/blender-material-2.png | Bin 0 -> 109230 bytes .../docs/jme3/external/blender-material-3.png | Bin 0 -> 144941 bytes .../docs/jme3/external/blender-material-4.png | Bin 0 -> 173952 bytes .../gde/core/docs/jme3/external/blender.html | 11 ++- .../docs/jme3/intermediate/appsettings.html | 86 ++++++++++++++---- .../jme3/intermediate/best_practices.html | 29 +++--- .../multi-media_asset_pipeline.html | 2 +- .../docs/jme3/intermediate/optimization.html | 2 +- .../com/jme3/gde/core/docs/sdk/blender.html | 20 ++-- .../jme3/gde/core/docs/sdk/code_editor.html | 8 +- .../docs/sdk/model_loader_and_viewer.html | 24 +++-- .../gde/core/docs/sdk/project_creation.html | 82 +++++++++-------- .../gde/core/docs/sdk/troubleshooting.html | 16 ++-- .../com/jme3/gde/core/docs/wiki-map.xml | 2 +- 27 files changed, 289 insertions(+), 194 deletions(-) create mode 100644 sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/external/blender-material-1.png create mode 100644 sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/external/blender-material-2.png create mode 100644 sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/external/blender-material-3.png create mode 100644 sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/external/blender-material-4.png diff --git a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/audio.html b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/audio.html index 2d4536f71..6cbde4b7c 100644 --- a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/audio.html +++ b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/audio.html @@ -8,11 +8,12 @@ There are two ways to handle audio data: Short audio files are to be stored enti

-Place audio files in the assets/Sound/ directory of your project. jME3 supports Ogg Vorbis (.ogg) and Wave (.wav) formats. +Place audio files in the assets/Sound/ directory of your project. jME3 supports Ogg Vorbis (.ogg) and Wave (.wav) formats. You can use for example to convert from other formats. +

- +

Creating Audio Nodes: Streamed or Buffered

@@ -31,7 +32,7 @@ The main class to look at is com.jme3.audio.AudioNode.
- +

Getting AudioNode Properties

@@ -48,14 +49,14 @@ The main class to look at is com.jme3.audio.AudioNode.
getPitch()Returns the pitch.
- +

There are other obvious getters to poll the status of corresponding setters below.

- +

Setting AudioNode Properties

@@ -69,7 +70,7 @@ There are other obvious getters to poll the status of corresponding setters belo
setPitch(1)Makes the sound play in a higher or lower pitch. Default is 1. 2 is twice as high, .5f is half as high.
-
+
@@ -85,13 +86,13 @@ Does not work for streamed sounds! setDirectional(false) - +
AudioNode MethodUsage
All 3D effects switched off. This sound is global and comes from everywhere. Good for environmental ambient sounds and background music.
setTimeOffset(0.5f)Start playing the sound after waiting the given amount of seconds. Default is 0.setTimeOffset(0.5f)Play the sound starting at a 0.5 second offset from the beginning. Default is 0.
setMaxDistance(100f)Maximum distance the sound can be heard, in world units. Default is 20.
-
+
@@ -103,7 +104,7 @@ setLocalTranslation(…)
AudioNode MethodUsage
Activates 3D audio: The sound appears to come f setReverbEnabled(true)A 3D echo effect that only makes sense to use with positional AudioNodes. The reverb effect is influenced by the environment that the audio renderer is in. See "Setting Environment Properties" below.
-
+
@@ -116,9 +117,9 @@ setDirection(…)
AudioNode MethodUsage
Activates 3D audio: This sound can only be heard from setOuterAngle()Set the angle in degrees for the directional audio. The angle is relative to the direction. Note: By default, both angles are 360° and the sound can be heard from all directions!
- +
- +

Play, Pause, Stop

@@ -140,7 +141,7 @@ You can also start playing an instance of this AudioNode. Use the playInstance() 
myAudioNode.playInstance();
- +

The Listener

@@ -156,7 +157,7 @@ The default listener object is the user's ear in the scene. If you use posi }
- +

Setting Environment Properties

@@ -185,7 +186,7 @@ Optionally, You can choose from the following environmental presets from c Closet 1.00f1.0f1.0f1.00f0.15f1.0f0.600f0.0025f0.500f0.0006f
- +

Activate the preset with setEnvironment(). E.g. in a dungeon environment: @@ -209,5 +210,5 @@ You can find more info about OpenAL and its advanced features here: - +

view online version

\ No newline at end of file diff --git a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/input_handling.html b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/input_handling.html index 51dbf7d30..07ff5532a 100644 --- a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/input_handling.html +++ b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/input_handling.html @@ -26,6 +26,17 @@ This is how you add interaction to your game: +

Code Samples

+
+
    +
  • +
    • +
  • +
    • +
+ +
+

1. Choose Trigger

@@ -125,14 +136,14 @@ JoyButtonTrigger(0, JoyInput.AXIS_POV_Y) ? Joystick Movement: Backward JoyAxisTrigger(0, JoyInput.AXIS_POV_Z, false)
- +

In your IDE, use code completion to quickly look up Trigger literals. In the jMonkeyEngine SDK for example, press ctrl-space or ctrl-/ after KeyInput.| to choose from the list of all keys.

- +

2. Remove Default Trigger Mappings

inputManager.deleteMapping( SimpleApplication.INPUT_MAPPING_MEMORY );
@@ -153,9 +164,9 @@ In your IDE, use code completion to quickly look up Trigger literals. In the jMo INPUT_MAPPING_EXITKEY_ESCAPECloses the application by calling stop();. Typically you do not remove this, unless you replace it by another way of quitting gracefully.
- + - +

3. Add Custom Trigger Mapping

@@ -181,7 +192,7 @@ inputManager.addMapping("Right", new KeyTrigger(KeyInput.KEY_D ...
- +

4. Create Listeners

@@ -195,7 +206,7 @@ The jME3 input manager supports two types of event listeners for inputs: AnalogL

- +

ActionListener

@@ -230,7 +241,7 @@ The jME3 input manager supports two types of event listeners for inputs: AnalogL };
- +

AnalogListener

@@ -263,7 +274,7 @@ The jME3 input manager supports two types of event listeners for inputs: AnalogL };
- +

4. Register Mappings to Listeners

@@ -292,7 +303,7 @@ As you see, you can add several listeners in one String array. You can call the

- +

5. Implement Actions in Listeners

@@ -312,7 +323,7 @@ Make use of the distinction between if and else if in
- +

ActionListener

@@ -333,7 +344,7 @@ In the most common case, you want an action to be triggered once, in the moment };
- +

AnalogListener

@@ -354,7 +365,7 @@ The following example shows how you define actions with an AnalogListener. Thies };
- +

Let Users Remap Keys

@@ -373,5 +384,5 @@ The abstraction of separating triggers and mappings has the advantage that you c
- +

view online version

\ No newline at end of file diff --git a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/loading_screen.html b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/loading_screen.html index b18b89de9..1cdc62859 100644 --- a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/loading_screen.html +++ b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/loading_screen.html @@ -143,15 +143,13 @@ If you do all of this in a single frame, then it is sent to the graphics card on

-The 3 main good solutions are: +The 2 main good solutions are:

  1. Updating explicitly over many frames
  2. Multi-threading
    3. -
  3. Using a custom AppState
    -
@@ -558,16 +556,6 @@ public class TestLoadingScreen1 extends SimpleApplication implements ScreenContr } } - - -

Using Appstates

-
- -

-TO DO - -

-

view online version

\ No newline at end of file diff --git a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/logging.html b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/logging.html index 7559787ba..4f5043046 100644 --- a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/logging.html +++ b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/logging.html @@ -4,7 +4,7 @@ -

Logging Like a Newb

+

Logging Like a Newbie

@@ -13,7 +13,7 @@ Many developers just use System.out.println() to print diagnostic strings to the

- +

Logging Like a Pro

@@ -67,7 +67,7 @@ More details about +

Switching the Logger on and off

@@ -95,5 +95,5 @@ To reactivate full logging, e.g. for debugging and testing: 
Logger.getLogger(””).setLevel(Level.FINE);
- +

view online version

\ No newline at end of file diff --git a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/monkey_zone.html b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/monkey_zone.html index aa0e8ebce..65fd74c14 100644 --- a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/monkey_zone.html +++ b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/monkey_zone.html @@ -325,7 +325,7 @@ MonkeyZone is hosted at GoogleCode, where you can check out the jMonkeyEngine Troubleshooting
    -
  1. After download error coud appear that in jme3tools.navmesh.util\NavMeshGenerator.java import com.jme3.terrain.Terrain is not known, you should correct this by setting Project Properties > Libraries > Add Library > jme3-libraries-terrain
    +
  2. After download, errors could appear because jme3tools.navmesh.util\NavMeshGenerator.java import com.jme3.terrain.Terrain is not known, you should correct this by setting Project Properties > Libraries > Add Library > jme3-libraries-terrain
diff --git a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_java_layout.html b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_java_layout.html index ed1513c8b..ee5e3538c 100644 --- a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_java_layout.html +++ b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_java_layout.html @@ -501,7 +501,7 @@ In the hud screen's foreground layer, add the fol }});

-Note that the width and height do not scale the bitmap font, but the make indirectly certain it is centered. If you want a different size for the font, you need to provide an extra bitmap font (they come with fixes sizes and don't scale well). +Note that the width and height do not scale the bitmap font, but make indirectly certain it is centered. If you want a different size for the font, you need to provide an extra bitmap font (they come with fixes sizes and don't scale well).

@@ -562,7 +562,7 @@ Nifty additionally offers many customizable controls such as check boxes, text f

- +

Intermediate Result

@@ -580,7 +580,7 @@ When you preview this code in the jMonkeyEngine +

Nifty Java Settings

@@ -608,7 +608,7 @@ Before initializing the nifty screens, you set up properties and register media. setDebugOptionPanelColors(true); Highlight all panels, makes it easier to arrange them.
- +

Example: @@ -616,7 +616,7 @@ Example: 

nifty.registerMouseCursor("hand", "Interface/mouse-cursor-hand.png", 5, 4);
- +

Next Steps

@@ -638,5 +638,5 @@ Integrate the GUI into the g
- +

view online version

\ No newline at end of file diff --git a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_scenarios.html b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_scenarios.html index 426334e18..c8d1f634b 100644 --- a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_scenarios.html +++ b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_scenarios.html @@ -260,7 +260,7 @@ You can name the method (here clicked) what ever you like, as long

The basic Nifty GUI example showed how to use the nifty.fromXML() method to load one XML file containing all Nifty GUI screens. -The following code sample shows how you can load several XML files into one nifty object. Loading several files with nifty.addXml() allows you to split up each screen into one XML file, insetad of all into one hard-to-read XML file. +The following code sample shows how you can load several XML files into one nifty object. Loading several files with nifty.addXml() allows you to split up each screen into one XML file, instead of all into one hard-to-read XML file. 

NiftyJmeDisplay niftyDisplay = new NiftyJmeDisplay(assetManager, inputManager, audioRenderer, viewPort);
 Nifty nifty = niftyDisplay.getNifty();
diff --git a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html
index 59593492e..14f4b6a6a 100644
--- a/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html
+++ b/sdk/jme3-core/javahelp/com/jme3/gde/core/docs/jme3/advanced/nifty_gui_xml_layout.html
@@ -62,7 +62,7 @@ The StartScreen contains:
 The HUD contains: