BetterCharacterControl
+ * You might want to try BetterCharacterControl as well.
* @author normenhansen
*/
-@Deprecated
public class CharacterControl extends PhysicsCharacter implements PhysicsControl {
protected Spatial spatial;
diff --git a/sdk/ant-jme/src/com/jme/ant/FixWikiLinks.java b/sdk/ant-jme/src/com/jme/ant/FixWikiLinks.java
index 24b7e55c7..a2de023ef 100644
--- a/sdk/ant-jme/src/com/jme/ant/FixWikiLinks.java
+++ b/sdk/ant-jme/src/com/jme/ant/FixWikiLinks.java
@@ -31,16 +31,16 @@ public class FixWikiLinks extends Task {
String line = rdr.readLine();
while (line != null) {
//internal links
- line = line.replaceAll("wiki/doku\\.php/([^>]*):([^>]*):([^>]*):([^>]*)\\?do=export_xhtmlbody", helpPath + "$1/$2/$3/$4.html");
- line = line.replaceAll("wiki/doku\\.php/([^>]*):([^>]*):([^>]*)\\?do=export_xhtmlbody", helpPath + "$1/$2/$3.html");
- line = line.replaceAll("wiki/doku\\.php/([^>]*):([^>]*)\\?do=export_xhtmlbody", helpPath + "$1/$2.html");
- line = line.replaceAll("wiki/doku\\.php/([^>]*)\\?do=export_xhtmlbody", helpPath + "$1.html");
+ line = line.replaceAll("doku\\.php/([^>]*):([^>]*):([^>]*):([^>]*)\\?do=export_xhtmlbody", helpPath + "$1/$2/$3/$4.html");
+ line = line.replaceAll("doku\\.php/([^>]*):([^>]*):([^>]*)\\?do=export_xhtmlbody", helpPath + "$1/$2/$3.html");
+ line = line.replaceAll("doku\\.php/([^>]*):([^>]*)\\?do=export_xhtmlbody", helpPath + "$1/$2.html");
+ line = line.replaceAll("doku\\.php/([^>]*)\\?do=export_xhtmlbody", helpPath + "$1.html");
//images
- line = line.replaceAll("/wiki/lib/exe/fetch\\.php/([^>]*):([^>]*):([^>]*):([^>]*)\"", "nbdocs:/" + helpPath + "$1/$2/$3/$4\"");
- line = line.replaceAll("/wiki/lib/exe/fetch\\.php/([^>]*):([^>]*):([^>]*)\"", "nbdocs:/" + helpPath + "$1/$2/$3\"");
- line = line.replaceAll("/wiki/lib/exe/fetch\\.php/([^>]*):([^>]*)\"", "nbdocs:/" + helpPath + "$1/$2\"");
- line = line.replaceAll("/wiki/lib/exe/fetch\\.php/([^>]*)\"", "nbdocs:/" + helpPath + "$1\"");
-// line = line.replaceAll("/wiki/lib/exe/fetch\\.php?([^>]*)\"", "nbdocs:/" + helpPath + "external/$1\"").replaceAll("[_[^\\w\\däüö:ÄÜÖ\\/\\+\\-\\. ]]", "_");
+ line = line.replaceAll("/lib/exe/fetch\\.php/([^>]*):([^>]*):([^>]*):([^>]*)\"", "nbdocs:/" + helpPath + "$1/$2/$3/$4\"");
+ line = line.replaceAll("/lib/exe/fetch\\.php/([^>]*):([^>]*):([^>]*)\"", "nbdocs:/" + helpPath + "$1/$2/$3\"");
+ line = line.replaceAll("/lib/exe/fetch\\.php/([^>]*):([^>]*)\"", "nbdocs:/" + helpPath + "$1/$2\"");
+ line = line.replaceAll("/lib/exe/fetch\\.php/([^>]*)\"", "nbdocs:/" + helpPath + "$1\"");
+// line = line.replaceAll("/lib/exe/fetch\\.php?([^>]*)\"", "nbdocs:/" + helpPath + "external/$1\"").replaceAll("[_[^\\w\\däüö:ÄÜÖ\\/\\+\\-\\. ]]", "_");
line = line.replaceAll("]*)>- Like Shapes, 3D models are also made up of Meshes, but models are more complex than Shapes. While Shapes are built into jME3, you typically create models in external 3D Mesh Editors.
- To use 3D models in a jME3 application:
assets directory.- To create 3D models and scenes, you need a 3D Mesh Editor such as , with an OgreXML Exporter plugin.
@@ -45,7 +42,6 @@ To create 3D models and scenes, you need a 3D Mesh Editor such as- In 3D games, you do not only load static 3D models, you also want to be able to trigger animations in the model from the Java code.
- JME3 only loads and plays animated models, it does not create them.
-What is required for an animated model? (See also: Animation terminology) +What is required for an animated model? (See also: Animation terminology)
-
Create one com.jme3.animation.AnimControl object in your JME3 application for each animated model that you want to control. You have to register each animated model to one of these Animation Controls. The control object gives you access to the available animation sequences in the model.
AnimControl playerControl; // you need one Control per model
@@ -101,16 +96,15 @@ Create one com.jme3.animation.AnimControl object in your JME3 appli
-
An Animation Control has several Animation Channels (com.jme3.animation.AnimChannel). Each channel can play one animation sequence at a time.
-There often are situations where you want to run several animation sequences at the same time, e.g. "shooting while walking" or "boxing while jumping". In this case, you create several channels, assign an animation to each, and play them in parallel. +There often are situations where you want to run several animation sequences at the same time, e.g. “shooting while walking” or “boxing while jumping”. In this case, you create several channels, assign an animation to each, and play them in parallel.
AnimChannel channel_walk = playerControl.createChannel();
AnimChannel channel_jump = playerControl.createChannel();
@@ -122,18 +116,18 @@ To reset a Control, call control.clearChannels();
- The following information is available for an AnimControl. -
| AnimControl Property | Usage |
|---|---|
| createChannel() | Returns a new channel, controlling all bones by default. | Adds or removes listeners to receive animation related |
| AnimControl Property | Usage | ||
|---|---|---|---|
| setAnimations(aniHashMap) | Sets the animations that this AnimControl is capable of playing. The animations must be compatible with the skeleton given in the constructor. | Adds or removes an animation from this Control. | getAnimationNames()A String Collection of names of all animations that this Control can play for this model. |
| getAnim("anim") | Retrieve an animation from the list of animations. | +getAnim(“anim”) | Retrieve an animation from the list of animations. |
| getAnimationLength("anim") | Returns the length of the given named animation in seconds | +getAnimationLength(“anim”) | Returns the length of the given named animation in seconds |
| AnimControl Property | Usage | ||
|---|---|---|---|
| getSkeleton() | The Skeleton object controlled by this Control. | Adds or removes an animation from this Control. | getTargets()The Skin objects controlled by this Control, as Mesh array. |
| getAttachmentsNode("bone") | Returns the attachment node of a bone. Attach models and effects to this node to make them follow this bone's motions. | +getAttachmentsNode(“bone”) | Returns the attachment node of a bone. Attach models and effects to this node to make them follow this bone's motions. |
- The following properties are set per AnimChannel. -
| AnimChannel Property | Usage |
|---|---|
| setLoopMode(LoopMode.Loop); | From now on, the animation on this channel will repeat from the beginning when it ends. |
- The following information is available for a channel. -
| AnimChannel Property | Usage |
|---|---|
| getAnimationName() | The name of the animation playing on this channel. Returns null when no animation is playing. |
- Use the following methods to add or remove individual bones to an AnimChannel. This is useful when you play two animations in parallel on two channels, and each controls a subset of the bones (e.g. one the arms, and the other the legs). -
| AnimChannel Methods | Usage | |
|---|---|---|
| addAllBones() | Add all the bones of the model's skeleton to be influenced by this animation channel. (default) | |
| addBone("bone1") + | addBone(“bone1”) addBone(bone1) | Add a single bone to be influenced by this animation channel. |
| addToRootBone("bone1") + | addToRootBone(“bone1”) addToRootBone(bone1) | Add a series of bones to be influenced by this animation channel: Add all bones, starting from the given bone, to the root bone. |
| addFromRootBone("bone1") + | addFromRootBone(“bone1”) addFromRootBone(bone1) | Add a series of bones to be influenced by this animation channel: Add all bones, starting from the given root bone, going towards the children bones. |
- Animations are played by channel. Note: Whether the animation channel plays continuously or only once, depends on the Loop properties you have set. -
| Channel Method | Usage | ||
|---|---|---|---|
| channel_walk.setAnim("Walk",0.50f); | Start the animation named "Walk" on channel channel_walk. + | channel_walk.setAnim(“Walk”,0.50f); | Start the animation named “Walk” on channel channel_walk. The float value specifies the time how long the animation should overlap with the previous one on this channel. If set to 0f, then no blending will occur and the new animation will be applied instantly. |
- Tip: Use the AnimEventLister below to react at the end or start of an animation cycle.
- -In this short example, we define the space key to trigger playing the "Walk" animation on channel2. +In this short example, we define the space key to trigger playing the “Walk” animation on channel2.
public void simpleInitApp() {
...
@@ -312,7 +308,7 @@ In this short example, we define the space key to trigger playing the "Walk
...
}
- private ActionListener actionListener = new ActionListener() {
+ private ActionListener() {
public void onAction(String name, boolean keyPressed, float tpf) {
if (name.equals("Walk") && !keyPressed) {
if (!channel2.getAnimationName().equals("Walk")) {
@@ -325,11 +321,10 @@ In this short example, we define the space key to trigger playing the "Walk
-
A jME3 application that contains animations can implement the com.jme3.animation.AnimEventListener interface.
public class HelloAnimation extends SimpleApplication @@ -341,11 +336,10 @@ This optional Listener enables you to respond to animation start and end events,
- The onAnimCycleDone() event is invoked when an animation cycle has ended. For non-looping animations, this event is invoked when the animation is finished playing. For looping animations, this event is invoked each time the animation loop is restarted.
@@ -370,11 +364,10 @@ You have access to the following objects:
-
The onAnimChange() event is invoked every time before an animation is set by the user to be played on a given channel (channel.setAnim()).
-
The com.jme3.app.state.AppState class is a customizable jME3 interface that allows you to control the global game logic, the overall game mechanics. (To control the behaviour of a Spatial, see Custom Controls instead. Controls and AppStates can be used together.)
- There are situations during your game development where you think:
- You can! This is what AppStates are there for. An AppState class is subset of (or an extension to) your application. Every AppState class has access to all fields in your main application (AssetManager, ViewPort, StateManager, InputManager, RootNode, GuiNode, etc) and hooks into the main update loop. An AppState can contain:
- Each AppState lets you define what happens to it in the following situations:
!isEnabled(), and write code that skips the running sections of this AppState's update() loop. - -
- To implement game logic:
- When you add several AppStates to one Application and activate them, their initialize() methods and update() loops are executed in the order in which the AppStates were added to the AppStateManager.
- JME3 comes with a BulletAppState that implements Physical behaviour (using the jBullet library). You, for example, could write an Artificial Intelligence AppState to control all your enemy units. Existing examples in the code base include:
- The AppState interface lets you initialize sets of objects, and hook a set of continously executing code into the main loop. -
| AppState Method | Usage | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| initialize(asm,app) | When this AppState is added to the game, the RenderThread initializes the AppState and then calls this method. You can modify the scene graph from here (e.g. attach nodes). To get access to the main app, call: super.initialize(stateManager, app); this.app = (SimpleApplication) app;@@ -187,17 +179,15 @@ stateDetached(asm) | The AppState knows when it is attached to, or detache
-AbstractAppState+AbstractAppState
-
The AbstractAppState class already implements some common methods ( Definition: - public class MyAppState extends AbstractAppState {
@@ -250,28 +240,27 @@ Definition:
Pausing and Unpausing+Pausing and Unpausing
-
You define what an AppState does when Paused or Unpaused, in the AppStateManager+AppStateManager- The com.jme3.app.state.AppStateManager holds the list of AppStates for an application. AppStateManager ensures that active AppStates can modify the scene graph, and that the update() loops of active AppStates is executed. There is one AppStateManager per application. You typically attach several AppStates to one AppStateManager, but the same state can only be attached once. -
-
The AppStateManager's
Best Practices+Best PracticesCommunication Among AppStates+Communication Among AppStates- You can only access other AppStates (read from and write to them) from certain places: From a Control's update() method, from an AppState's update() method, and from the SimpleApplication's simpleUpdate() loop. Don't mess with the AppState from other places, because from other methods you have no control over the order of modifications; the game can go out of sync because you can't know when (during which half-finished step of another state change) your modification will be performed. You can use custom accessors to get data from AppStates, to set data in AppStates, or to trigger methods in AppStates. - this.app.getStateManager().getState(MyAppState.class).doSomeCustomStuffInThisState(); Initialize Familiar Class Fields+Initialize Familiar Class Fields- To access class fields of the SimpleApplication the way you are used to, initialize them to local variables, as shown in the following AppState template: private SimpleApplication app;
@@ -352,4 +336,4 @@ public class MyAppState extends AbstractAppState {
Simple AppStates Demo+Simple AppStates Demo-
THIS DEMO IS OUT OF DATE AND NEEDS CORRECTING
-
THIS DEMO IS OUT OF DATE AND NEEDS CORRECTING FOR NOW PLEASE SEE+THIS DEMO IS OUT OF DATE AND NEEDS CORRECTING FOR NOW PLEASE SEE@@ -21,7 +19,7 @@ THIS DEMO IS OUT OF DATE AND NEEDS CORRECTING -Note: this tutorial needs to be fixed and is currently not correct. One should almost never override stateDetached and stateAttached??? and should certainly never do anything scene related in them. +Note: this tutorial needs to be fixed and is currently not correct. One should almost never override stateDetached and stateAttached… and should certainly never do anything scene related in them. @@ -30,12 +28,11 @@ This demo is a simple example of how you use AppStates to toggle between a Start There are four files, Main.java, GameRunningState.java, StartScreenState.java, SettingsScreenState.java. - Main.java+Main.javapackage chapter04.appstatedemo;
@@ -94,7 +91,7 @@ public class Main extends SimpleApplication {
inputManager.addListener(actionListener, new String[]{"Toggle Settings"});
}
- private ActionListener actionListener = new ActionListener() {
+ private ActionListener() {
public void onAction(String name, boolean isPressed, float tpf) {
System.out.println("key" + name);
if (name.equals("Game Pause Unpause") && !isPressed) {
@@ -131,7 +128,7 @@ public class Main extends SimpleApplication {
GameRunningState.java+GameRunningState.javapackage chapter04.appstatedemo;
@@ -178,7 +175,7 @@ public class GameRunningState extends AbstractAppState {
/** Load this scene */
viewPort.setBackgroundColor(backgroundColor);
- Box mesh = new Box(Vector3f.ZERO, 1, 1, 1);
+ Box(Vector3f.ZERO, 1, 1, 1);
Geometry geom = new Geometry("Box", mesh);
Material mat = new Material(assetManager,
"Common/MatDefs/Misc/Unshaded.j3md");
@@ -223,7 +220,7 @@ public class GameRunningState extends AbstractAppState {
SettingsScreenState.java+SettingsScreenState.javapackage chapter04.appstatedemo;
@@ -270,7 +267,7 @@ public class SettingsScreenState extends AbstractAppState {
/** Load this scene */
viewPort.setBackgroundColor(backgroundColor);
- Box mesh = new Box(new Vector3f(-1, -1, 0), .5f, .5f, .5f);
+ Box(new Vector3f(-1, -1, 0), .5f, .5f, .5f);
Geometry geom = new Geometry("Box", mesh);
Material mat = new Material(assetManager,
"Common/MatDefs/Misc/Unshaded.j3md");
@@ -312,7 +309,7 @@ public class SettingsScreenState extends AbstractAppState {
StartScreenState.java+StartScreenState.javapackage chapter04.appstatedemo;
@@ -359,7 +356,7 @@ public StartScreenState(SimpleApplication app){
/** Init this scene */
viewPort.setBackgroundColor(backgroundColor);
- Box mesh = new Box(new Vector3f(-1,1,0), .5f,.5f,.5f);
+ Box(new Vector3f(-1,1,0), .5f,.5f,.5f);
Geometry geom = new Geometry("Box", mesh);
Material mat = new Material(assetManager,
"Common/MatDefs/Misc/Unshaded.j3md");
@@ -401,4 +398,4 @@ public StartScreenState(SimpleApplication app){
AssetManager+AssetManager
-
By assets we mean multi-media files, such as 3D models, materials, textures, scenes, custom shaders, music and sound files, and custom fonts. JME3 has an integrated asset manager that helps you keep your project assets organized. Think of the asset manager as the filesystem of your game, independent of the actual deployment platform. By default, store your assets in the - Advanced users can write a custom build and packaging script, and can register custom paths to the AssetManager, but this is up to you then. Context+ContextjMonkeyProjects/MyGame/assets/ # You store assets in subfolders here! <------ jMonkeyProjects/MyGame/build/ # SDK generates built classes here (*) @@ -44,11 +42,10 @@ See also Best Usage+Usage
-
The
-This Material is "somewhere" in the jME3 JAR; the default Asset Manager is configured to handle a @@ -72,16 +69,15 @@ Additionally, you can configure the Asset Manager and add any path to its root. Asset Directory+Asset Directory
-
By default, jME3 searches for models in a directory named - In Java projects created with the jMonkeyEngine SDK, an assets folder is created by default in your project directory. If you are using any other IDE, or the command line, you simply create an assets directory manually (see the Codeless Project tip below).
+In Java projects created with the jMonkeyEngine SDK, an
@@ -104,7 +100,7 @@ These subdirectories are just the most common examples.
assets folder is created by default in your project directory. If you are using any other IDE, or the command line, you simply create an assets directory manually (see the Codeless Project tip below).
- You can rename/delete/add (sub)directories inside the assets directory in any way you like. Note however that there is no automatic refactoring for asset paths in the SDK, so if you modify them late in the development process, you have to refactor all paths manually.
+You can rename/delete/add (sub)directories inside the
@@ -120,39 +116,33 @@ After the conversion, you move the .j3o file into the assets directory in any way you like. Note however that there is no automatic refactoring for asset paths in the SDK, so if you modify them late in the development process, you have to refactor all paths manually.
assets/Models/
-Example Code: Loading Assets+Example Code: Loading Assets- -Creating a material instance with the definition "Unshaded.j3md": - +Creating a material instance with the definition “Unshaded.j3md”: Material mat_brick = new Material(
assetManager, "Common/MatDefs/Misc/Unshaded.j3md");
Applying a texture to the material: - mat_brick.setTexture("ColorMap",
assetManager.loadTexture("Textures/Terrain/BrickWall/BrickWall.jpg"));
Loading a font: - guiFont = assetManager.loadFont("Interface/Fonts/Default.fnt");
Loading a model: - Spatial ninja = assetManager.loadModel("Models/Ninja/Ninja.mesh.xml");
Loading a scene from an Ogre3D dotScene file stored inside a zip: - assetManager.registerLocator("town.zip", ZipLocator.class);
Spatial scene = assetManager.loadModel("main.scene");
@@ -171,18 +161,20 @@ jME3 also offers a ClasspathLocator, ZipLocator, FileLocator, HttpZipLocator, an
|