- * for more details see {@link #setExposureCutOff(float exposureCutOff)} - * @return - */ - public float getExposureCutOff() { - return exposureCutOff; - } - - /** - * Define the color threshold on which the bloom will be applied (0.0 to 1.0) - * @param exposureCutOff - */ - public void setExposureCutOff(float exposureCutOff) { - this.exposureCutOff = exposureCutOff; - } - - /** - * returns the exposure power
- * form more details see {@link #setExposurePower(float exposurePower)} - * @return - */ - public float getExposurePower() { - return exposurePower; - } - - /** - * defines how many time the bloom extracted color will be multiplied by itself. default id 5.0
- * a high value will reduce rough edges in the bloom and somhow the range of the bloom area * - * @param exposurePower - */ - public void setExposurePower(float exposurePower) { - this.exposurePower = exposurePower; - } - - /** - * returns the downSampling factor
- * form more details see {@link #setDownSamplingFactor(float downSamplingFactor)} - * @return - */ - public float getDownSamplingFactor() { - return downSamplingFactor; - } - - /** - * Sets the downSampling factor : the size of the computed texture will be divided by this factor. default is 1 for no downsampling - * A 2 value is a good way of widening the blur - * @param downSamplingFactor - */ - public void setDownSamplingFactor(float downSamplingFactor) { - this.downSamplingFactor = downSamplingFactor; - } - - @Override - public void write(JmeExporter ex) throws IOException { - super.write(ex); - OutputCapsule oc = ex.getCapsule(this); - oc.write(glowMode, "glowMode", GlowMode.Scene); - oc.write(blurScale, "blurScale", 1.5f); - oc.write(exposurePower, "exposurePower", 5.0f); - oc.write(exposureCutOff, "exposureCutOff", 0.0f); - oc.write(bloomIntensity, "bloomIntensity", 2.0f); - oc.write(downSamplingFactor, "downSamplingFactor", 1); - } - - @Override - public void read(JmeImporter im) throws IOException { - super.read(im); - InputCapsule ic = im.getCapsule(this); - glowMode = ic.readEnum("glowMode", GlowMode.class, GlowMode.Scene); - blurScale = ic.readFloat("blurScale", 1.5f); - exposurePower = ic.readFloat("exposurePower", 5.0f); - exposureCutOff = ic.readFloat("exposureCutOff", 0.0f); - bloomIntensity = ic.readFloat("bloomIntensity", 2.0f); - downSamplingFactor = ic.readFloat("downSamplingFactor", 1); - } -} +/* + * Copyright (c) 2009-2012 jMonkeyEngine + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * * Neither the name of 'jMonkeyEngine' nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package com.jme3.post.filters; + +import com.jme3.asset.AssetManager; +import com.jme3.export.InputCapsule; +import com.jme3.export.JmeExporter; +import com.jme3.export.JmeImporter; +import com.jme3.export.OutputCapsule; +import com.jme3.material.Material; +import com.jme3.math.ColorRGBA; +import com.jme3.post.Filter; +import com.jme3.renderer.RenderManager; +import com.jme3.renderer.ViewPort; +import com.jme3.renderer.queue.RenderQueue; +import com.jme3.texture.Image.Format; +import java.io.IOException; +import java.util.ArrayList; + +/** + * BloomFilter is used to make objects in the scene have a glow effect.
+ * There are 2 mode : Scene and Objects.
+ * Scene mode extracts the bright parts of the scene to make them glow
+ * Object mode make objects glow according to their material's glowMap or their GlowColor
+ * @see advanced:bloom_and_glow for more details + * + * @author Rémy Bouquet aka Nehon + */ +public class BloomFilter extends Filter { + + /** + * GlowMode specifies if the glow will be applied to the whole scene,or to objects that have aglow color or a glow map + */ + public enum GlowMode { + + /** + * Apply bloom filter to bright areas in the scene. + */ + Scene, + /** + * Apply bloom only to objects that have a glow map or a glow color. + */ + Objects, + /** + * Apply bloom to both bright parts of the scene and objects with glow map. + */ + SceneAndObjects; + } + + private GlowMode glowMode = GlowMode.Scene; + //Bloom parameters + private float blurScale = 1.5f; + private float exposurePower = 5.0f; + private float exposureCutOff = 0.0f; + private float bloomIntensity = 2.0f; + private float downSamplingFactor = 1; + private Pass preGlowPass; + private Pass extractPass; + private Pass horizontalBlur = new Pass(); + private Pass verticalalBlur = new Pass(); + private Material extractMat; + private Material vBlurMat; + private Material hBlurMat; + private int screenWidth; + private int screenHeight; + private RenderManager renderManager; + private ViewPort viewPort; + + private AssetManager assetManager; + private int initalWidth; + private int initalHeight; + + /** + * Creates a Bloom filter + */ + public BloomFilter() { + super("BloomFilter"); + } + + /** + * Creates the bloom filter with the specific glow mode + * @param glowMode + */ + public BloomFilter(GlowMode glowMode) { + this(); + this.glowMode = glowMode; + } + + @Override + protected void initFilter(AssetManager manager, RenderManager renderManager, ViewPort vp, int w, int h) { + this.renderManager = renderManager; + this.viewPort = vp; + + this.assetManager = manager; + this.initalWidth = w; + this.initalHeight = h; + + screenWidth = (int) Math.max(1, (w / downSamplingFactor)); + screenHeight = (int) Math.max(1, (h / downSamplingFactor)); + // System.out.println(screenWidth + " " + screenHeight); + if (glowMode != GlowMode.Scene) { + preGlowPass = new Pass(); + preGlowPass.init(renderManager.getRenderer(), screenWidth, screenHeight, Format.RGBA8, Format.Depth); + } + + postRenderPasses = new ArrayList
+ * for more details see {@link #setExposureCutOff(float exposureCutOff)} + * @return + */ + public float getExposureCutOff() { + return exposureCutOff; + } + + /** + * Define the color threshold on which the bloom will be applied (0.0 to 1.0) + * @param exposureCutOff + */ + public void setExposureCutOff(float exposureCutOff) { + this.exposureCutOff = exposureCutOff; + } + + /** + * returns the exposure power
+ * form more details see {@link #setExposurePower(float exposurePower)} + * @return + */ + public float getExposurePower() { + return exposurePower; + } + + /** + * defines how many time the bloom extracted color will be multiplied by itself. default id 5.0
+ * a high value will reduce rough edges in the bloom and somhow the range of the bloom area * + * @param exposurePower + */ + public void setExposurePower(float exposurePower) { + this.exposurePower = exposurePower; + } + + /** + * returns the downSampling factor
+ * form more details see {@link #setDownSamplingFactor(float downSamplingFactor)} + * @return + */ + public float getDownSamplingFactor() { + return downSamplingFactor; + } + + /** + * Sets the downSampling factor : the size of the computed texture will be divided by this factor. default is 1 for no downsampling + * A 2 value is a good way of widening the blur + * @param downSamplingFactor + */ + public void setDownSamplingFactor(float downSamplingFactor) { + this.downSamplingFactor = downSamplingFactor; + if (assetManager != null) // dirty isInitialised check + reInitFilter(); + } + + @Override + public void write(JmeExporter ex) throws IOException { + super.write(ex); + OutputCapsule oc = ex.getCapsule(this); + oc.write(glowMode, "glowMode", GlowMode.Scene); + oc.write(blurScale, "blurScale", 1.5f); + oc.write(exposurePower, "exposurePower", 5.0f); + oc.write(exposureCutOff, "exposureCutOff", 0.0f); + oc.write(bloomIntensity, "bloomIntensity", 2.0f); + oc.write(downSamplingFactor, "downSamplingFactor", 1); + } + + @Override + public void read(JmeImporter im) throws IOException { + super.read(im); + InputCapsule ic = im.getCapsule(this); + glowMode = ic.readEnum("glowMode", GlowMode.class, GlowMode.Scene); + blurScale = ic.readFloat("blurScale", 1.5f); + exposurePower = ic.readFloat("exposurePower", 5.0f); + exposureCutOff = ic.readFloat("exposureCutOff", 0.0f); + bloomIntensity = ic.readFloat("bloomIntensity", 2.0f); + downSamplingFactor = ic.readFloat("downSamplingFactor", 1); + } +} diff --git a/engine/src/core-effects/com/jme3/post/filters/LightScatteringFilter.java b/engine/src/core-effects/com/jme3/post/filters/LightScatteringFilter.java index 20e5e3397..271358454 100644 --- a/engine/src/core-effects/com/jme3/post/filters/LightScatteringFilter.java +++ b/engine/src/core-effects/com/jme3/post/filters/LightScatteringFilter.java @@ -37,6 +37,7 @@ import com.jme3.export.JmeExporter; import com.jme3.export.JmeImporter; import com.jme3.export.OutputCapsule; import com.jme3.material.Material; +import com.jme3.math.FastMath; import com.jme3.math.Vector3f; import com.jme3.post.Filter; import com.jme3.renderer.Camera; @@ -102,7 +103,9 @@ public class LightScatteringFilter extends Filter { getClipCoordinates(lightPosition, screenLightPos, viewPort.getCamera()); viewPort.getCamera().getViewMatrix().mult(lightPosition, viewLightPos); if (adaptative) { - innerLightDensity = Math.max(lightDensity - Math.max(screenLightPos.x, screenLightPos.y), 0.0f); + float densityX = 1f - FastMath.clamp(FastMath.abs(screenLightPos.x - 0.5f), 0, 1); + float densityY = 1f - FastMath.clamp(FastMath.abs(screenLightPos.y - 0.5f), 0, 1); + innerLightDensity = lightDensity * densityX * densityY; } else { innerLightDensity = lightDensity; } diff --git a/engine/src/core-effects/com/jme3/water/SimpleWaterProcessor.java b/engine/src/core-effects/com/jme3/water/SimpleWaterProcessor.java index 1177fc266..51bec6a8b 100644 --- a/engine/src/core-effects/com/jme3/water/SimpleWaterProcessor.java +++ b/engine/src/core-effects/com/jme3/water/SimpleWaterProcessor.java @@ -48,6 +48,7 @@ import com.jme3.texture.Image.Format; import com.jme3.texture.Texture.WrapMode; import com.jme3.texture.Texture2D; import com.jme3.ui.Picture; +import com.jme3.util.TempVars; /** * @@ -119,15 +120,12 @@ public class SimpleWaterProcessor implements SceneProcessor { private Plane reflectionClipPlane; private Plane refractionClipPlane; private float refractionClippingOffset = 0.3f; - private float reflectionClippingOffset = -5f; - private Vector3f vect1 = new Vector3f(); - private Vector3f vect2 = new Vector3f(); - private Vector3f vect3 = new Vector3f(); + private float reflectionClippingOffset = -5f; private float distortionScale = 0.2f; private float distortionMix = 0.5f; private float texScale = 1f; - + /** * Creates a SimpleWaterProcessor * @param manager the asset manager @@ -190,10 +188,6 @@ public class SimpleWaterProcessor implements SceneProcessor { public void postQueue(RenderQueue rq) { Camera sceneCam = rm.getCurrentCamera(); - //update ray - ray.setOrigin(sceneCam.getLocation()); - ray.setDirection(sceneCam.getDirection()); - //update refraction cam refractionCam.setLocation(sceneCam.getLocation()); refractionCam.setRotation(sceneCam.getRotation()); @@ -203,40 +197,11 @@ public class SimpleWaterProcessor implements SceneProcessor { sceneCam.getFrustumRight(), sceneCam.getFrustumTop(), sceneCam.getFrustumBottom()); - refractionCam.setParallelProjection(false); + refractionCam.setParallelProjection(sceneCam.isParallelProjection()); //update reflection cam - boolean inv = false; - if (!ray.intersectsWherePlane(plane, targetLocation)) { - ray.setDirection(ray.getDirection().negateLocal()); - ray.intersectsWherePlane(plane, targetLocation); - inv = true; - } - Vector3f loc = plane.reflect(sceneCam.getLocation(), new Vector3f()); - reflectionCam.setLocation(loc); - reflectionCam.setFrustum(sceneCam.getFrustumNear(), - sceneCam.getFrustumFar(), - sceneCam.getFrustumLeft(), - sceneCam.getFrustumRight(), - sceneCam.getFrustumTop(), - sceneCam.getFrustumBottom()); - reflectionCam.setParallelProjection(false); - // tempVec and calcVect are just temporary vector3f objects - vect1.set(sceneCam.getLocation()).addLocal(sceneCam.getUp()); - float planeDistance = plane.pseudoDistance(vect1); - vect2.set(plane.getNormal()).multLocal(planeDistance * 2.0f); - vect3.set(vect1.subtractLocal(vect2)).subtractLocal(loc).normalizeLocal().negateLocal(); - // now set the up vector - reflectionCam.lookAt(targetLocation, vect3); - if (inv) { - reflectionCam.setAxes(reflectionCam.getLeft().negateLocal(), reflectionCam.getUp(), reflectionCam.getDirection().negateLocal()); - } - - //we are rendering a sub part of the scene so the camera planeState may never be reseted to 0. -// reflectionCam.setPlaneState(0); -// refractionCam.setPlaneState(0); - - + WaterUtils.updateReflectionCam(reflectionCam, plane, sceneCam); + //Rendering reflection and refraction rm.renderViewPort(reflectionView, savedTpf); rm.renderViewPort(refractionView, savedTpf); diff --git a/engine/src/core-effects/com/jme3/water/WaterFilter.java b/engine/src/core-effects/com/jme3/water/WaterFilter.java index 10749cc99..e62e1fbf4 100644 --- a/engine/src/core-effects/com/jme3/water/WaterFilter.java +++ b/engine/src/core-effects/com/jme3/water/WaterFilter.java @@ -155,40 +155,11 @@ public class WaterFilter extends Filter { material.setFloat("WaterHeight", waterHeight); - //update reflection cam - ray.setOrigin(sceneCam.getLocation()); - ray.setDirection(sceneCam.getDirection()); + //update reflection cam plane = new Plane(Vector3f.UNIT_Y, new Vector3f(0, waterHeight, 0).dot(Vector3f.UNIT_Y)); - reflectionProcessor.setReflectionClipPlane(plane); - boolean inv = false; - if (!ray.intersectsWherePlane(plane, targetLocation)) { - ray.setDirection(ray.getDirection().negateLocal()); - ray.intersectsWherePlane(plane, targetLocation); - inv = true; - } - Vector3f loc = plane.reflect(sceneCam.getLocation(), new Vector3f()); - reflectionCam.setLocation(loc); - reflectionCam.setFrustum(sceneCam.getFrustumNear(), - sceneCam.getFrustumFar(), - sceneCam.getFrustumLeft(), - sceneCam.getFrustumRight(), - sceneCam.getFrustumTop(), - sceneCam.getFrustumBottom()); - reflectionCam.setParallelProjection(false); - TempVars vars = TempVars.get(); - - - vars.vect1.set(sceneCam.getLocation()).addLocal(sceneCam.getUp()); - float planeDistance = plane.pseudoDistance(vars.vect1); - vars.vect2.set(plane.getNormal()).multLocal(planeDistance * 2.0f); - vars.vect3.set(vars.vect1.subtractLocal(vars.vect2)).subtractLocal(loc).normalizeLocal().negateLocal(); - - reflectionCam.lookAt(targetLocation, vars.vect3); - vars.release(); - - if (inv) { - reflectionCam.setAxes(reflectionCam.getLeft().negateLocal(), reflectionCam.getUp(), reflectionCam.getDirection().negateLocal()); - } + reflectionProcessor.setReflectionClipPlane(plane); + WaterUtils.updateReflectionCam(reflectionCam, plane, sceneCam); + //if we're under water no need to compute reflection if (sceneCam.getLocation().y >= waterHeight) { @@ -1026,7 +997,7 @@ public class WaterFilter extends Filter { public void setReflectionDisplace(float reflectionDisplace) { this.reflectionDisplace = reflectionDisplace; if (material != null) { - material.setFloat("m_ReflectionDisplace", reflectionDisplace); + material.setFloat("ReflectionDisplace", reflectionDisplace); } } diff --git a/engine/src/core-effects/com/jme3/water/WaterUtils.java b/engine/src/core-effects/com/jme3/water/WaterUtils.java new file mode 100644 index 000000000..f232a6512 --- /dev/null +++ b/engine/src/core-effects/com/jme3/water/WaterUtils.java @@ -0,0 +1,53 @@ +/* + * To change this template, choose Tools | Templates + * and open the template in the editor. + */ +package com.jme3.water; + +import com.jme3.math.Plane; +import com.jme3.math.Vector3f; +import com.jme3.renderer.Camera; +import com.jme3.util.TempVars; + +/** + * + * @author Nehon + */ +public class WaterUtils { + + public static void updateReflectionCam(Camera reflectionCam, Plane plane, Camera sceneCam){ + + TempVars vars = TempVars.get(); + //Temp vects for reflection cam orientation calculation + Vector3f sceneTarget = vars.vect1; + Vector3f reflectDirection = vars.vect2; + Vector3f reflectUp = vars.vect3; + Vector3f reflectLeft = vars.vect4; + Vector3f camLoc = vars.vect5; + camLoc = plane.reflect(sceneCam.getLocation(), camLoc); + reflectionCam.setLocation(camLoc); + reflectionCam.setFrustum(sceneCam.getFrustumNear(), + sceneCam.getFrustumFar(), + sceneCam.getFrustumLeft(), + sceneCam.getFrustumRight(), + sceneCam.getFrustumTop(), + sceneCam.getFrustumBottom()); + reflectionCam.setParallelProjection(sceneCam.isParallelProjection()); + + sceneTarget.set(sceneCam.getLocation()).addLocal(sceneCam.getDirection()); + reflectDirection = plane.reflect(sceneTarget, reflectDirection); + reflectDirection.subtractLocal(camLoc); + + sceneTarget.set(sceneCam.getLocation()).subtractLocal(sceneCam.getUp()); + reflectUp = plane.reflect(sceneTarget, reflectUp); + reflectUp.subtractLocal(camLoc); + + sceneTarget.set(sceneCam.getLocation()).addLocal(sceneCam.getLeft()); + reflectLeft = plane.reflect(sceneTarget, reflectLeft); + reflectLeft.subtractLocal(camLoc); + + reflectionCam.setAxes(reflectLeft, reflectUp, reflectDirection); + + vars.release(); + } +} diff --git a/engine/src/core-plugins/com/jme3/export/binary/BinaryExporter.java b/engine/src/core-plugins/com/jme3/export/binary/BinaryExporter.java index 215b09e1a..c02f7088a 100644 --- a/engine/src/core-plugins/com/jme3/export/binary/BinaryExporter.java +++ b/engine/src/core-plugins/com/jme3/export/binary/BinaryExporter.java @@ -327,14 +327,18 @@ public class BinaryExporter implements JmeExporter { public boolean save(Savable object, File f) throws IOException { File parentDirectory = f.getParentFile(); - if(parentDirectory != null && !parentDirectory.exists()) { + if (parentDirectory != null && !parentDirectory.exists()) { parentDirectory.mkdirs(); } FileOutputStream fos = new FileOutputStream(f); - boolean rVal = save(object, fos); - fos.close(); - return rVal; + try { + return save(object, fos); + } finally { + if (fos != null) { + fos.close(); + } + } } public BinaryOutputCapsule getCapsule(Savable object) { diff --git a/engine/src/core-plugins/com/jme3/export/binary/BinaryImporter.java b/engine/src/core-plugins/com/jme3/export/binary/BinaryImporter.java index 47ea18e6b..933bee721 100644 --- a/engine/src/core-plugins/com/jme3/export/binary/BinaryImporter.java +++ b/engine/src/core-plugins/com/jme3/export/binary/BinaryImporter.java @@ -267,9 +267,13 @@ public final class BinaryImporter implements JmeImporter { public Savable load(File f, ReadListener listener) throws IOException { FileInputStream fis = new FileInputStream(f); - Savable rVal = load(fis, listener); - fis.close(); - return rVal; + try { + return load(fis, listener); + } finally { + if (fis != null) { + fis.close(); + } + } } public Savable load(byte[] data) throws IOException { diff --git a/engine/src/core/com/jme3/animation/AnimChannel.java b/engine/src/core/com/jme3/animation/AnimChannel.java index 7c79bae22..6a74b1864 100644 --- a/engine/src/core/com/jme3/animation/AnimChannel.java +++ b/engine/src/core/com/jme3/animation/AnimChannel.java @@ -59,6 +59,7 @@ public final class AnimChannel { private float time; private float speed; private float timeBlendFrom; + private float blendTime; private float speedBlendFrom; private boolean notified=false; @@ -192,6 +193,11 @@ public final class AnimChannel { */ public void setSpeed(float speed) { this.speed = speed; + if(blendTime>0){ + this.speedBlendFrom = speed; + blendTime = Math.min(blendTime, animation.getLength() / speed); + blendRate = 1/ blendTime; + } } /** @@ -248,7 +254,9 @@ public final class AnimChannel { control.notifyAnimChange(this, name); if (animation != null && blendTime > 0f){ + this.blendTime = blendTime; // activate blending + blendTime = Math.min(blendTime, anim.getLength() / speed); blendFrom = animation; timeBlendFrom = time; speedBlendFrom = speed; @@ -393,8 +401,7 @@ public final class AnimChannel { } animation.setTime(time, blendAmount, control, this, vars); - time += tpf * speed; - + if (animation.getLength() > 0){ if (!notified && (time >= animation.getLength() || time < 0)) { if (loopMode == LoopMode.DontLoop) { @@ -406,7 +413,7 @@ public final class AnimChannel { control.notifyAnimCycleDone(this, animation.getName()); } } - + time += tpf * speed; time = clampWrapTime(time, animation.getLength(), loopMode); if (time < 0){ // Negative time indicates that speed should be inverted diff --git a/engine/src/core/com/jme3/app/FlyCamAppState.java b/engine/src/core/com/jme3/app/FlyCamAppState.java index 5a7b11e95..11d3e3fa2 100644 --- a/engine/src/core/com/jme3/app/FlyCamAppState.java +++ b/engine/src/core/com/jme3/app/FlyCamAppState.java @@ -87,7 +87,9 @@ public class FlyCamAppState extends AbstractAppState { public void cleanup() { super.cleanup(); - flyCam.unregisterInput(); + if (app.getInputManager() != null) { + flyCam.unregisterInput(); + } } diff --git a/engine/src/core/com/jme3/app/StatsAppState.java b/engine/src/core/com/jme3/app/StatsAppState.java index 3225c5798..346733257 100644 --- a/engine/src/core/com/jme3/app/StatsAppState.java +++ b/engine/src/core/com/jme3/app/StatsAppState.java @@ -81,7 +81,7 @@ public class StatsAppState extends AbstractAppState { * is because several applications expect to directly access * fpsText... unfortunately. */ - void setFont( BitmapFont guiFont ) { + public void setFont( BitmapFont guiFont ) { this.guiFont = guiFont; this.fpsText = new BitmapText(guiFont, false); } diff --git a/engine/src/core/com/jme3/audio/AudioNode.java b/engine/src/core/com/jme3/audio/AudioNode.java index 5ee74dbd5..0e75db9fe 100644 --- a/engine/src/core/com/jme3/audio/AudioNode.java +++ b/engine/src/core/com/jme3/audio/AudioNode.java @@ -45,15 +45,18 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * An
AudioNode is used in jME3 for playing audio files.
- * - * First, an {@link AudioNode} is loaded from file, and then assigned - * to an audio node for playback. Once the audio node is attached to the - * scene, its location will influence the position it is playing from relative - * to the {@link Listener}. - *
- * An audio node can also play in "headspace", meaning its location - * or velocity does not influence how it is played. + * An
AudioNode is a scene Node which can play audio assets.
+ *
+ * An AudioNode is either positional or ambient, with positional being the
+ * default. Once a positional node is attached to the scene, its location and
+ * velocity relative to the {@link Listener} affect how it sounds when played.
+ * Positional nodes can only play monoaural (single-channel) assets, not stereo
+ * ones.
+ *
+ * An ambient AudioNode plays in "headspace", meaning that the node's location
+ * and velocity do not affect how it sounds when played. Ambient audio nodes can
+ * play stereo assets.
+ *
* The "positional" property of an AudioNode can be set via
* {@link AudioNode#setPositional(boolean) }.
*
diff --git a/engine/src/core/com/jme3/bounding/BoundingBox.java b/engine/src/core/com/jme3/bounding/BoundingBox.java
index 5cf7d83a6..4768b3db8 100644
--- a/engine/src/core/com/jme3/bounding/BoundingBox.java
+++ b/engine/src/core/com/jme3/bounding/BoundingBox.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2013 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -47,31 +47,40 @@ import java.nio.FloatBuffer;
//import com.jme.scene.TriMesh;
/**
- * BoundingBox defines an axis-aligned cube that defines a
- * container for a group of vertices of a particular piece of geometry. This box
- * defines a center and extents from that center along the x, y and z axis. + *
BoundingBox describes a bounding volume as an axis-aligned box.
* - * A typical usage is to allow the class define the center and radius by calling - * either
containAABB or averagePoints. A call to
- * computeFramePoint in turn calls containAABB.
- *
+ * Instances may be initialized by invoking the containAABB method.
+ *
* @author Joshua Slack
* @version $Id: BoundingBox.java,v 1.50 2007/09/22 16:46:35 irrisor Exp $
*/
public class BoundingBox extends BoundingVolume {
-
- float xExtent, yExtent, zExtent;
-
/**
- * Default constructor instantiates a new BoundingBox
- * object.
+ * the X-extent of the box (>=0, may be +Infinity)
+ */
+ float xExtent;
+ /**
+ * the Y-extent of the box (>=0, may be +Infinity)
+ */
+ float yExtent;
+ /**
+ * the Z-extent of the box (>=0, may be +Infinity)
+ */
+ float zExtent;
+
+ /**
+ * Instantiate a BoundingBox without initializing it.
*/
public BoundingBox() {
}
/**
- * Contstructor instantiates a new BoundingBox object with
- * given specs.
+ * Instantiate a BoundingBox with given center and extents.
+ *
+ * @param c the coordinates of the center of the box (not null, not altered)
+ * @param x the X-extent of the box (>=0, may be +Infinity)
+ * @param y the Y-extent of the box (>=0, may be +Infinity)
+ * @param z the Z-extent of the box (>=0, may be +Infinity)
*/
public BoundingBox(Vector3f c, float x, float y, float z) {
this.center.set(c);
@@ -80,6 +89,11 @@ public class BoundingBox extends BoundingVolume {
this.zExtent = z;
}
+ /**
+ * Instantiate a BoundingBox equivalent to an existing box.
+ *
+ * @param source the existing box (not null, not altered)
+ */
public BoundingBox(BoundingBox source) {
this.center.set(source.center);
this.xExtent = source.xExtent;
@@ -368,52 +382,28 @@ public class BoundingBox extends BoundingVolume {
}
/**
- * merge combines this bounding box with a second bounding box.
- * This new box contains both bounding box and is returned.
- *
- * @param volume
- * the bounding box to combine with this bounding box.
- * @return the new bounding box
+ * merge combines this bounding box locally with a second
+ * bounding volume. The result contains both the original box and the second
+ * volume.
+ *
+ * @param volume the bounding volume to combine with this box (or null) (not
+ * altered)
+ * @return this box (with its components modified) or null if the second
+ * volume is of some type other than AABB or Sphere
*/
public BoundingVolume merge(BoundingVolume volume) {
- if (volume == null) {
- return this;
- }
-
- switch (volume.getType()) {
- case AABB: {
- BoundingBox vBox = (BoundingBox) volume;
- return merge(vBox.center, vBox.xExtent, vBox.yExtent,
- vBox.zExtent, new BoundingBox(new Vector3f(0, 0, 0), 0,
- 0, 0));
- }
-
- case Sphere: {
- BoundingSphere vSphere = (BoundingSphere) volume;
- return merge(vSphere.center, vSphere.radius, vSphere.radius,
- vSphere.radius, new BoundingBox(new Vector3f(0, 0, 0),
- 0, 0, 0));
- }
-
-// case OBB: {
-// OrientedBoundingBox box = (OrientedBoundingBox) volume;
-// BoundingBox rVal = (BoundingBox) this.clone(null);
-// return rVal.mergeOBB(box);
-// }
-
- default:
- return null;
- }
+ return mergeLocal(volume);
}
/**
- * mergeLocal combines this sphere with a second bounding
- * sphere locally. Altering this sphere to contain both the original and the
- * additional sphere volumes;
- *
- * @param volume
- * the sphere to combine with this sphere.
- * @return this
+ * mergeLocal combines this bounding box locally with a second
+ * bounding volume. The result contains both the original box and the second
+ * volume.
+ *
+ * @param volume the bounding volume to combine with this box (or null) (not
+ * altered)
+ * @return this box (with its components modified) or null if the second
+ * volume is of some type other than AABB or Sphere
*/
public BoundingVolume mergeLocal(BoundingVolume volume) {
if (volume == null) {
@@ -421,17 +411,15 @@ public class BoundingBox extends BoundingVolume {
}
switch (volume.getType()) {
- case AABB: {
+ case AABB:
BoundingBox vBox = (BoundingBox) volume;
- return merge(vBox.center, vBox.xExtent, vBox.yExtent,
- vBox.zExtent, this);
- }
+ return mergeLocal(vBox.center, vBox.xExtent, vBox.yExtent,
+ vBox.zExtent);
- case Sphere: {
+ case Sphere:
BoundingSphere vSphere = (BoundingSphere) volume;
- return merge(vSphere.center, vSphere.radius, vSphere.radius,
- vSphere.radius, this);
- }
+ return mergeLocal(vSphere.center, vSphere.radius,
+ vSphere.radius, vSphere.radius);
// case OBB: {
// return mergeOBB((OrientedBoundingBox) volume);
@@ -486,61 +474,68 @@ public class BoundingBox extends BoundingVolume {
// return this;
// }
/**
- * merge combines this bounding box with another box which is
- * defined by the center, x, y, z extents.
- *
- * @param boxCenter
- * the center of the box to merge with
- * @param boxX
- * the x extent of the box to merge with.
- * @param boxY
- * the y extent of the box to merge with.
- * @param boxZ
- * the z extent of the box to merge with.
- * @param rVal
- * the resulting merged box.
+ * mergeLocal combines this bounding box locally with a second
+ * bounding box described by its center and extents.
+ *
+ * @param c the center of the second box (not null, not altered)
+ * @param x the X-extent of the second box
+ * @param y the Y-extent of the second box
+ * @param z the Z-extent of the second box
* @return the resulting merged box.
*/
- private BoundingBox merge(Vector3f boxCenter, float boxX, float boxY,
- float boxZ, BoundingBox rVal) {
-
- TempVars vars = TempVars.get();
-
- vars.vect1.x = center.x - xExtent;
- if (vars.vect1.x > boxCenter.x - boxX) {
- vars.vect1.x = boxCenter.x - boxX;
- }
- vars.vect1.y = center.y - yExtent;
- if (vars.vect1.y > boxCenter.y - boxY) {
- vars.vect1.y = boxCenter.y - boxY;
- }
- vars.vect1.z = center.z - zExtent;
- if (vars.vect1.z > boxCenter.z - boxZ) {
- vars.vect1.z = boxCenter.z - boxZ;
+ private BoundingBox mergeLocal(Vector3f c, float x, float y, float z) {
+ if (xExtent == Float.POSITIVE_INFINITY
+ || x == Float.POSITIVE_INFINITY) {
+ center.x = 0;
+ xExtent = Float.POSITIVE_INFINITY;
+ } else {
+ float low = center.x - xExtent;
+ if (low > c.x - x) {
+ low = c.x - x;
+ }
+ float high = center.x + xExtent;
+ if (high < c.x + x) {
+ high = c.x + x;
+ }
+ center.x = (low + high) / 2;
+ xExtent = high - center.x;
}
- vars.vect2.x = center.x + xExtent;
- if (vars.vect2.x < boxCenter.x + boxX) {
- vars.vect2.x = boxCenter.x + boxX;
- }
- vars.vect2.y = center.y + yExtent;
- if (vars.vect2.y < boxCenter.y + boxY) {
- vars.vect2.y = boxCenter.y + boxY;
- }
- vars.vect2.z = center.z + zExtent;
- if (vars.vect2.z < boxCenter.z + boxZ) {
- vars.vect2.z = boxCenter.z + boxZ;
+ if (yExtent == Float.POSITIVE_INFINITY
+ || y == Float.POSITIVE_INFINITY) {
+ center.y = 0;
+ yExtent = Float.POSITIVE_INFINITY;
+ } else {
+ float low = center.y - yExtent;
+ if (low > c.y - y) {
+ low = c.y - y;
+ }
+ float high = center.y + yExtent;
+ if (high < c.y + y) {
+ high = c.y + y;
+ }
+ center.y = (low + high) / 2;
+ yExtent = high - center.y;
}
- center.set(vars.vect2).addLocal(vars.vect1).multLocal(0.5f);
-
- xExtent = vars.vect2.x - center.x;
- yExtent = vars.vect2.y - center.y;
- zExtent = vars.vect2.z - center.z;
-
- vars.release();
+ if (zExtent == Float.POSITIVE_INFINITY
+ || z == Float.POSITIVE_INFINITY) {
+ center.z = 0;
+ zExtent = Float.POSITIVE_INFINITY;
+ } else {
+ float low = center.z - zExtent;
+ if (low > c.z - z) {
+ low = c.z - z;
+ }
+ float high = center.z + zExtent;
+ if (high < c.z + z) {
+ high = c.z + z;
+ }
+ center.z = (low + high) / 2;
+ zExtent = high - center.z;
+ }
- return rVal;
+ return this;
}
/**
@@ -570,8 +565,9 @@ public class BoundingBox extends BoundingVolume {
/**
* toString returns the string representation of this object.
- * The form is: "Radius: RRR.SSSS Center:
- * Represents the vector direction the light is coming from.
- * (1, 0, 0) would represent a directional light coming from the X axis.
+ * Represents the direction the light is shining.
+ * (1, 0, 0) would represent light shining in the +X direction.
*
* @param dir the direction of the light.
*/
diff --git a/engine/src/core/com/jme3/light/SpotLight.java b/engine/src/core/com/jme3/light/SpotLight.java
index 04e6ca7d4..f566f0dc7 100644
--- a/engine/src/core/com/jme3/light/SpotLight.java
+++ b/engine/src/core/com/jme3/light/SpotLight.java
@@ -76,8 +76,7 @@ public class SpotLight extends Light implements Savable {
if(((int)packedAngleCos)== ((int)(outerCos*1000)) ){
outerCos -= 0.001f;
}
- packedAngleCos+=outerCos;
- System.out.println("anfle"+ packedAngleCos);
+ packedAngleCos+=outerCos;
}
@Override
diff --git a/engine/src/core/com/jme3/post/FilterPostProcessor.java b/engine/src/core/com/jme3/post/FilterPostProcessor.java
index 8c9b81ba0..06521780e 100644
--- a/engine/src/core/com/jme3/post/FilterPostProcessor.java
+++ b/engine/src/core/com/jme3/post/FilterPostProcessor.java
@@ -312,11 +312,7 @@ public class FilterPostProcessor implements SceneProcessor, Savable {
}
} else {
- if (renderFrameBufferMS != null) {
- viewPort.setOutputFrameBuffer(renderFrameBufferMS);
- } else {
- viewPort.setOutputFrameBuffer(renderFrameBuffer);
- }
+ setupViewPortFrameBuffer();
//init of the camera if it wasn't already
if (!cameraInit) {
viewPort.getCamera().resize(width, height, true);
@@ -353,11 +349,20 @@ public class FilterPostProcessor implements SceneProcessor, Savable {
for (int i = filters.size() - 1; i >= 0 && lastFilterIndex == -1; i--) {
if (filters.get(i).isEnabled()) {
lastFilterIndex = i;
+ //the Fpp is initialized, but the viwport framebuffer is the
+ //original out framebuffer so we must recover from a situation
+ //where no filter was enabled. So we set th correc framebuffer
+ //on the viewport
+ if(isInitialized() && viewPort.getOutputFrameBuffer()==outputBuffer){
+ setupViewPortFrameBuffer();
+ }
return;
}
}
if (lastFilterIndex == -1) {
- cleanup();
+ //There is no enabled filter, we restore the original framebuffer
+ //to the viewport to bypass the fpp.
+ viewPort.setOutputFrameBuffer(outputBuffer);
}
}
@@ -441,12 +446,7 @@ public class FilterPostProcessor implements SceneProcessor, Savable {
Filter filter = it.next();
initFilter(filter, vp);
}
-
- if (renderFrameBufferMS != null) {
- viewPort.setOutputFrameBuffer(renderFrameBufferMS);
- } else {
- viewPort.setOutputFrameBuffer(renderFrameBuffer);
- }
+ setupViewPortFrameBuffer();
}
/**
@@ -543,4 +543,12 @@ public class FilterPostProcessor implements SceneProcessor, Savable {
public List
- * This method is called by the renderer. Usually it should not be called
- * directly.
- *
- * @param cam The camera to check against.
- * @return true if inside or intersecting camera frustum
- * (should be rendered), false if outside.
- */
- public boolean checkCulling(Camera cam) {
- if (refreshFlags != 0) {
- throw new IllegalStateException("Scene graph is not properly updated for rendering.\n"
- + "State was changed after rootNode.updateGeometricState() call. \n"
- + "Make sure you do not modify the scene from another thread!\n"
- + "Problem spatial name: " + getName());
- }
-
- CullHint cm = getCullHint();
- assert cm != CullHint.Inherit;
- if (cm == Spatial.CullHint.Always) {
- setLastFrustumIntersection(Camera.FrustumIntersect.Outside);
- return false;
- } else if (cm == Spatial.CullHint.Never) {
- setLastFrustumIntersection(Camera.FrustumIntersect.Intersects);
- return true;
- }
-
- // check to see if we can cull this node
- frustrumIntersects = (parent != null ? parent.frustrumIntersects
- : Camera.FrustumIntersect.Intersects);
-
- if (frustrumIntersects == Camera.FrustumIntersect.Intersects) {
- if (getQueueBucket() == Bucket.Gui) {
- return cam.containsGui(getWorldBound());
- } else {
- frustrumIntersects = cam.contains(getWorldBound());
- }
- }
-
- return frustrumIntersects != Camera.FrustumIntersect.Outside;
- }
-
- /**
- * Sets the name of this spatial.
- *
- * @param name
- * The spatial's new name.
- */
- public void setName(String name) {
- this.name = name;
- }
-
- /**
- * Returns the name of this spatial.
- *
- * @return This spatial's name.
- */
- public String getName() {
- return name;
- }
-
- /**
- * Returns the local {@link LightList}, which are the lights
- * that were directly attached to this
+ * This method is called by the renderer. Usually it should not be called
+ * directly.
+ *
+ * @param cam The camera to check against.
+ * @return true if inside or intersecting camera frustum
+ * (should be rendered), false if outside.
+ */
+ public boolean checkCulling(Camera cam) {
+ if (refreshFlags != 0) {
+ throw new IllegalStateException("Scene graph is not properly updated for rendering.\n"
+ + "State was changed after rootNode.updateGeometricState() call. \n"
+ + "Make sure you do not modify the scene from another thread!\n"
+ + "Problem spatial name: " + getName());
+ }
+
+ CullHint cm = getCullHint();
+ assert cm != CullHint.Inherit;
+ if (cm == Spatial.CullHint.Always) {
+ setLastFrustumIntersection(Camera.FrustumIntersect.Outside);
+ return false;
+ } else if (cm == Spatial.CullHint.Never) {
+ setLastFrustumIntersection(Camera.FrustumIntersect.Intersects);
+ return true;
+ }
+
+ // check to see if we can cull this node
+ frustrumIntersects = (parent != null ? parent.frustrumIntersects
+ : Camera.FrustumIntersect.Intersects);
+
+ if (frustrumIntersects == Camera.FrustumIntersect.Intersects) {
+ if (getQueueBucket() == Bucket.Gui) {
+ return cam.containsGui(getWorldBound());
+ } else {
+ frustrumIntersects = cam.contains(getWorldBound());
+ }
+ }
+
+ return frustrumIntersects != Camera.FrustumIntersect.Outside;
+ }
+
+ /**
+ * Sets the name of this spatial.
+ *
+ * @param name
+ * The spatial's new name.
+ */
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Returns the name of this spatial.
+ *
+ * @return This spatial's name.
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Returns the local {@link LightList}, which are the lights
+ * that were directly attached to this
+ * The effect of the default value (CullHint.Inherit) may change if the
+ * spatial gets re-parented.
+ */
+ public void setCullHint(CullHint hint) {
+ cullHint = hint;
+ }
+
+ /**
+ *
+ * The effect of the default value (BatchHint.Inherit) may change if the
+ * spatial gets re-parented.
+ */
+ public void setBatchHint(BatchHint hint) {
+ batchHint = hint;
+ }
+
+ /**
+ * @return the cullmode set on this Spatial
+ */
+ public CullHint getLocalCullHint() {
+ return cullHint;
+ }
+
+ /**
+ * @return the batchHint set on this Spatial
+ */
+ public BatchHint getLocalBatchHint() {
+ return batchHint;
+ }
+
+ /**
+ *
-The
The AppStateManager's
-
Note: There are other obvious getters to poll the status of all corresponding setters listed here.
Your game can define its own game data based on whatever criteria you want, typically these include player ID and state. If the server needs to look up player/client-specific information, you can store this information directly on the HostedConnection object. The following examples read and write a custom Java object
-A server has a game version and game name property. Each client expects to communicate with a server with a certain game name and version. Test first whether the game name matches, and then whether game version matches, before sending any messages! If they do not match, you should refuse to connect, because unmatched clients and servers will likely miscommunicate.
+A server has a game version and game name property. Each client expects to communicate with a server with a certain game name and version. Test first whether the game name matches, and then whether game version matches, before sending any messages! If they do not match, SpiderMoney will reject it for you, you have no choice in the mater. This is so the client and server can avoid miscommunication.
The com.jme3.network.ClientStateListener notifies the Client when the Client has fully connected to the server (including any internal handshaking), and when the Client is kicked (disconnected) from the server.
+
+
First implement the ClientStateListener interface in the Client class. Then register it to myClient in MyGameClient's simpleInitApp() method:
@@ -403,7 +411,7 @@ First implement the ClientStateListener interface in the Client class. Then regi
First implement the ConnectionListener interface in the Server class. Then register it to myServer in MyGameServer's simpleInitApp() method.
@@ -432,7 +440,55 @@ First implement the ConnectionListener interface in the Server class. Then regis
+
+The com.jme3.network.ErrorListener is a listener for when network exception happens. This listener is built so that you can override the default actions when a network exception happens.
+
+
+
+
+First implement the ErrorListener interface in the client class. Then you need to register it to myClient in MyGameClients's simpleInitApp() method.
+
+In the class that implements the ErrorListener, a method would of been added call handleError(Client s, Throwable t). Inside this method to get you started, you going to want to listen for an error. To do this you're going to want a bit of code like this.
+
+Replace exception part in the if statement for the type of exception that you would like it to handle.
+
+
-To let a Nifty screen communicate with the Java application, you register a
@@ -100,7 +100,7 @@ Now the Java class
+
+
See also:
-The PhysicsControl constructors expect a Collision Shape and a mass (a float in kilogram). The most commonly used PhysicsControl is the RigidBodyControl:
+The most commonly used physics control is RigidBodyControl. The RigidBodyControl constructor takes up to two parameters: a collision shape and a mass (a float in kilograms). The mass parameter also determines whether the object is dynamic (movable) or static (fixed). For a static object such as a floor or wall, specify zero mass.
-
On a RigidBodyControl, you can apply the following physical forces:
@@ -574,9 +575,9 @@ On a RigidBodyControl, you can apply the following physical forces:
(See detailed explanation below.)
-
+
-
+
-Video cards support a maximum of 16 Splat textures total. This means you can only use a subset of material properties at the same time!
+OpenGL supports a maximum of 16 samplers in any given shader. This means you can only use a subset of material properties at the same time if you use the terrain's default lighting shader (TerrainLighting.j3md)!
@@ -237,7 +237,7 @@ You can hand-paint Alpha, Diffuse, Glow, and Specular maps in a drawing program,
@@ -132,7 +133,7 @@ This is just a suggested best practice, and it's what you get by default wh
-To create 3D models and scenes, you need a 3D Mesh Editor with an OgreXML Exporter plugin. For example, you can .
-You use the SDK to load models, convert models and create scenes from them.
+To create 3D models and scenes, you need a 3D Mesh Editor. If you don't have any tools, install Blender and the OgreXML Exporter plugin.
+Then you and export them to your project.
+Then you use the SDK to load models, convert models, and create 3D scenes from them.
-If you use Blender, export your models as Ogre XML meshes with materials as follows:
+Example: From Blender, you export your models as Ogre XML meshes with materials as follows:
-JME3 can load Ogre XML models + materials, Ogre DotScenes, as well as Wavefront OBJ+MTL models. The loadModel() code works with these files when you run the code directly from the jMonkeyEngine SDK.
+JME3 can convert and load
-If you build the executables using the default build script, then the original model files (XML, OBJ, etc) are not included. When you run the executable, you get an error message if you try to load any models directly:
+
+The
-Loading the XML/OBJ files directly is only acceptable during the development phase. If your graphic designer pushes updated files to the asset directory, you can quickly review the latest version in your development environment.
+You see that loading the XML/OBJ/Blend files directly is only acceptable during the development phase in the SDK. For example, every time your graphic designer pushes updated files to the asset directory, you can quickly review the latest version in your development environment.
-For testing and for the final release build, you use .j3o files exclusively. J3o is an optimized binary format for jME3 applications, and .j3o files are automatically included in the distributable JAR file by the build script. When you do QA test builds or are ready to release, use the SDK to convert all .obj/.scene/.xml/.blend files to .j3o files, and only load the .j3o versions.
+But for QA test builds and for the final release build, you use .j3o files exclusively. J3o is an optimized binary format for jME3 applications. When you do QA test builds, or are ready to release, use the SDK to convert all .obj/.scene/.xml/.blend files to .j3o files, and update all code to load the .j3o files. The default build script automatically packages .j3o files in the executables.
@@ -306,18 +319,20 @@ Open your JME3 Project in the jMonkeyEngine
+
You want the gunshot sound to play once (you don't want it to loop). You also specify its volume as gain factor (at 0, sound is muted, at 2, it is twice as loud, etc.).
+
+
The nature sound is different: You want it to loop continuously as background sound. This is why you set looping to true, and immediately call the play() method on the node. You also choose to set its volume to 3.
Since you want to be able to shoot fast repeatedly, so you do not want to wait for the previous gunshot sound to end before the next one can start. This is why you play this sound using the
Run the sample. You should see a town square with houses and a monument. Use the WASD keys and the mouse to navigate around with a first-person perspective. Run forward and jump by pressing W and Space. Note how you step over the sidewalk, and up the steps to the monument. You can walk in the alleys between the houses, but the walls are solid. Don't walk over the edge of the world!
You initialize a few private fields:
@@ -222,15 +241,18 @@ You initialize a few private fields:
Let's have a look at all the details:
+
This last and most important code snippet goes into the
This is how the walking is triggered:
@@ -491,10 +521,11 @@ This is how the walking is triggered:
Important: Again, do not use
This code goes into the
Tip: If you don't recall an input constant during development, you benefit from an IDE's code completion functionality: Place the caret after e.g.
Build and run the file: You see a constantly rotating cube.
+
-Note the contrast:
+Note the the three phases of every game:
-Since rendering is automatic, initialization and updating are the two most important concepts in a SimpleApplication for you right now. These methods are where you load and create game data (once), and (repeatedly) change their properties to update the game state:
+Since rendering is automatic, initialization and updating are the two most important concepts in a SimpleApplication-based game for you:
-
+
-Here is what we did:
+Here is what we did: to create a textured box:
-
For a partially translucent/transparent texture, you need:
+For non-transparent objects, the drawing order is not so important, because the z-buffer already keeps track of whether a pixel is behind something else or not, and the color of an opaque pixel doesn't depend on the pixels under it, this is why opaque Geometries can be drawn in any order.
+
-What you did is the same as before, with only one added step for the transparency.
+What you did for the transparent texture is the same as before, with only one added step for the transparency.
-But textures are not all. Have a close look at the shiny sphere ??? you cannot get such a nice bumpy material with just a texture. JME3 also supports so-called Phong-illuminated materials:
+But textures are not all. Have a close look at the shiny sphere ??? you cannot get such a nice bumpy material with just a plain texture. You see that JME3 also supports so-called Phong-illuminated materials:
-In a lit material, the standard texture layer is refered to as Diffuse Map, any material can use this layer. A lit material can additionally have lighting effects such as Shininess used together with the Specular Map layer, and even a realistically bumpy or cracked surface with help of the Normal Map layer.
+In a lit material, the standard texture layer is refered to as DiffuseMap, any material can use this layer. A lit material can additionally have lighting effects such as Shininess used together with the SpecularMap layer and Specular color. And you can even get a realistically bumpy or cracked surface with help of the NormalMap layer.
Let's have a look at the part of the code example where you create the shiny bumpy rock.
For a game, you create custom Materials based on these existing MaterialDefintions ??? as you have just seen in the example with the shiny rock's material.
-Look at the purple leak-through sample above again. It takes four lines to create and set the Material.
+Look at the shiny rocky sphere above again. It takes several lines to create and set the Material.
+
If you want to use one custom material for several models, you can store it in a .j3m file, and save a few lines of code every time.
+
You create a j3m file as follows:
-Using this new custom material
Every JME3 application has a rootNode: Your game automatically inherits the
A Matrix is invertible if there is a matrix M-1 where MM-1 = M-1M = I.
@@ -185,7 +209,7 @@ The transpose of a matrix M = [mij] is MT<
A Matrix is symmetric if M = MT.
@@ -201,7 +225,7 @@ A Matrix is symmetric if M = MT.
Where X, A, B, and C equal numbers
where M is the 3x3 matrix (containing any rotation/scale information), T is the translation vector and ST is the transpose Vector of T. 1 is just a constant.
-MIP Map means that you provide one texture in two or three resolutions 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. If you don't provide custom ones, the jMonkeyEngine creates basic MIP maps automatically as an optimization.
+MIP Map means that you provide one texture in two or three resolutions 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 detailed at close up, but also look good when viewed from far away. Good for everything, but requires more time to create and more space to store textures. If you don't provide custom ones, the jMonkeyEngine creates basic MIP maps automatically as an optimization.
Using BlenderLoader can allow you to use blend file as your local assets repository.
@@ -308,7 +316,7 @@ Probably versions before 2.49 will work pretty well too, but I never checked tha
+When using polygon meshes in blender 2.5 and newer, better add and apply the triangulation modifier (if available in your version) or save the file with convertion from polygons to triangles.
+Even though the importer supports loading of polygons as the mesh faces, if your face isn't convex, the results might contain errors.
+
+Not all modifiers are supported. If your model has modifiers and looks not the way you want in the jme scene - try to apply them and load again.
+
Cheers,
Marcin Roguski (Kaelthas)
@@ -349,5 +366,5 @@ See also:
+
+So if you have some cool code that others can use in their games too, you would make your extension a library by creating a module that the users can download as a plugin :)
+
diff --git a/sdk/jme3-documentation/src/com/jme3/gde/docs/sdk/scene_explorer.html b/sdk/jme3-documentation/src/com/jme3/gde/docs/sdk/scene_explorer.html
index a6c55aff1..0761cae9e 100644
--- a/sdk/jme3-documentation/src/com/jme3/gde/docs/sdk/scene_explorer.html
+++ b/sdk/jme3-documentation/src/com/jme3/gde/docs/sdk/scene_explorer.html
@@ -30,11 +30,11 @@ The SceneExplorer displays Nodes in a tree that represents the tree of Spatials
-You open the SceneExplorer by viewing a model (j3o file or other) in the jMonkeyEngine SDK.
+SceneExplorer works in conjunction with SceneComposer, the default editor for J3O files in the jMonkeyEngine IDE. If SceneExplorer doesn't appear when you select "Edit in SceneComposer", choose Window ??? SceneExplorer from the menu bar to reveal the window.
-
-You should install the JDK (the one from Oracle, not OpenJDK) first, and then the jMonkey SDK. If jMonkeyEngine SDK cannot find a valid JDK although you have it installed, then you have to specify the location manually.
-
-
+
+You can install another JDK for use with the jMonkey SDK. You then have to specify the location manually.
+
+
-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 SDK's integrated version control features for Subversion, Mercurial, and CVS.
+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 SDK's integrated version control features for Subversion, Mercurial, and Git.
@@ -31,7 +31,7 @@ Note: Since the jMonkeyEngine SDK
-The jMonkeyEngine SDK supports various Version Control Systems such as Subversion, Mercurial, and CVS. No matter which of them you use, they all share a common user interface.
+The jMonkeyEngine SDK supports various Version Control Systems such as Subversion, Mercurial, and Git. No matter which of them you use, they all share a common user interface.
@@ -50,7 +50,7 @@ Requirements:
Spatial defines the base class for scene graph nodes. It
- * maintains a link to a parent, it's local transforms and the world's
- * transforms. All other scene graph elements, such as {@link Node} and
- * {@link Geometry} are subclasses of Spatial.
- *
- * @author Mark Powell
- * @author Joshua Slack
- * @version $Revision: 4075 $, $Data$
- */
-public abstract class Spatial implements Savable, Cloneable, Collidable, CloneableSmartAsset {
-
- private static final Logger logger = Logger.getLogger(Spatial.class.getName());
-
- /**
- * Specifies how frustum culling should be handled by
- * this spatial.
- */
- public enum CullHint {
-
- /**
- * Do whatever our parent does. If no parent, default to {@link #Dynamic}.
- */
- Inherit,
- /**
- * Do not draw if we are not at least partially within the view frustum
- * of the camera. This is determined via the defined
- * Camera planes whether or not this Spatial should be culled.
- */
- Dynamic,
- /**
- * Always cull this from the view, throwing away this object
- * and any children from rendering commands.
- */
- Always,
- /**
- * Never cull this from view, always draw it.
- * Note that we will still get culled if our parent is culled.
- */
- Never;
- }
-
- /**
- * Specifies if this spatial should be batched
- */
- public enum BatchHint {
-
- /**
- * Do whatever our parent does. If no parent, default to {@link #Always}.
- */
- Inherit,
- /**
- * This spatial will always be batched when attached to a BatchNode.
- */
- Always,
- /**
- * This spatial will never be batched when attached to a BatchNode.
- */
- Never;
- }
- /**
- * Refresh flag types
- */
- protected static final int RF_TRANSFORM = 0x01, // need light resort + combine transforms
- RF_BOUND = 0x02,
- RF_LIGHTLIST = 0x04; // changes in light lists
-
- protected CullHint cullHint = CullHint.Inherit;
- protected BatchHint batchHint = BatchHint.Inherit;
- /**
- * Spatial's bounding volume relative to the world.
- */
- protected BoundingVolume worldBound;
- /**
- * LightList
- */
- protected LightList localLights;
- protected transient LightList worldLights;
- /**
- * This spatial's name.
- */
- protected String name;
- // scale values
- protected transient Camera.FrustumIntersect frustrumIntersects = Camera.FrustumIntersect.Intersects;
- protected RenderQueue.Bucket queueBucket = RenderQueue.Bucket.Inherit;
- protected ShadowMode shadowMode = RenderQueue.ShadowMode.Inherit;
- public transient float queueDistance = Float.NEGATIVE_INFINITY;
- protected Transform localTransform;
- protected Transform worldTransform;
- protected SafeArrayListSpatial object setting the
- * rotation, translation and scale value to defaults.
- *
- * @param name
- * the name of the scene element. This is required for
- * identification and comparison purposes.
- */
- public Spatial(String name) {
- this();
- this.name = name;
- }
-
- public void setKey(AssetKey key) {
- this.key = key;
- }
-
- public AssetKey getKey() {
- return key;
- }
-
- /**
- * Indicate that the transform of this spatial has changed and that
- * a refresh is required.
- */
- protected void setTransformRefresh() {
- refreshFlags |= RF_TRANSFORM;
- setBoundRefresh();
- }
-
- protected void setLightListRefresh() {
- refreshFlags |= RF_LIGHTLIST;
- }
-
- /**
- * Indicate that the bounding of this spatial has changed and that
- * a refresh is required.
- */
- protected void setBoundRefresh() {
- refreshFlags |= RF_BOUND;
-
- Spatial p = parent;
- while (p != null) {
- if ((p.refreshFlags & RF_BOUND) != 0) {
- return;
- }
-
- p.refreshFlags |= RF_BOUND;
- p = p.parent;
- }
- }
-
- /**
- * (Internal use only) Forces a refresh of the given types of data.
- *
- * @param transforms Refresh world transform based on parents'
- * @param bounds Refresh bounding volume data based on child nodes
- * @param lights Refresh light list based on parents'
- */
- public void forceRefresh(boolean transforms, boolean bounds, boolean lights) {
- if (transforms) {
- setTransformRefresh();
- }
- if (bounds) {
- setBoundRefresh();
- }
- if (lights) {
- setLightListRefresh();
- }
- }
-
- /**
- * checkCulling checks the spatial with the camera to see if it
- * should be culled.
- * Spatial through the
- * {@link #addLight(com.jme3.light.Light) } and
- * {@link #removeLight(com.jme3.light.Light) } methods.
- *
- * @return The local light list
- */
- public LightList getLocalLightList() {
- return localLights;
- }
-
- /**
- * Returns the world {@link LightList}, containing the lights
- * combined from all this Spatial's parents up to and including
- * this Spatial's lights.
- *
- * @return The combined world light list
- */
- public LightList getWorldLightList() {
- return worldLights;
- }
-
- /**
- * getWorldRotation retrieves the absolute rotation of the
- * Spatial.
- *
- * @return the Spatial's world rotation quaternion.
- */
- public Quaternion getWorldRotation() {
- checkDoTransformUpdate();
- return worldTransform.getRotation();
- }
-
- /**
- * getWorldTranslation retrieves the absolute translation of
- * the spatial.
- *
- * @return the Spatial's world tranlsation vector.
- */
- public Vector3f getWorldTranslation() {
- checkDoTransformUpdate();
- return worldTransform.getTranslation();
- }
-
- /**
- * getWorldScale retrieves the absolute scale factor of the
- * spatial.
- *
- * @return the Spatial's world scale factor.
- */
- public Vector3f getWorldScale() {
- checkDoTransformUpdate();
- return worldTransform.getScale();
- }
-
- /**
- * getWorldTransform retrieves the world transformation
- * of the spatial.
- *
- * @return the world transform.
- */
- public Transform getWorldTransform() {
- checkDoTransformUpdate();
- return worldTransform;
- }
-
- /**
- * rotateUpTo is a utility function that alters the
- * local rotation to point the Y axis in the direction given by newUp.
- *
- * @param newUp
- * the up vector to use - assumed to be a unit vector.
- */
- public void rotateUpTo(Vector3f newUp) {
- TempVars vars = TempVars.get();
-
- Vector3f compVecA = vars.vect1;
- Quaternion q = vars.quat1;
-
- // First figure out the current up vector.
- Vector3f upY = compVecA.set(Vector3f.UNIT_Y);
- Quaternion rot = localTransform.getRotation();
- rot.multLocal(upY);
-
- // get angle between vectors
- float angle = upY.angleBetween(newUp);
-
- // figure out rotation axis by taking cross product
- Vector3f rotAxis = upY.crossLocal(newUp).normalizeLocal();
-
- // Build a rotation quat and apply current local rotation.
- q.fromAngleNormalAxis(angle, rotAxis);
- q.mult(rot, rot);
-
- vars.release();
-
- setTransformRefresh();
- }
-
- /**
- * lookAt is a convenience method for auto-setting the local
- * rotation based on a position in world space and an up vector. It computes the rotation
- * to transform the z-axis to point onto 'position' and the y-axis to 'up'.
- * Unlike {@link Quaternion#lookAt(com.jme3.math.Vector3f, com.jme3.math.Vector3f) }
- * this method takes a world position to look at and not a relative direction.
- *
- * Note : 28/01/2013 this method has been fixed as it was not taking into account the parent rotation.
- * This was resulting in improper rotation when the spatial had rotated parent nodes.
- * This method is intended to work in world space, so no matter what parent graph the
- * spatial has, it will look at the given position in world space.
- *
- * @param position
- * where to look at in terms of world coordinates
- * @param upVector
- * a vector indicating the (local) up direction. (typically {0,
- * 1, 0} in jME.)
- */
- public void lookAt(Vector3f position, Vector3f upVector) {
- Vector3f worldTranslation = getWorldTranslation();
-
- TempVars vars = TempVars.get();
-
- Vector3f compVecA = vars.vect4;
-
- compVecA.set(position).subtractLocal(worldTranslation);
- getLocalRotation().lookAt(compVecA, upVector);
-
- if ( getParent() != null ) {
- Quaternion rot=vars.quat1;
- rot = rot.set(parent.getWorldRotation()).inverseLocal().multLocal(getLocalRotation());
- rot.normalizeLocal();
- setLocalRotation(rot);
- }
- vars.release();
- setTransformRefresh();
- }
-
- /**
- * Should be overridden by Node and Geometry.
- */
- protected void updateWorldBound() {
- // the world bound of a leaf is the same as it's model bound
- // for a node, the world bound is a combination of all it's children
- // bounds
- // -> handled by subclass
- refreshFlags &= ~RF_BOUND;
- }
-
- protected void updateWorldLightList() {
- if (parent == null) {
- worldLights.update(localLights, null);
- refreshFlags &= ~RF_LIGHTLIST;
- } else {
- if ((parent.refreshFlags & RF_LIGHTLIST) == 0) {
- worldLights.update(localLights, parent.worldLights);
- refreshFlags &= ~RF_LIGHTLIST;
- } else {
- assert false;
- }
- }
- }
-
- /**
- * Should only be called from updateGeometricState().
- * In most cases should not be subclassed.
- */
- protected void updateWorldTransforms() {
- if (parent == null) {
- worldTransform.set(localTransform);
- refreshFlags &= ~RF_TRANSFORM;
- } else {
- // check if transform for parent is updated
- assert ((parent.refreshFlags & RF_TRANSFORM) == 0);
- worldTransform.set(localTransform);
- worldTransform.combineWithParent(parent.worldTransform);
- refreshFlags &= ~RF_TRANSFORM;
- }
- }
-
- /**
- * Computes the world transform of this Spatial in the most
- * efficient manner possible.
- */
- void checkDoTransformUpdate() {
- if ((refreshFlags & RF_TRANSFORM) == 0) {
- return;
- }
-
- if (parent == null) {
- worldTransform.set(localTransform);
- refreshFlags &= ~RF_TRANSFORM;
- } else {
- TempVars vars = TempVars.get();
-
- Spatial[] stack = vars.spatialStack;
- Spatial rootNode = this;
- int i = 0;
- while (true) {
- Spatial hisParent = rootNode.parent;
- if (hisParent == null) {
- rootNode.worldTransform.set(rootNode.localTransform);
- rootNode.refreshFlags &= ~RF_TRANSFORM;
- i--;
- break;
- }
-
- stack[i] = rootNode;
-
- if ((hisParent.refreshFlags & RF_TRANSFORM) == 0) {
- break;
- }
-
- rootNode = hisParent;
- i++;
- }
-
- vars.release();
-
- for (int j = i; j >= 0; j--) {
- rootNode = stack[j];
- //rootNode.worldTransform.set(rootNode.localTransform);
- //rootNode.worldTransform.combineWithParent(rootNode.parent.worldTransform);
- //rootNode.refreshFlags &= ~RF_TRANSFORM;
- rootNode.updateWorldTransforms();
- }
- }
- }
-
- /**
- * Computes this Spatial's world bounding volume in the most efficient
- * manner possible.
- */
- void checkDoBoundUpdate() {
- if ((refreshFlags & RF_BOUND) == 0) {
- return;
- }
-
- checkDoTransformUpdate();
-
- // Go to children recursively and update their bound
- if (this instanceof Node) {
- Node node = (Node) this;
- int len = node.getQuantity();
- for (int i = 0; i < len; i++) {
- Spatial child = node.getChild(i);
- child.checkDoBoundUpdate();
- }
- }
-
- // All children's bounds have been updated. Update my own now.
- updateWorldBound();
- }
-
- private void runControlUpdate(float tpf) {
- if (controls.isEmpty()) {
- return;
- }
-
- for (Control c : controls.getArray()) {
- c.update(tpf);
- }
- }
-
- /**
- * Called when the Spatial is about to be rendered, to notify
- * controls attached to this Spatial using the Control.render() method.
- *
- * @param rm The RenderManager rendering the Spatial.
- * @param vp The ViewPort to which the Spatial is being rendered to.
- *
- * @see Spatial#addControl(com.jme3.scene.control.Control)
- * @see Spatial#getControl(java.lang.Class)
- */
- public void runControlRender(RenderManager rm, ViewPort vp) {
- if (controls.isEmpty()) {
- return;
- }
-
- for (Control c : controls.getArray()) {
- c.render(rm, vp);
- }
- }
-
- /**
- * Add a control to the list of controls.
- * @param control The control to add.
- *
- * @see Spatial#removeControl(java.lang.Class)
- */
- public void addControl(Control control) {
- controls.add(control);
- control.setSpatial(this);
- }
-
- /**
- * Removes the first control that is an instance of the given class.
- *
- * @see Spatial#addControl(com.jme3.scene.control.Control)
- */
- public void removeControl(Class controlType) {
- for (int i = 0; i < controls.size(); i++) {
- if (controlType.isAssignableFrom(controls.get(i).getClass())) {
- Control control = controls.remove(i);
- control.setSpatial(null);
- }
- }
- }
-
- /**
- * Removes the given control from this spatial's controls.
- *
- * @param control The control to remove
- * @return True if the control was successfuly removed. False if
- * the control is not assigned to this spatial.
- *
- * @see Spatial#addControl(com.jme3.scene.control.Control)
- */
- public boolean removeControl(Control control) {
- boolean result = controls.remove(control);
- if (result) {
- control.setSpatial(null);
- }
-
- return result;
- }
-
- /**
- * Returns the first control that is an instance of the given class,
- * or null if no such control exists.
- *
- * @param controlType The superclass of the control to look for.
- * @return The first instance in the list of the controlType class, or null.
- *
- * @see Spatial#addControl(com.jme3.scene.control.Control)
- */
- public updateLogicalState calls the update() method
- * for all controls attached to this Spatial.
- *
- * @param tpf Time per frame.
- *
- * @see Spatial#addControl(com.jme3.scene.control.Control)
- */
- public void updateLogicalState(float tpf) {
- runControlUpdate(tpf);
- }
-
- /**
- * updateGeometricState updates the lightlist,
- * computes the world transforms, and computes the world bounds
- * for this Spatial.
- * Calling this when the Spatial is attached to a node
- * will cause undefined results. User code should only call this
- * method on Spatials having no parent.
- *
- * @see Spatial#getWorldLightList()
- * @see Spatial#getWorldTransform()
- * @see Spatial#getWorldBound()
- */
- public void updateGeometricState() {
- // assume that this Spatial is a leaf, a proper implementation
- // for this method should be provided by Node.
-
- // NOTE: Update world transforms first because
- // bound transform depends on them.
- if ((refreshFlags & RF_LIGHTLIST) != 0) {
- updateWorldLightList();
- }
- if ((refreshFlags & RF_TRANSFORM) != 0) {
- updateWorldTransforms();
- }
- if ((refreshFlags & RF_BOUND) != 0) {
- updateWorldBound();
- }
-
- assert refreshFlags == 0;
- }
-
- /**
- * Convert a vector (in) from this spatials' local coordinate space to world
- * coordinate space.
- *
- * @param in
- * vector to read from
- * @param store
- * where to write the result (null to create a new vector, may be
- * same as in)
- * @return the result (store)
- */
- public Vector3f localToWorld(final Vector3f in, Vector3f store) {
- checkDoTransformUpdate();
- return worldTransform.transformVector(in, store);
- }
-
- /**
- * Convert a vector (in) from world coordinate space to this spatials' local
- * coordinate space.
- *
- * @param in
- * vector to read from
- * @param store
- * where to write the result
- * @return the result (store)
- */
- public Vector3f worldToLocal(final Vector3f in, final Vector3f store) {
- checkDoTransformUpdate();
- return worldTransform.transformInverseVector(in, store);
- }
-
- /**
- * getParent retrieves this node's parent. If the parent is
- * null this is the root node.
- *
- * @return the parent of this node.
- */
- public Node getParent() {
- return parent;
- }
-
- /**
- * Called by {@link Node#attachChild(Spatial)} and
- * {@link Node#detachChild(Spatial)} - don't call directly.
- * setParent sets the parent of this node.
- *
- * @param parent
- * the parent of this node.
- */
- protected void setParent(Node parent) {
- this.parent = parent;
- }
-
- /**
- * removeFromParent removes this Spatial from it's parent.
- *
- * @return true if it has a parent and performed the remove.
- */
- public boolean removeFromParent() {
- if (parent != null) {
- parent.detachChild(this);
- return true;
- }
- return false;
- }
-
- /**
- * determines if the provided Node is the parent, or parent's parent, etc. of this Spatial.
- *
- * @param ancestor
- * the ancestor object to look for.
- * @return true if the ancestor is found, false otherwise.
- */
- public boolean hasAncestor(Node ancestor) {
- if (parent == null) {
- return false;
- } else if (parent.equals(ancestor)) {
- return true;
- } else {
- return parent.hasAncestor(ancestor);
- }
- }
-
- /**
- * getLocalRotation retrieves the local rotation of this
- * node.
- *
- * @return the local rotation of this node.
- */
- public Quaternion getLocalRotation() {
- return localTransform.getRotation();
- }
-
- /**
- * setLocalRotation sets the local rotation of this node
- * by using a {@link Matrix3f}.
- *
- * @param rotation
- * the new local rotation.
- */
- public void setLocalRotation(Matrix3f rotation) {
- localTransform.getRotation().fromRotationMatrix(rotation);
- setTransformRefresh();
- }
-
- /**
- * setLocalRotation sets the local rotation of this node.
- *
- * @param quaternion
- * the new local rotation.
- */
- public void setLocalRotation(Quaternion quaternion) {
- localTransform.setRotation(quaternion);
- setTransformRefresh();
- }
-
- /**
- * getLocalScale retrieves the local scale of this node.
- *
- * @return the local scale of this node.
- */
- public Vector3f getLocalScale() {
- return localTransform.getScale();
- }
-
- /**
- * setLocalScale sets the local scale of this node.
- *
- * @param localScale
- * the new local scale, applied to x, y and z
- */
- public void setLocalScale(float localScale) {
- localTransform.setScale(localScale);
- setTransformRefresh();
- }
-
- /**
- * setLocalScale sets the local scale of this node.
- */
- public void setLocalScale(float x, float y, float z) {
- localTransform.setScale(x, y, z);
- setTransformRefresh();
- }
-
- /**
- * setLocalScale sets the local scale of this node.
- *
- * @param localScale
- * the new local scale.
- */
- public void setLocalScale(Vector3f localScale) {
- localTransform.setScale(localScale);
- setTransformRefresh();
- }
-
- /**
- * getLocalTranslation retrieves the local translation of
- * this node.
- *
- * @return the local translation of this node.
- */
- public Vector3f getLocalTranslation() {
- return localTransform.getTranslation();
- }
-
- /**
- * setLocalTranslation sets the local translation of this
- * spatial.
- *
- * @param localTranslation
- * the local translation of this spatial.
- */
- public void setLocalTranslation(Vector3f localTranslation) {
- this.localTransform.setTranslation(localTranslation);
- setTransformRefresh();
- }
-
- /**
- * setLocalTranslation sets the local translation of this
- * spatial.
- */
- public void setLocalTranslation(float x, float y, float z) {
- this.localTransform.setTranslation(x, y, z);
- setTransformRefresh();
- }
-
- /**
- * setLocalTransform sets the local transform of this
- * spatial.
- */
- public void setLocalTransform(Transform t) {
- this.localTransform.set(t);
- setTransformRefresh();
- }
-
- /**
- * getLocalTransform retrieves the local transform of
- * this spatial.
- *
- * @return the local transform of this spatial.
- */
- public Transform getLocalTransform() {
- return localTransform;
- }
-
- /**
- * Applies the given material to the Spatial, this will propagate the
- * material down to the geometries in the scene graph.
- *
- * @param material The material to set.
- */
- public void setMaterial(Material material) {
- }
-
- /**
- * addLight adds the given light to the Spatial; causing
- * all child Spatials to be effected by it.
- *
- * @param light The light to add.
- */
- public void addLight(Light light) {
- localLights.add(light);
- setLightListRefresh();
- }
-
- /**
- * removeLight removes the given light from the Spatial.
- *
- * @param light The light to remove.
- * @see Spatial#addLight(com.jme3.light.Light)
- */
- public void removeLight(Light light) {
- localLights.remove(light);
- setLightListRefresh();
- }
-
- /**
- * Translates the spatial by the given translation vector.
- *
- * @return The spatial on which this method is called, e.g this.
- */
- public Spatial move(float x, float y, float z) {
- this.localTransform.getTranslation().addLocal(x, y, z);
- setTransformRefresh();
-
- return this;
- }
-
- /**
- * Translates the spatial by the given translation vector.
- *
- * @return The spatial on which this method is called, e.g this.
- */
- public Spatial move(Vector3f offset) {
- this.localTransform.getTranslation().addLocal(offset);
- setTransformRefresh();
-
- return this;
- }
-
- /**
- * Scales the spatial by the given value
- *
- * @return The spatial on which this method is called, e.g this.
- */
- public Spatial scale(float s) {
- return scale(s, s, s);
- }
-
- /**
- * Scales the spatial by the given scale vector.
- *
- * @return The spatial on which this method is called, e.g this.
- */
- public Spatial scale(float x, float y, float z) {
- this.localTransform.getScale().multLocal(x, y, z);
- setTransformRefresh();
-
- return this;
- }
-
- /**
- * Rotates the spatial by the given rotation.
- *
- * @return The spatial on which this method is called, e.g this.
- */
- public Spatial rotate(Quaternion rot) {
- this.localTransform.getRotation().multLocal(rot);
- setTransformRefresh();
-
- return this;
- }
-
- /**
- * Rotates the spatial by the xAngle, yAngle and zAngle angles (in radians),
- * (aka pitch, yaw, roll) in the local coordinate space.
- *
- * @return The spatial on which this method is called, e.g this.
- */
- public Spatial rotate(float xAngle, float yAngle, float zAngle) {
- TempVars vars = TempVars.get();
- Quaternion q = vars.quat1;
- q.fromAngles(xAngle, yAngle, zAngle);
- rotate(q);
- vars.release();
-
- return this;
- }
-
- /**
- * Centers the spatial in the origin of the world bound.
- * @return The spatial on which this method is called, e.g this.
- */
- public Spatial center() {
- Vector3f worldTrans = getWorldTranslation();
- Vector3f worldCenter = getWorldBound().getCenter();
-
- Vector3f absTrans = worldTrans.subtract(worldCenter);
- setLocalTranslation(absTrans);
-
- return this;
- }
-
- /**
- * @see #setCullHint(CullHint)
- * @return the cull mode of this spatial, or if set to CullHint.Inherit,
- * the cullmode of it's parent.
- */
- public CullHint getCullHint() {
- if (cullHint != CullHint.Inherit) {
- return cullHint;
- } else if (parent != null) {
- return parent.getCullHint();
- } else {
- return CullHint.Dynamic;
- }
- }
-
- public BatchHint getBatchHint() {
- if (batchHint != BatchHint.Inherit) {
- return batchHint;
- } else if (parent != null) {
- return parent.getBatchHint();
- } else {
- return BatchHint.Always;
- }
- }
-
- /**
- * Returns this spatial's renderqueue bucket. If the mode is set to inherit,
- * then the spatial gets its renderqueue bucket from its parent.
- *
- * @return The spatial's current renderqueue mode.
- */
- public RenderQueue.Bucket getQueueBucket() {
- if (queueBucket != RenderQueue.Bucket.Inherit) {
- return queueBucket;
- } else if (parent != null) {
- return parent.getQueueBucket();
- } else {
- return RenderQueue.Bucket.Opaque;
- }
- }
-
- /**
- * @return The shadow mode of this spatial, if the local shadow
- * mode is set to inherit, then the parent's shadow mode is returned.
- *
- * @see Spatial#setShadowMode(com.jme3.renderer.queue.RenderQueue.ShadowMode)
- * @see ShadowMode
- */
- public RenderQueue.ShadowMode getShadowMode() {
- if (shadowMode != RenderQueue.ShadowMode.Inherit) {
- return shadowMode;
- } else if (parent != null) {
- return parent.getShadowMode();
- } else {
- return ShadowMode.Off;
- }
- }
-
- /**
- * Sets the level of detail to use when rendering this Spatial,
- * this call propagates to all geometries under this Spatial.
- *
- * @param lod The lod level to set.
- */
- public void setLodLevel(int lod) {
- }
-
- /**
- * updateModelBound recalculates the bounding object for this
- * Spatial.
- */
- public abstract void updateModelBound();
-
- /**
- * setModelBound sets the bounding object for this Spatial.
- *
- * @param modelBound
- * the bounding object for this spatial.
- */
- public abstract void setModelBound(BoundingVolume modelBound);
-
- /**
- * @return The sum of all verticies under this Spatial.
- */
- public abstract int getVertexCount();
-
- /**
- * @return The sum of all triangles under this Spatial.
- */
- public abstract int getTriangleCount();
-
- /**
- * @return A clone of this Spatial, the scene graph in its entirety
- * is cloned and can be altered independently of the original scene graph.
- *
- * Note that meshes of geometries are not cloned explicitly, they
- * are shared if static, or specially cloned if animated.
- *
- * All controls will be cloned using the Control.cloneForSpatial method
- * on the clone.
- *
- * @see Mesh#cloneForAnim()
- */
- public Spatial clone(boolean cloneMaterial) {
- try {
- Spatial clone = (Spatial) super.clone();
- if (worldBound != null) {
- clone.worldBound = worldBound.clone();
- }
- clone.worldLights = worldLights.clone();
- clone.localLights = localLights.clone();
-
- // Set the new owner of the light lists
- clone.localLights.setOwner(clone);
- clone.worldLights.setOwner(clone);
-
- // No need to force cloned to update.
- // This node already has the refresh flags
- // set below so it will have to update anyway.
- clone.worldTransform = worldTransform.clone();
- clone.localTransform = localTransform.clone();
-
- if (clone instanceof Node) {
- Node node = (Node) this;
- Node nodeClone = (Node) clone;
- nodeClone.children = new SafeArrayListgetWorldBound retrieves the world bound at this node
- * level.
- *
- * @return the world bound at this level.
- */
- public BoundingVolume getWorldBound() {
- checkDoBoundUpdate();
- return worldBound;
- }
-
- /**
- * setCullHint sets how scene culling should work on this
- * spatial during drawing. NOTE: You must set this AFTER attaching to a
- * parent or it will be reset with the parent's cullMode value.
- *
- * @param hint
- * one of CullHint.Dynamic, CullHint.Always, CullHint.Inherit or
- * CullHint.Never
- */
- public void setCullHint(CullHint hint) {
- cullHint = hint;
- }
-
- /**
- * setBatchHint sets how batching should work on this
- * spatial. NOTE: You must set this AFTER attaching to a
- * parent or it will be reset with the parent's cullMode value.
- *
- * @param hint
- * one of BatchHint.Never, BatchHint.Always, BatchHint.Inherit
- */
- public void setBatchHint(BatchHint hint) {
- batchHint = hint;
- }
-
- /**
- * @return the cullmode set on this Spatial
- */
- public CullHint getLocalCullHint() {
- return cullHint;
- }
-
- /**
- * @return the batchHint set on this Spatial
- */
- public BatchHint getLocalBatchHint() {
- return batchHint;
- }
-
- /**
- * setQueueBucket determines at what phase of the
- * rendering process this Spatial will rendered. See the
- * {@link Bucket} enum for an explanation of the various
- * render queue buckets.
- *
- * @param queueBucket
- * The bucket to use for this Spatial.
- */
- public void setQueueBucket(RenderQueue.Bucket queueBucket) {
- this.queueBucket = queueBucket;
- }
-
- /**
- * Sets the shadow mode of the spatial
- * The shadow mode determines how the spatial should be shadowed,
- * when a shadowing technique is used. See the
- * documentation for the class {@link ShadowMode} for more information.
- *
- * @see ShadowMode
- *
- * @param shadowMode The local shadow mode to set.
- */
- public void setShadowMode(RenderQueue.ShadowMode shadowMode) {
- this.shadowMode = shadowMode;
- }
-
- /**
- * @return The locally set queue bucket mode
- *
- * @see Spatial#setQueueBucket(com.jme3.renderer.queue.RenderQueue.Bucket)
- */
- public RenderQueue.Bucket getLocalQueueBucket() {
- return queueBucket;
- }
-
- /**
- * @return The locally set shadow mode
- *
- * @see Spatial#setShadowMode(com.jme3.renderer.queue.RenderQueue.ShadowMode)
- */
- public RenderQueue.ShadowMode getLocalShadowMode() {
- return shadowMode;
- }
-
- /**
- * Returns this spatial's last frustum intersection result. This int is set
- * when a check is made to determine if the bounds of the object fall inside
- * a camera's frustum. If a parent is found to fall outside the frustum, the
- * value for this spatial will not be updated.
- *
- * @return The spatial's last frustum intersection result.
- */
- public Camera.FrustumIntersect getLastFrustumIntersection() {
- return frustrumIntersects;
- }
-
- /**
- * Overrides the last intersection result. This is useful for operations
- * that want to start rendering at the middle of a scene tree and don't want
- * the parent of that node to influence culling.
- *
- * @param intersects
- * the new value
- */
- public void setLastFrustumIntersection(Camera.FrustumIntersect intersects) {
- frustrumIntersects = intersects;
- }
-
- /**
- * Returns the Spatial's name followed by the class of the spatial
- * Example: "MyNode (com.jme3.scene.Spatial)
- *
- * @return Spatial's name followed by the class of the Spatial
- */
- @Override
- public String toString() {
- return name + " (" + this.getClass().getSimpleName() + ')';
- }
-
- /**
- * Creates a transform matrix that will convert from this spatials'
- * local coordinate space to the world coordinate space
- * based on the world transform.
- *
- * @param store Matrix where to store the result, if null, a new one
- * will be created and returned.
- *
- * @return store if not null, otherwise, a new matrix containing the result.
- *
- * @see Spatial#getWorldTransform()
- */
- public Matrix4f getLocalToWorldMatrix(Matrix4f store) {
- if (store == null) {
- store = new Matrix4f();
- } else {
- store.loadIdentity();
- }
- // multiply with scale first, then rotate, finally translate (cf.
- // Eberly)
- store.scale(getWorldScale());
- store.multLocal(getWorldRotation());
- store.setTranslation(getWorldTranslation());
- return store;
- }
-
- /**
- * Visit each scene graph element ordered by DFS
- * @param visitor
- */
- public abstract void depthFirstTraversal(SceneGraphVisitor visitor);
-
- /**
- * Visit each scene graph element ordered by BFS
- * @param visitor
- */
- public void breadthFirstTraversal(SceneGraphVisitor visitor) {
- QueueSpatial defines the base class for scene graph nodes. It
+ * maintains a link to a parent, it's local transforms and the world's
+ * transforms. All other scene graph elements, such as {@link Node} and
+ * {@link Geometry} are subclasses of Spatial.
+ *
+ * @author Mark Powell
+ * @author Joshua Slack
+ * @version $Revision: 4075 $, $Data$
+ */
+public abstract class Spatial implements Savable, Cloneable, Collidable, CloneableSmartAsset {
+
+ private static final Logger logger = Logger.getLogger(Spatial.class.getName());
+
+ /**
+ * Specifies how frustum culling should be handled by
+ * this spatial.
+ */
+ public enum CullHint {
+
+ /**
+ * Do whatever our parent does. If no parent, default to {@link #Dynamic}.
+ */
+ Inherit,
+ /**
+ * Do not draw if we are not at least partially within the view frustum
+ * of the camera. This is determined via the defined
+ * Camera planes whether or not this Spatial should be culled.
+ */
+ Dynamic,
+ /**
+ * Always cull this from the view, throwing away this object
+ * and any children from rendering commands.
+ */
+ Always,
+ /**
+ * Never cull this from view, always draw it.
+ * Note that we will still get culled if our parent is culled.
+ */
+ Never;
+ }
+
+ /**
+ * Specifies if this spatial should be batched
+ */
+ public enum BatchHint {
+
+ /**
+ * Do whatever our parent does. If no parent, default to {@link #Always}.
+ */
+ Inherit,
+ /**
+ * This spatial will always be batched when attached to a BatchNode.
+ */
+ Always,
+ /**
+ * This spatial will never be batched when attached to a BatchNode.
+ */
+ Never;
+ }
+ /**
+ * Refresh flag types
+ */
+ protected static final int RF_TRANSFORM = 0x01, // need light resort + combine transforms
+ RF_BOUND = 0x02,
+ RF_LIGHTLIST = 0x04; // changes in light lists
+
+ protected CullHint cullHint = CullHint.Inherit;
+ protected BatchHint batchHint = BatchHint.Inherit;
+ /**
+ * Spatial's bounding volume relative to the world.
+ */
+ protected BoundingVolume worldBound;
+ /**
+ * LightList
+ */
+ protected LightList localLights;
+ protected transient LightList worldLights;
+ /**
+ * This spatial's name.
+ */
+ protected String name;
+ // scale values
+ protected transient Camera.FrustumIntersect frustrumIntersects = Camera.FrustumIntersect.Intersects;
+ protected RenderQueue.Bucket queueBucket = RenderQueue.Bucket.Inherit;
+ protected ShadowMode shadowMode = RenderQueue.ShadowMode.Inherit;
+ public transient float queueDistance = Float.NEGATIVE_INFINITY;
+ protected Transform localTransform;
+ protected Transform worldTransform;
+ protected SafeArrayListSpatial object setting the
+ * rotation, translation and scale value to defaults.
+ *
+ * @param name
+ * the name of the scene element. This is required for
+ * identification and comparison purposes.
+ */
+ public Spatial(String name) {
+ this();
+ this.name = name;
+ }
+
+ public void setKey(AssetKey key) {
+ this.key = key;
+ }
+
+ public AssetKey getKey() {
+ return key;
+ }
+
+ /**
+ * Indicate that the transform of this spatial has changed and that
+ * a refresh is required.
+ */
+ protected void setTransformRefresh() {
+ refreshFlags |= RF_TRANSFORM;
+ setBoundRefresh();
+ }
+
+ protected void setLightListRefresh() {
+ refreshFlags |= RF_LIGHTLIST;
+ }
+
+ /**
+ * Indicate that the bounding of this spatial has changed and that
+ * a refresh is required.
+ */
+ protected void setBoundRefresh() {
+ refreshFlags |= RF_BOUND;
+
+ Spatial p = parent;
+ while (p != null) {
+ if ((p.refreshFlags & RF_BOUND) != 0) {
+ return;
+ }
+
+ p.refreshFlags |= RF_BOUND;
+ p = p.parent;
+ }
+ }
+
+ /**
+ * (Internal use only) Forces a refresh of the given types of data.
+ *
+ * @param transforms Refresh world transform based on parents'
+ * @param bounds Refresh bounding volume data based on child nodes
+ * @param lights Refresh light list based on parents'
+ */
+ public void forceRefresh(boolean transforms, boolean bounds, boolean lights) {
+ if (transforms) {
+ setTransformRefresh();
+ }
+ if (bounds) {
+ setBoundRefresh();
+ }
+ if (lights) {
+ setLightListRefresh();
+ }
+ }
+
+ /**
+ * checkCulling checks the spatial with the camera to see if it
+ * should be culled.
+ * Spatial through the
+ * {@link #addLight(com.jme3.light.Light) } and
+ * {@link #removeLight(com.jme3.light.Light) } methods.
+ *
+ * @return The local light list
+ */
+ public LightList getLocalLightList() {
+ return localLights;
+ }
+
+ /**
+ * Returns the world {@link LightList}, containing the lights
+ * combined from all this Spatial's parents up to and including
+ * this Spatial's lights.
+ *
+ * @return The combined world light list
+ */
+ public LightList getWorldLightList() {
+ return worldLights;
+ }
+
+ /**
+ * getWorldRotation retrieves the absolute rotation of the
+ * Spatial.
+ *
+ * @return the Spatial's world rotation quaternion.
+ */
+ public Quaternion getWorldRotation() {
+ checkDoTransformUpdate();
+ return worldTransform.getRotation();
+ }
+
+ /**
+ * getWorldTranslation retrieves the absolute translation of
+ * the spatial.
+ *
+ * @return the Spatial's world tranlsation vector.
+ */
+ public Vector3f getWorldTranslation() {
+ checkDoTransformUpdate();
+ return worldTransform.getTranslation();
+ }
+
+ /**
+ * getWorldScale retrieves the absolute scale factor of the
+ * spatial.
+ *
+ * @return the Spatial's world scale factor.
+ */
+ public Vector3f getWorldScale() {
+ checkDoTransformUpdate();
+ return worldTransform.getScale();
+ }
+
+ /**
+ * getWorldTransform retrieves the world transformation
+ * of the spatial.
+ *
+ * @return the world transform.
+ */
+ public Transform getWorldTransform() {
+ checkDoTransformUpdate();
+ return worldTransform;
+ }
+
+ /**
+ * rotateUpTo is a utility function that alters the
+ * local rotation to point the Y axis in the direction given by newUp.
+ *
+ * @param newUp
+ * the up vector to use - assumed to be a unit vector.
+ */
+ public void rotateUpTo(Vector3f newUp) {
+ TempVars vars = TempVars.get();
+
+ Vector3f compVecA = vars.vect1;
+ Quaternion q = vars.quat1;
+
+ // First figure out the current up vector.
+ Vector3f upY = compVecA.set(Vector3f.UNIT_Y);
+ Quaternion rot = localTransform.getRotation();
+ rot.multLocal(upY);
+
+ // get angle between vectors
+ float angle = upY.angleBetween(newUp);
+
+ // figure out rotation axis by taking cross product
+ Vector3f rotAxis = upY.crossLocal(newUp).normalizeLocal();
+
+ // Build a rotation quat and apply current local rotation.
+ q.fromAngleNormalAxis(angle, rotAxis);
+ q.mult(rot, rot);
+
+ vars.release();
+
+ setTransformRefresh();
+ }
+
+ /**
+ * lookAt is a convenience method for auto-setting the local
+ * rotation based on a position in world space and an up vector. It computes the rotation
+ * to transform the z-axis to point onto 'position' and the y-axis to 'up'.
+ * Unlike {@link Quaternion#lookAt(com.jme3.math.Vector3f, com.jme3.math.Vector3f) }
+ * this method takes a world position to look at and not a relative direction.
+ *
+ * Note : 28/01/2013 this method has been fixed as it was not taking into account the parent rotation.
+ * This was resulting in improper rotation when the spatial had rotated parent nodes.
+ * This method is intended to work in world space, so no matter what parent graph the
+ * spatial has, it will look at the given position in world space.
+ *
+ * @param position
+ * where to look at in terms of world coordinates
+ * @param upVector
+ * a vector indicating the (local) up direction. (typically {0,
+ * 1, 0} in jME.)
+ */
+ public void lookAt(Vector3f position, Vector3f upVector) {
+ Vector3f worldTranslation = getWorldTranslation();
+
+ TempVars vars = TempVars.get();
+
+ Vector3f compVecA = vars.vect4;
+
+ compVecA.set(position).subtractLocal(worldTranslation);
+ getLocalRotation().lookAt(compVecA, upVector);
+
+ if ( getParent() != null ) {
+ Quaternion rot=vars.quat1;
+ rot = rot.set(parent.getWorldRotation()).inverseLocal().multLocal(getLocalRotation());
+ rot.normalizeLocal();
+ setLocalRotation(rot);
+ }
+ vars.release();
+ setTransformRefresh();
+ }
+
+ /**
+ * Should be overridden by Node and Geometry.
+ */
+ protected void updateWorldBound() {
+ // the world bound of a leaf is the same as it's model bound
+ // for a node, the world bound is a combination of all it's children
+ // bounds
+ // -> handled by subclass
+ refreshFlags &= ~RF_BOUND;
+ }
+
+ protected void updateWorldLightList() {
+ if (parent == null) {
+ worldLights.update(localLights, null);
+ refreshFlags &= ~RF_LIGHTLIST;
+ } else {
+ if ((parent.refreshFlags & RF_LIGHTLIST) == 0) {
+ worldLights.update(localLights, parent.worldLights);
+ refreshFlags &= ~RF_LIGHTLIST;
+ } else {
+ assert false;
+ }
+ }
+ }
+
+ /**
+ * Should only be called from updateGeometricState().
+ * In most cases should not be subclassed.
+ */
+ protected void updateWorldTransforms() {
+ if (parent == null) {
+ worldTransform.set(localTransform);
+ refreshFlags &= ~RF_TRANSFORM;
+ } else {
+ // check if transform for parent is updated
+ assert ((parent.refreshFlags & RF_TRANSFORM) == 0);
+ worldTransform.set(localTransform);
+ worldTransform.combineWithParent(parent.worldTransform);
+ refreshFlags &= ~RF_TRANSFORM;
+ }
+ }
+
+ /**
+ * Computes the world transform of this Spatial in the most
+ * efficient manner possible.
+ */
+ void checkDoTransformUpdate() {
+ if ((refreshFlags & RF_TRANSFORM) == 0) {
+ return;
+ }
+
+ if (parent == null) {
+ worldTransform.set(localTransform);
+ refreshFlags &= ~RF_TRANSFORM;
+ } else {
+ TempVars vars = TempVars.get();
+
+ Spatial[] stack = vars.spatialStack;
+ Spatial rootNode = this;
+ int i = 0;
+ while (true) {
+ Spatial hisParent = rootNode.parent;
+ if (hisParent == null) {
+ rootNode.worldTransform.set(rootNode.localTransform);
+ rootNode.refreshFlags &= ~RF_TRANSFORM;
+ i--;
+ break;
+ }
+
+ stack[i] = rootNode;
+
+ if ((hisParent.refreshFlags & RF_TRANSFORM) == 0) {
+ break;
+ }
+
+ rootNode = hisParent;
+ i++;
+ }
+
+ vars.release();
+
+ for (int j = i; j >= 0; j--) {
+ rootNode = stack[j];
+ //rootNode.worldTransform.set(rootNode.localTransform);
+ //rootNode.worldTransform.combineWithParent(rootNode.parent.worldTransform);
+ //rootNode.refreshFlags &= ~RF_TRANSFORM;
+ rootNode.updateWorldTransforms();
+ }
+ }
+ }
+
+ /**
+ * Computes this Spatial's world bounding volume in the most efficient
+ * manner possible.
+ */
+ void checkDoBoundUpdate() {
+ if ((refreshFlags & RF_BOUND) == 0) {
+ return;
+ }
+
+ checkDoTransformUpdate();
+
+ // Go to children recursively and update their bound
+ if (this instanceof Node) {
+ Node node = (Node) this;
+ int len = node.getQuantity();
+ for (int i = 0; i < len; i++) {
+ Spatial child = node.getChild(i);
+ child.checkDoBoundUpdate();
+ }
+ }
+
+ // All children's bounds have been updated. Update my own now.
+ updateWorldBound();
+ }
+
+ private void runControlUpdate(float tpf) {
+ if (controls.isEmpty()) {
+ return;
+ }
+
+ for (Control c : controls.getArray()) {
+ c.update(tpf);
+ }
+ }
+
+ /**
+ * Called when the Spatial is about to be rendered, to notify
+ * controls attached to this Spatial using the Control.render() method.
+ *
+ * @param rm The RenderManager rendering the Spatial.
+ * @param vp The ViewPort to which the Spatial is being rendered to.
+ *
+ * @see Spatial#addControl(com.jme3.scene.control.Control)
+ * @see Spatial#getControl(java.lang.Class)
+ */
+ public void runControlRender(RenderManager rm, ViewPort vp) {
+ if (controls.isEmpty()) {
+ return;
+ }
+
+ for (Control c : controls.getArray()) {
+ c.render(rm, vp);
+ }
+ }
+
+ /**
+ * Add a control to the list of controls.
+ * @param control The control to add.
+ *
+ * @see Spatial#removeControl(java.lang.Class)
+ */
+ public void addControl(Control control) {
+ controls.add(control);
+ control.setSpatial(this);
+ }
+
+ /**
+ * Removes the first control that is an instance of the given class.
+ *
+ * @see Spatial#addControl(com.jme3.scene.control.Control)
+ */
+ public void removeControl(Class controlType) {
+ for (int i = 0; i < controls.size(); i++) {
+ if (controlType.isAssignableFrom(controls.get(i).getClass())) {
+ Control control = controls.remove(i);
+ control.setSpatial(null);
+ }
+ }
+ }
+
+ /**
+ * Removes the given control from this spatial's controls.
+ *
+ * @param control The control to remove
+ * @return True if the control was successfuly removed. False if
+ * the control is not assigned to this spatial.
+ *
+ * @see Spatial#addControl(com.jme3.scene.control.Control)
+ */
+ public boolean removeControl(Control control) {
+ boolean result = controls.remove(control);
+ if (result) {
+ control.setSpatial(null);
+ }
+
+ return result;
+ }
+
+ /**
+ * Returns the first control that is an instance of the given class,
+ * or null if no such control exists.
+ *
+ * @param controlType The superclass of the control to look for.
+ * @return The first instance in the list of the controlType class, or null.
+ *
+ * @see Spatial#addControl(com.jme3.scene.control.Control)
+ */
+ public updateLogicalState calls the update() method
+ * for all controls attached to this Spatial.
+ *
+ * @param tpf Time per frame.
+ *
+ * @see Spatial#addControl(com.jme3.scene.control.Control)
+ */
+ public void updateLogicalState(float tpf) {
+ runControlUpdate(tpf);
+ }
+
+ /**
+ * updateGeometricState updates the lightlist,
+ * computes the world transforms, and computes the world bounds
+ * for this Spatial.
+ * Calling this when the Spatial is attached to a node
+ * will cause undefined results. User code should only call this
+ * method on Spatials having no parent.
+ *
+ * @see Spatial#getWorldLightList()
+ * @see Spatial#getWorldTransform()
+ * @see Spatial#getWorldBound()
+ */
+ public void updateGeometricState() {
+ // assume that this Spatial is a leaf, a proper implementation
+ // for this method should be provided by Node.
+
+ // NOTE: Update world transforms first because
+ // bound transform depends on them.
+ if ((refreshFlags & RF_LIGHTLIST) != 0) {
+ updateWorldLightList();
+ }
+ if ((refreshFlags & RF_TRANSFORM) != 0) {
+ updateWorldTransforms();
+ }
+ if ((refreshFlags & RF_BOUND) != 0) {
+ updateWorldBound();
+ }
+
+ assert refreshFlags == 0;
+ }
+
+ /**
+ * Convert a vector (in) from this spatials' local coordinate space to world
+ * coordinate space.
+ *
+ * @param in
+ * vector to read from
+ * @param store
+ * where to write the result (null to create a new vector, may be
+ * same as in)
+ * @return the result (store)
+ */
+ public Vector3f localToWorld(final Vector3f in, Vector3f store) {
+ checkDoTransformUpdate();
+ return worldTransform.transformVector(in, store);
+ }
+
+ /**
+ * Convert a vector (in) from world coordinate space to this spatials' local
+ * coordinate space.
+ *
+ * @param in
+ * vector to read from
+ * @param store
+ * where to write the result
+ * @return the result (store)
+ */
+ public Vector3f worldToLocal(final Vector3f in, final Vector3f store) {
+ checkDoTransformUpdate();
+ return worldTransform.transformInverseVector(in, store);
+ }
+
+ /**
+ * getParent retrieves this node's parent. If the parent is
+ * null this is the root node.
+ *
+ * @return the parent of this node.
+ */
+ public Node getParent() {
+ return parent;
+ }
+
+ /**
+ * Called by {@link Node#attachChild(Spatial)} and
+ * {@link Node#detachChild(Spatial)} - don't call directly.
+ * setParent sets the parent of this node.
+ *
+ * @param parent
+ * the parent of this node.
+ */
+ protected void setParent(Node parent) {
+ this.parent = parent;
+ }
+
+ /**
+ * removeFromParent removes this Spatial from it's parent.
+ *
+ * @return true if it has a parent and performed the remove.
+ */
+ public boolean removeFromParent() {
+ if (parent != null) {
+ parent.detachChild(this);
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * determines if the provided Node is the parent, or parent's parent, etc. of this Spatial.
+ *
+ * @param ancestor
+ * the ancestor object to look for.
+ * @return true if the ancestor is found, false otherwise.
+ */
+ public boolean hasAncestor(Node ancestor) {
+ if (parent == null) {
+ return false;
+ } else if (parent.equals(ancestor)) {
+ return true;
+ } else {
+ return parent.hasAncestor(ancestor);
+ }
+ }
+
+ /**
+ * getLocalRotation retrieves the local rotation of this
+ * node.
+ *
+ * @return the local rotation of this node.
+ */
+ public Quaternion getLocalRotation() {
+ return localTransform.getRotation();
+ }
+
+ /**
+ * setLocalRotation sets the local rotation of this node
+ * by using a {@link Matrix3f}.
+ *
+ * @param rotation
+ * the new local rotation.
+ */
+ public void setLocalRotation(Matrix3f rotation) {
+ localTransform.getRotation().fromRotationMatrix(rotation);
+ setTransformRefresh();
+ }
+
+ /**
+ * setLocalRotation sets the local rotation of this node.
+ *
+ * @param quaternion
+ * the new local rotation.
+ */
+ public void setLocalRotation(Quaternion quaternion) {
+ localTransform.setRotation(quaternion);
+ setTransformRefresh();
+ }
+
+ /**
+ * getLocalScale retrieves the local scale of this node.
+ *
+ * @return the local scale of this node.
+ */
+ public Vector3f getLocalScale() {
+ return localTransform.getScale();
+ }
+
+ /**
+ * setLocalScale sets the local scale of this node.
+ *
+ * @param localScale
+ * the new local scale, applied to x, y and z
+ */
+ public void setLocalScale(float localScale) {
+ localTransform.setScale(localScale);
+ setTransformRefresh();
+ }
+
+ /**
+ * setLocalScale sets the local scale of this node.
+ */
+ public void setLocalScale(float x, float y, float z) {
+ localTransform.setScale(x, y, z);
+ setTransformRefresh();
+ }
+
+ /**
+ * setLocalScale sets the local scale of this node.
+ *
+ * @param localScale
+ * the new local scale.
+ */
+ public void setLocalScale(Vector3f localScale) {
+ localTransform.setScale(localScale);
+ setTransformRefresh();
+ }
+
+ /**
+ * getLocalTranslation retrieves the local translation of
+ * this node.
+ *
+ * @return the local translation of this node.
+ */
+ public Vector3f getLocalTranslation() {
+ return localTransform.getTranslation();
+ }
+
+ /**
+ * setLocalTranslation sets the local translation of this
+ * spatial.
+ *
+ * @param localTranslation
+ * the local translation of this spatial.
+ */
+ public void setLocalTranslation(Vector3f localTranslation) {
+ this.localTransform.setTranslation(localTranslation);
+ setTransformRefresh();
+ }
+
+ /**
+ * setLocalTranslation sets the local translation of this
+ * spatial.
+ */
+ public void setLocalTranslation(float x, float y, float z) {
+ this.localTransform.setTranslation(x, y, z);
+ setTransformRefresh();
+ }
+
+ /**
+ * setLocalTransform sets the local transform of this
+ * spatial.
+ */
+ public void setLocalTransform(Transform t) {
+ this.localTransform.set(t);
+ setTransformRefresh();
+ }
+
+ /**
+ * getLocalTransform retrieves the local transform of
+ * this spatial.
+ *
+ * @return the local transform of this spatial.
+ */
+ public Transform getLocalTransform() {
+ return localTransform;
+ }
+
+ /**
+ * Applies the given material to the Spatial, this will propagate the
+ * material down to the geometries in the scene graph.
+ *
+ * @param material The material to set.
+ */
+ public void setMaterial(Material material) {
+ }
+
+ /**
+ * addLight adds the given light to the Spatial; causing
+ * all child Spatials to be effected by it.
+ *
+ * @param light The light to add.
+ */
+ public void addLight(Light light) {
+ localLights.add(light);
+ setLightListRefresh();
+ }
+
+ /**
+ * removeLight removes the given light from the Spatial.
+ *
+ * @param light The light to remove.
+ * @see Spatial#addLight(com.jme3.light.Light)
+ */
+ public void removeLight(Light light) {
+ localLights.remove(light);
+ setLightListRefresh();
+ }
+
+ /**
+ * Translates the spatial by the given translation vector.
+ *
+ * @return The spatial on which this method is called, e.g this.
+ */
+ public Spatial move(float x, float y, float z) {
+ this.localTransform.getTranslation().addLocal(x, y, z);
+ setTransformRefresh();
+
+ return this;
+ }
+
+ /**
+ * Translates the spatial by the given translation vector.
+ *
+ * @return The spatial on which this method is called, e.g this.
+ */
+ public Spatial move(Vector3f offset) {
+ this.localTransform.getTranslation().addLocal(offset);
+ setTransformRefresh();
+
+ return this;
+ }
+
+ /**
+ * Scales the spatial by the given value
+ *
+ * @return The spatial on which this method is called, e.g this.
+ */
+ public Spatial scale(float s) {
+ return scale(s, s, s);
+ }
+
+ /**
+ * Scales the spatial by the given scale vector.
+ *
+ * @return The spatial on which this method is called, e.g this.
+ */
+ public Spatial scale(float x, float y, float z) {
+ this.localTransform.getScale().multLocal(x, y, z);
+ setTransformRefresh();
+
+ return this;
+ }
+
+ /**
+ * Rotates the spatial by the given rotation.
+ *
+ * @return The spatial on which this method is called, e.g this.
+ */
+ public Spatial rotate(Quaternion rot) {
+ this.localTransform.getRotation().multLocal(rot);
+ setTransformRefresh();
+
+ return this;
+ }
+
+ /**
+ * Rotates the spatial by the xAngle, yAngle and zAngle angles (in radians),
+ * (aka pitch, yaw, roll) in the local coordinate space.
+ *
+ * @return The spatial on which this method is called, e.g this.
+ */
+ public Spatial rotate(float xAngle, float yAngle, float zAngle) {
+ TempVars vars = TempVars.get();
+ Quaternion q = vars.quat1;
+ q.fromAngles(xAngle, yAngle, zAngle);
+ rotate(q);
+ vars.release();
+
+ return this;
+ }
+
+ /**
+ * Centers the spatial in the origin of the world bound.
+ * @return The spatial on which this method is called, e.g this.
+ */
+ public Spatial center() {
+ Vector3f worldTrans = getWorldTranslation();
+ Vector3f worldCenter = getWorldBound().getCenter();
+
+ Vector3f absTrans = worldTrans.subtract(worldCenter);
+ setLocalTranslation(absTrans);
+
+ return this;
+ }
+
+ /**
+ * @see #setCullHint(CullHint)
+ * @return the cull mode of this spatial, or if set to CullHint.Inherit,
+ * the cullmode of it's parent.
+ */
+ public CullHint getCullHint() {
+ if (cullHint != CullHint.Inherit) {
+ return cullHint;
+ } else if (parent != null) {
+ return parent.getCullHint();
+ } else {
+ return CullHint.Dynamic;
+ }
+ }
+
+ public BatchHint getBatchHint() {
+ if (batchHint != BatchHint.Inherit) {
+ return batchHint;
+ } else if (parent != null) {
+ return parent.getBatchHint();
+ } else {
+ return BatchHint.Always;
+ }
+ }
+
+ /**
+ * Returns this spatial's renderqueue bucket. If the mode is set to inherit,
+ * then the spatial gets its renderqueue bucket from its parent.
+ *
+ * @return The spatial's current renderqueue mode.
+ */
+ public RenderQueue.Bucket getQueueBucket() {
+ if (queueBucket != RenderQueue.Bucket.Inherit) {
+ return queueBucket;
+ } else if (parent != null) {
+ return parent.getQueueBucket();
+ } else {
+ return RenderQueue.Bucket.Opaque;
+ }
+ }
+
+ /**
+ * @return The shadow mode of this spatial, if the local shadow
+ * mode is set to inherit, then the parent's shadow mode is returned.
+ *
+ * @see Spatial#setShadowMode(com.jme3.renderer.queue.RenderQueue.ShadowMode)
+ * @see ShadowMode
+ */
+ public RenderQueue.ShadowMode getShadowMode() {
+ if (shadowMode != RenderQueue.ShadowMode.Inherit) {
+ return shadowMode;
+ } else if (parent != null) {
+ return parent.getShadowMode();
+ } else {
+ return ShadowMode.Off;
+ }
+ }
+
+ /**
+ * Sets the level of detail to use when rendering this Spatial,
+ * this call propagates to all geometries under this Spatial.
+ *
+ * @param lod The lod level to set.
+ */
+ public void setLodLevel(int lod) {
+ }
+
+ /**
+ * updateModelBound recalculates the bounding object for this
+ * Spatial.
+ */
+ public abstract void updateModelBound();
+
+ /**
+ * setModelBound sets the bounding object for this Spatial.
+ *
+ * @param modelBound
+ * the bounding object for this spatial.
+ */
+ public abstract void setModelBound(BoundingVolume modelBound);
+
+ /**
+ * @return The sum of all verticies under this Spatial.
+ */
+ public abstract int getVertexCount();
+
+ /**
+ * @return The sum of all triangles under this Spatial.
+ */
+ public abstract int getTriangleCount();
+
+ /**
+ * @return A clone of this Spatial, the scene graph in its entirety
+ * is cloned and can be altered independently of the original scene graph.
+ *
+ * Note that meshes of geometries are not cloned explicitly, they
+ * are shared if static, or specially cloned if animated.
+ *
+ * All controls will be cloned using the Control.cloneForSpatial method
+ * on the clone.
+ *
+ * @see Mesh#cloneForAnim()
+ */
+ public Spatial clone(boolean cloneMaterial) {
+ try {
+ Spatial clone = (Spatial) super.clone();
+ if (worldBound != null) {
+ clone.worldBound = worldBound.clone();
+ }
+ clone.worldLights = worldLights.clone();
+ clone.localLights = localLights.clone();
+
+ // Set the new owner of the light lists
+ clone.localLights.setOwner(clone);
+ clone.worldLights.setOwner(clone);
+
+ // No need to force cloned to update.
+ // This node already has the refresh flags
+ // set below so it will have to update anyway.
+ clone.worldTransform = worldTransform.clone();
+ clone.localTransform = localTransform.clone();
+
+ if (clone instanceof Node) {
+ Node node = (Node) this;
+ Node nodeClone = (Node) clone;
+ nodeClone.children = new SafeArrayListgetWorldBound retrieves the world bound at this node
+ * level.
+ *
+ * @return the world bound at this level.
+ */
+ public BoundingVolume getWorldBound() {
+ checkDoBoundUpdate();
+ return worldBound;
+ }
+
+ /**
+ * setCullHint alters how view frustum culling will treat this
+ * spatial.
+ *
+ * @param hint one of: CullHint.Dynamic,
+ * CullHint.Always, CullHint.Inherit, or
+ * CullHint.Never
+ * setBatchHint alters how batching will treat this spatial.
+ *
+ * @param hint one of: BatchHint.Never,
+ * BatchHint.Always, or BatchHint.Inherit
+ * setQueueBucket determines at what phase of the
+ * rendering process this Spatial will rendered. See the
+ * {@link Bucket} enum for an explanation of the various
+ * render queue buckets.
+ *
+ * @param queueBucket
+ * The bucket to use for this Spatial.
+ */
+ public void setQueueBucket(RenderQueue.Bucket queueBucket) {
+ this.queueBucket = queueBucket;
+ }
+
+ /**
+ * Sets the shadow mode of the spatial
+ * The shadow mode determines how the spatial should be shadowed,
+ * when a shadowing technique is used. See the
+ * documentation for the class {@link ShadowMode} for more information.
+ *
+ * @see ShadowMode
+ *
+ * @param shadowMode The local shadow mode to set.
+ */
+ public void setShadowMode(RenderQueue.ShadowMode shadowMode) {
+ this.shadowMode = shadowMode;
+ }
+
+ /**
+ * @return The locally set queue bucket mode
+ *
+ * @see Spatial#setQueueBucket(com.jme3.renderer.queue.RenderQueue.Bucket)
+ */
+ public RenderQueue.Bucket getLocalQueueBucket() {
+ return queueBucket;
+ }
+
+ /**
+ * @return The locally set shadow mode
+ *
+ * @see Spatial#setShadowMode(com.jme3.renderer.queue.RenderQueue.ShadowMode)
+ */
+ public RenderQueue.ShadowMode getLocalShadowMode() {
+ return shadowMode;
+ }
+
+ /**
+ * Returns this spatial's last frustum intersection result. This int is set
+ * when a check is made to determine if the bounds of the object fall inside
+ * a camera's frustum. If a parent is found to fall outside the frustum, the
+ * value for this spatial will not be updated.
+ *
+ * @return The spatial's last frustum intersection result.
+ */
+ public Camera.FrustumIntersect getLastFrustumIntersection() {
+ return frustrumIntersects;
+ }
+
+ /**
+ * Overrides the last intersection result. This is useful for operations
+ * that want to start rendering at the middle of a scene tree and don't want
+ * the parent of that node to influence culling.
+ *
+ * @param intersects
+ * the new value
+ */
+ public void setLastFrustumIntersection(Camera.FrustumIntersect intersects) {
+ frustrumIntersects = intersects;
+ }
+
+ /**
+ * Returns the Spatial's name followed by the class of the spatial
+ * Example: "MyNode (com.jme3.scene.Spatial)
+ *
+ * @return Spatial's name followed by the class of the Spatial
+ */
+ @Override
+ public String toString() {
+ return name + " (" + this.getClass().getSimpleName() + ')';
+ }
+
+ /**
+ * Creates a transform matrix that will convert from this spatials'
+ * local coordinate space to the world coordinate space
+ * based on the world transform.
+ *
+ * @param store Matrix where to store the result, if null, a new one
+ * will be created and returned.
+ *
+ * @return store if not null, otherwise, a new matrix containing the result.
+ *
+ * @see Spatial#getWorldTransform()
+ */
+ public Matrix4f getLocalToWorldMatrix(Matrix4f store) {
+ if (store == null) {
+ store = new Matrix4f();
+ } else {
+ store.loadIdentity();
+ }
+ // multiply with scale first, then rotate, finally translate (cf.
+ // Eberly)
+ store.scale(getWorldScale());
+ store.multLocal(getWorldRotation());
+ store.setTranslation(getWorldTranslation());
+ return store;
+ }
+
+ /**
+ * Visit each scene graph element ordered by DFS
+ * @param visitor
+ */
+ public abstract void depthFirstTraversal(SceneGraphVisitor visitor);
+
+ /**
+ * Visit each scene graph element ordered by BFS
+ * @param visitor
+ */
+ public void breadthFirstTraversal(SceneGraphVisitor visitor) {
+ QueueSkyFactory is used to create jME {@link Spatial}s that can
- * be attached to the scene to display a sky image in the background.
- *
- * @author Kirill Vainer
- */
-public class SkyFactory {
-
- /**
- * Creates a sky using the given texture (cubemap or spheremap).
- *
- * @param assetManager The asset manager to use to load materials
- * @param texture Texture to use for the sky
- * @param normalScale The normal scale is multiplied by the 3D normal
- * to get a texture coordinate. Use Vector3f.UNIT_XYZ to not apply
- * and transformation to the normal.
- * @param sphereMap The way the texture is used
- * depends on this value:
- *
- *
- * @return A spatial representing the sky
- */
- public static Spatial createSky(AssetManager assetManager, Texture texture, Vector3f normalScale, boolean sphereMap) {
- return createSky(assetManager, texture, normalScale, sphereMap, 10);
- }
-
- /**
- * Creates a sky using the given texture (cubemap or spheremap).
- *
- * @param assetManager The asset manager to use to load materials
- * @param texture Texture to use for the sky
- * @param normalScale The normal scale is multiplied by the 3D normal
- * to get a texture coordinate. Use Vector3f.UNIT_XYZ to not apply
- * and transformation to the normal.
- * @param sphereMap The way the texture is used
- * depends on this value:
- *
- *
- * @param sphereRadius If specified, this will be the sky sphere's radius.
- * This should be the camera's near plane for optimal quality.
- * @return A spatial representing the sky
- */
- public static Spatial createSky(AssetManager assetManager, Texture texture, Vector3f normalScale, boolean sphereMap, int sphereRadius) {
- if (texture == null) {
- throw new IllegalArgumentException("texture cannot be null");
- }
- final Sphere sphereMesh = new Sphere(10, 10, sphereRadius, false, true);
-
- Geometry sky = new Geometry("Sky", sphereMesh);
- sky.setQueueBucket(Bucket.Sky);
- sky.setCullHint(Spatial.CullHint.Never);
- sky.setModelBound(new BoundingSphere(Float.POSITIVE_INFINITY, Vector3f.ZERO));
-
- Material skyMat = new Material(assetManager, "Common/MatDefs/Misc/Sky.j3md");
-
- skyMat.setVector3("NormalScale", normalScale);
- if (sphereMap) {
- skyMat.setBoolean("SphereMap", sphereMap);
- } else if (!(texture instanceof TextureCubeMap)) {
- // make sure its a cubemap
- Image img = texture.getImage();
- texture = new TextureCubeMap();
- texture.setImage(img);
- }
- skyMat.setTexture("Texture", texture);
- sky.setMaterial(skyMat);
-
- return sky;
- }
-
- private static void checkImage(Image image) {
-// if (image.getDepth() != 1)
-// throw new IllegalArgumentException("3D/Array images not allowed");
-
- if (image.getWidth() != image.getHeight()) {
- throw new IllegalArgumentException("Image width and height must be the same");
- }
-
- if (image.getMultiSamples() != 1) {
- throw new IllegalArgumentException("Multisample textures not allowed");
- }
- }
-
- private static void checkImagesForCubeMap(Image... images) {
- if (images.length == 1) {
- return;
- }
-
- Format fmt = images[0].getFormat();
- int width = images[0].getWidth();
- int height = images[0].getHeight();
-
- ByteBuffer data = images[0].getData(0);
- int size = data != null ? data.capacity() : 0;
-
- checkImage(images[0]);
-
- for (int i = 1; i < images.length; i++) {
- Image image = images[i];
- checkImage(images[i]);
- if (image.getFormat() != fmt) {
- throw new IllegalArgumentException("Images must have same format");
- }
- if (image.getWidth() != width || image.getHeight() != height) {
- throw new IllegalArgumentException("Images must have same resolution");
- }
- ByteBuffer data2 = image.getData(0);
- if (data2 != null){
- if (data2.capacity() != size) {
- throw new IllegalArgumentException("Images must have same size");
- }
- }
- }
- }
-
- public static Spatial createSky(AssetManager assetManager, Texture west, Texture east, Texture north, Texture south, Texture up, Texture down, Vector3f normalScale) {
- return createSky(assetManager, west, east, north, south, up, down, normalScale, 10);
- }
-
- public static Spatial createSky(AssetManager assetManager, Texture west, Texture east, Texture north, Texture south, Texture up, Texture down, Vector3f normalScale, int sphereRadius) {
- final Sphere sphereMesh = new Sphere(10, 10, sphereRadius, false, true);
- Geometry sky = new Geometry("Sky", sphereMesh);
- sky.setQueueBucket(Bucket.Sky);
- sky.setCullHint(Spatial.CullHint.Never);
- sky.setModelBound(new BoundingSphere(Float.POSITIVE_INFINITY, Vector3f.ZERO));
-
- Image westImg = west.getImage();
- Image eastImg = east.getImage();
- Image northImg = north.getImage();
- Image southImg = south.getImage();
- Image upImg = up.getImage();
- Image downImg = down.getImage();
-
- checkImagesForCubeMap(westImg, eastImg, northImg, southImg, upImg, downImg);
-
- Image cubeImage = new Image(westImg.getFormat(), westImg.getWidth(), westImg.getHeight(), null);
-
- cubeImage.addData(westImg.getData(0));
- cubeImage.addData(eastImg.getData(0));
-
- cubeImage.addData(downImg.getData(0));
- cubeImage.addData(upImg.getData(0));
-
- cubeImage.addData(southImg.getData(0));
- cubeImage.addData(northImg.getData(0));
-
- if (westImg.getEfficentData() != null){
- // also consilidate efficient data
- ArrayListcom.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.)
+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.)
Overview
Use Case Examples
Supported Features
Usage
stateManager.detach(myAppState);) and clean it up it.stateManager.detach(myAppState);) and clean it up.Code Samples
AppState
The AppState knows when it is attached to, or detache
postRender() Called after all rendering commands are flushed, including your optional customizations. (Typically not used.)
AbstractAppState
Pausing and Unpausing
setEnable
AppStateManager
getState(MyAppState.class) Returns the first attached state that is an instance of a subclass of
MyAppState.class.render(), postRender(), cleanup() methods are internal, ignore them, users never call them directly.
@@ -299,12 +299,12 @@ The AppStateManager's render(), postRender(), cleanup() method
-
+
Best Practices
Communication Among AppStates
this.app.getStateManager().getState(MyAppState.class).doSomeCustomStuffInThisState();
Initialize Familiar Class Fields
AudioNode Method Usage
-
getStatus() Returns either Status.Playing, Status.Stopped, or Status.Paused.
+ getStatus() Returns either AudioSource.Status.Playing, AudioSource.Status.Stopped, or AudioSource.Status.Paused.
-
+
getVolume() Returns the volume.
@@ -59,14 +59,13 @@ AudioNode boom = new AudioNode(assetManager, "Sound/boom.wav", fal
getPitch() Returns the pitch.
Setting AudioNode Properties
@@ -92,9 +91,9 @@ Note: There are other obvious getters to poll the status of all corresponding se
setLooping(false) Configures the sound so that, if it is played, it plays once and stops. No looping is the default.
Looping & Ambient Sounds
@@ -110,9 +109,9 @@ setDirectional(false)
All 3D effects switched off. This sound is global
Looping does not work on streamed sounds.
Positional 3D Sounds
@@ -127,7 +126,7 @@ setLocalTranslation(???)
Activates 3D audio: The sound appears to come f
setReverbEnabled(true) Reverb is a 3D echo effect that only makes sense with positional AudioNodes. Use Audio Environments to make scenes sound as if they were "outdoors", or "indoors" in a large or small room, etc. The reverb effect is defined by the
com.jme3.audio.Environment that the audioRenderer is in. See "Setting Audio Environment Properties" below. AudioListener object in the scene (representing the player's ears).
@@ -135,7 +134,7 @@ setLocalTranslation(???)Activates 3D audio: The sound appears to come f
-
+
Directional 3D Sounds
@@ -151,7 +150,7 @@ setDirection(???)
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!
Set the angle in degrees for the directional audio. The
-
+
Play, Pause, Stop
playInstance
myAudioNode.playInstance();
The Audio Listener
listener in SimpleApplicatio
}
Setting Audio Environment Properties
c
Closet 1.00f 1.0f 1.0f 1.00f 0.15f 1.0f 0.600f 0.0025f 0.500f 0.0006f
+
-
+
audioRenderer.setEnvironment(new Environment(Environment.Dungeon));
@@ -266,5 +265,5 @@ Advanced users find more info about OpenAL and its features here: Client and Server
Creating a Server
Creating a Client
Getting Info About a Client
myServer.getConnection(0) Server gets the first (0), second (1), etc, connected HostedConnection object (one client).
MyState in the HostedConnection object conn:
@@ -175,14 +177,14 @@ Your game can define its own game data based on whatever criteria you want, typi
MyState state = conn.getAttribute("MyState") Server can read an attribute of the HostedConnection.
-
+
-
+
Messaging
Creating Message Types
Serializer.registerClass(HelloMessage.class);
Responding to Messages
myServer.addMessageListener(new ServerListener(), HelloMessage.class);
Creating and Sending Messages
Identification and Rejection
... myClient.getId() ...
Closing Clients and Server Cleanly
Closing a Client
Closing a Server
Kicking a Client
conn.close("We kick cheaters.");
Listening to Connection Notification
ClientStateListener
@@ -395,7 +403,7 @@ The com.jme3.network.ClientStateListener notifies the Client when the Client has
public void clientDisconnected(Client c, DisconnectInfo info){} Implement here what happens after the server kicks this client. For example, display the DisconnectInfo to the user.
myClient.addClientStateListener(this);
ConnectionListener
public void connectionRemoved(Server s, HostedConnection c){} Implement here what happens after a HostedConnection has left. E.g. a player has quit the game and the server removes his character.
myServer.addConnectionListener(this);
-
+
+ErrorListener
+
+
+
+ ErrorListener interface method Purpose
+
+
+ public void handleError(Client c, Throwable t){} Implemenent here what happens after a exception affects the network .
+ myClient.addErrorListener(this);
+
+if(t instanceof exception) {
+ //Add your own code here
+}
+
+UDP versus TCP
Important: Use Multi-Threading
Next Steps
Nifty Logging (Nifty 1.3.1)
ScreenController to every NiftyGUI screen. You create a ScreenController by creating a Java class that implements the de.lessvoid.nifty.screen.ScreenController interface and its abtract methods.
+To let a Nifty screen communicate with the Java application, you register a ScreenController to every NiftyGUI screen. You create a ScreenController by creating a Java class that implements the de.lessvoid.nifty.screen.ScreenController interface and its abstract methods.
MyStartScreen and this
+
Make GUI and Java Interact
GUI Calls a Void Java Method
app
GUI Gets Return Value from Java Method
Java Modifies Nifty Elements and Events
<inte
<interact onClick="doNothing()"/>
Next Steps
public class TestNiftyGui extends SimpleApplication {
+ public void simpleInitApp() {
+ StartScreenState startScreenState = new StartScreenState(this);
+ stateManager.attach(startScreenState);
+ // [...] boilerplate init nifty omitted
+ nifty.fromXml("Interface/myGui.xml", "start", startScreenState); //one of the XML screen elements needs to reference StartScreenState controller class
+ }
+}
+
-
+
Know Your Variables
@@ -125,14 +139,14 @@ public StartScreenState(SimpleApplication app){
${PROP.key} looks up
key in the Nifty properties. Use Nifty.setGlobalproperties(properties) and Nifty.getGlobalproperties("key"). Or SystemGetProperties(key);Use ScreenControllers for Mutally Exclusive Functionality
MyHudScreen.java for the hud scr
Create a "Loading..." Screen
Create a Popup Menu
Add Visual Effects
Add Sound Effects
playSound effect
</label>
Pass ClickLoc From Nifty to Java
clicked) what ever you like, as long
Load Several XML Files
Register additional explicit screen controllers
Design Your Own Styles
<?xml version="1.0" encoding="UTF-8"?>
<nifty xmlns="http://nifty-gui.sourceforge.net/nifty-1.3.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://nifty-gui.sourceforge.net/nifty-1.3.xsd http://nifty-gui.sourceforge.net/nifty-1.3.xsd">
+ xsi:schemaLocation="http://nifty-gui.sourceforge.net/nifty-1.3.xsd">
<screen id="start">
<!-- ... -->
</screen>
@@ -118,7 +118,7 @@ Every Nifty GUI must have a
-
+
Make Layers
Make Panels
Adding Content to Panels
Add Images
Add Static Text
Add Controls
Intermediate Result
Next Steps
PhysicsControls Code Samples
+Physics Control Code Samples
RigidBodyControl myThing_phys =
new RigidBodyControl( myThing_shape , 123.0f ); // dynamic
@@ -373,7 +373,7 @@ The PhysicsControl constructors expect a Collision Shape and a mass (a float in
new RigidBodyControl( myDungeon_shape , 0.0f ); // static
Add PhysicsControl to Spatial
Add PhysicsControl to PhysicsSpace
Changing the Scale of a PhysicsControl
PhysicsSpace Code Samples
Specifies the size
setCcdMotionThreshold() The amount of motion in 1 physics tick to trigger the continuous motion detection in moving objects that push one another. Rarely used, but necessary if your moving objects get stuck or roll through one another.
Specify Physical Properties
Brick:
Rubber ball: 1.0f
Kinematic vs Dynamic vs Static
setMass(1f);
setKinematic(false);When Do I Use Kinematic Objects?
@@ -649,7 +650,7 @@ setKinematic(false);
Forces: Moving Dynamic Objects
clearForces() Cancels out all forces (force, torque) etc and stops the motion.
Collision Groups are integer
setCcdSweptSphereRadius(.5f) Bullet does not use the full collision shape for continuous collision detection, instead it uses a "swept sphere" shape to approximate a motion, which can be imprecise and cause strange behaviors such as objects passing through one another or getting stuck. Only relevant for fast moving dynamic bodies.
setApplyPhysicsLocal(true) for an object to make it move relatively to its local physics space. You would do that if you need a physics space that moves with a node (e.g. a spaceship with artificial gravity surrounded by zero-g space). By default, it's set to false, and all movement is relative to the world.
@@ -735,7 +736,7 @@ removeCollideWithGroup(COLLISION_GROUP_01)Collision Groups are integer
-
+
Best Practices
@@ -771,7 +772,7 @@ removeCollideWithGroup(COLLISION_GROUP_01)
Collision Groups are integer
- This normal
water.setWaterColor(ColorRGBA.Brown.mult(2.0f)); Sets the main water color. greenish blue
+ColorRGBA(0.0f,0.5f,0.5f,1.0f)
-Vector3f(0.0f,0.5f,0.5f,1.0f)
water.setDeepWaterColor(ColorRGBA.Brown); Sets the deep water color. dark blue
+ColorRGBA(0.0f, 0.0f,0.2f,1.0f)
-Vector3f(0.0f, 0.0f,0.2f,1.0f)
water.setWaterTransparency(0.2f); Sets how fast colors fade out. use this to control how clear (e.g. 0.05f) or muddy (0.2f) water is. 0.1f
@@ -201,7 +201,7 @@ Vector3f(0.0f, 0.0f,0.2f,1.0f)
water.setColorExtinction(new Vector3f(10f,20f,30f)); Sets At what depth the refraction color extincts. The three values are RGB (red, green, blue) in this order. Play with these parameters to "muddy" the water. Vector3f(5f,20f,30f)
+
@@ -216,7 +216,7 @@ water.setRadius(260); Water method example Effects: Shore Default
Limit the water filter to a semisphere with the gi
water.setUseHQShoreline(false); Renders shoreline with better quality ? true
+
@@ -234,7 +234,7 @@ water.setRadius(260); Water method example Effects: Foam Default
Limit the water filter to a semisphere with the gi
manager.loadTexture("Textures/foam.png") ) This foam texture will be used with WrapMode.Repeat "Common/MatDefs/Water/Textures/foam.jpg"
+
@@ -260,9 +260,9 @@ manager.loadTexture("Textures/foam.png") ) Water method example Effects: Light Default
This foam texture w
water.setReflectionMapSize(256) Sets the size of the reflection map. The higher, the better the quality, but the slower the effect. 512
Sound Effects
-
-
+
Overview
Current Features:
@@ -55,7 +55,7 @@ TerraMonkey is a GeoMipMapping quad tree of terrain tiles that supports real tim
Planned Features:
@@ -66,7 +66,7 @@ TerraMonkey is a GeoMipMapping quad tree of terrain tiles that supports real tim
Sample Code
@@ -83,7 +83,7 @@ TerraMonkey is a GeoMipMapping quad tree of terrain tiles that supports real tim
Geo Mip Mapping
Terrain Quad Tree
Texture Splatting
Code Sample: Terrain.j3md
heightmap = new HillHeightMap(1025, 1000, 50, 100, (byte) 3);
See also
+
+
The Asset Manager
MyGame/assets/Interface/
+
MyGame/assets/
+MyGame/assets/Interface/
MyGame/assets/MatDefs/
MyGame/assets/Materials/
-MyGame/assets/Models/
+MyGame/assets/Models/ <-- your .j3o models go here
MyGame/assets/Scenes/
MyGame/assets/Shaders/
-MyGame/assets/Sounds/
-MyGame/assets/Textures/
-MyGame/build.xml <-- Ant build script
-MyGame/src/... <-- Java sources go here
+MyGame/assets/Sounds/ <-- your audio files go here
+MyGame/assets/Textures/ <-- your textures go here
+MyGame/build.xml <-- Default Ant build script
+MyGame/src/... <-- your Java sources go here
MyGame/...
Loading Textures
assets/Textures/. Load the texture into the material before you set the Material. The following code sample is from the simpleInitApp() method and loads a simple wall model:
// Create a wall with a simple texture from test_data
-Box box = new Box(Vector3f.ZERO, 2.5f,2.5f,1.0f);
+Box box = new Box(2.5f,2.5f,1.0f);
Spatial wall = new Geometry("Box", box );
Material mat_brick = new Material(
assetManager, "Common/MatDefs/Misc/Unshaded.j3md");
@@ -156,7 +157,7 @@ In this case, you
Loading Text and Fonts
Loading a Model
Loading Assets From Custom Paths
Creating Models and Scenes
Model File Formats
+
loadModel() method loads these original file formats when you run your code directly from the SDK. If you however build the executables using the default build script, then the original model files (XML, OBJ, etc) are not included. This means, when you run the executable outside the SDK, and load any original models directly, you get the following error message:
com.jme3.asset.DesktopAssetManager loadAsset
WARNING: Cannot locate resource: Models/Ninja/Ninja.mesh.xml
@@ -291,11 +304,11 @@ SEVERE: Uncaught exception thrown in Thread[LWJGL Renderer Thread,5,main]
java.lang.NullPointerException
Loading Models and Scenes
@@ -346,9 +361,9 @@ rootNode.attachChild(scene);
Excercise - How to Load Assets
assets/Scenes/town directory. main.scene and convert the scene to binary: The jMoneyPlatform generates a main.j3o file.main.scene and convert the scene to binary: The jMonkeyPlatform generates a main.j3o file.simpleInitApp() { Spatial gameLevel = assetManager.loadModel("Scenes/town/main.j3o");
gameLevel.setLocalTranslation(0, -5.2f, 0);
@@ -453,7 +468,7 @@ Again, you should see the Ninja+wall+teapot standing in a town. Conclusion
-
+
Understanding the Code Sample
initAudio() to learn how to use AudioNodes
audio_gun.setLooping(false);
+
audio_gun.setPositional(false);
+ audio_gun.setLooping(false);
audio_gun.setVolume(2);
rootNode.attachChild(audio_gun);
+Triggering Sound
initKeys(): As you learned in previous tutorials, you use the inputManager to respond to user input. Here you add a mapping for a left mouse button click, and name this new action Shoot.
- /** Declaring "Shoot" action, mapping it to a trigger (mouse click). */
+
/** Declaring "Shoot" action, mapping it to a trigger (mouse left click). */
private void initKeys() {
- inputManager.addMapping("Shoot", new MouseButtonTrigger(0));
+ inputManager.addMapping("Shoot", new MouseButtonTrigger(MouseInput.BUTTON_LEFT));
inputManager.addListener(actionListener, "Shoot");
}
@@ -213,10 +219,11 @@ Setting up the ActionListener should also be familiar from previous tutorials. Y
playInstance() method. This means that every click starts a new instance of the sound, so two instances can overlap. You set this sound not to loop, so each instance only plays once. As you would expect it of a gunshot.
+
Ambient or Situational?
play().playIns
Buffered or Streaming?
play().playIns
The Boolean in the AudioNode constructor defines whether the audio is buffered (false) or streamed (true). For example:
-audio_nature = new AudioNode(assetManager, "Sound/Effects/Gun.wav", false); // buffered
+
audio_gunshot = new AudioNode(assetManager, "Sound/Effects/Gun.wav", false); // buffered
...
audio_nature = new AudioNode(assetManager, "Sound/Environment/Nature.ogg", true); // streamed
@@ -288,7 +295,7 @@ Note that streamed sounds can not loop (i.e. setLooping will not work as you exp
Play() or PlayInstance()?
@@ -305,9 +312,9 @@ Note that streamed sounds can not loop (i.e. setLooping will not work as you exp
The same sound cannot play twice at the same time. The same sounds can play multiple times and overlap.
Your Ear in the Scene
Global, Directional, Positional?
Conclusion
+
Understanding the Code
walkDirection and the four Booleans are used for physics-controlled navigation.Initializing the Game
simpleInitApp() method.
The Physics-Controlled Scene
sceneModel
The Physics-Controlled Player
PhysicsSpace
Navigation
1. inputManager
setupKeys()
2. onAction()
3. setWalkDirection()
onAction() method, you have collected the info in
simpleUpdate() method.
public void simpleUpdate(float tpf) {
- Vector3f camDir = cam.getDirection().clone().multLocal(0.6f);
- Vector3f camLeft = cam.getLeft().clone().multLocal(0.4f);
- walkDirection.set(0, 0, 0);
- if (left) { walkDirection.addLocal(camLeft); }
- if (right) { walkDirection.addLocal(camLeft.negate()); }
- if (up) { walkDirection.addLocal(camDir); }
- if (down) { walkDirection.addLocal(camDir.negate()); }
- player.setWalkDirection(walkDirection);
- cam.setLocation(player.getPhysicsLocation());
- }
+ public void simpleUpdate(float tpf) {
+ camDir.set(cam.getDirection()).multLocal(0.6f);
+ camLeft.set(cam.getLeft()).multLocal(0.4f);
+ walkDirection.set(0, 0, 0);
+ if (left) {
+ walkDirection.addLocal(camLeft);
+ }
+ if (right) {
+ walkDirection.addLocal(camLeft.negate());
+ }
+ if (up) {
+ walkDirection.addLocal(camDir);
+ }
+ if (down) {
+ walkDirection.addLocal(camDir.negate());
+ }
+ player.setWalkDirection(walkDirection);
+ cam.setLocation(player.getPhysicsLocation());
+ }
setLocalTranslation() to walk the player around. You will get it stuck by overlapping with another physical object. You can put the player in a start position with setPhysicalLocation() if you make sure to place it a bit above the floor and away from obstacles.
+
Conclusion
Defining Mappings and Triggers
// Add the names to the action listener.
- inputManager.addListener(actionListener, new String[]{"Pause"});
- inputManager.addListener(analogListener, new String[]{"Left", "Right", "Rotate"});
+ inputManager.addListener(actionListener,"Pause");
+ inputManager.addListener(analogListener,"Left", "Right", "Rotate");
simpleInitApp() method. But since we will likely add many keybindings, we extract these lines and wrap them in an auxiliary method, initKeys(). The initKeys() method is not part of the Input Controls interface ??? you can name it whatever you like. Just don't forget to call your method from the initSimpleApp() method.
+
Implementing the Actions
Analog, Pressed, or Released?
Table of Triggers
src/core/com/jme3/in
KeyTrigger(KeyInput.KEY_LEFT), KeyTrigger(KeyInput.KEY_RIGHT)
KeyInput.| and trigger code completion to select possible input identifiers.
Exercises
@@ -396,7 +397,7 @@ inputManager.addMapping("Pause", new KeyTrigger(usersPauseKey
Conclusion
Understanding the Code
simpleUpdate() method ??? this is the
Using the Update Loop
Init - Update - Render
-
simpleInitApp() method is executed only once, right at the beginning; simpleInitApp() method is executed only once, right at the beginning; simpleUpdate() method runs repeatedly, during the game. simpleUpdate() method runs repeatedly, during the game. renders) the screen for you!renders) the screen for you.
-
simpleInitApp() is the application's "first breath".simpleInitApp() method is the application's "first breath".
+Here you load and create game data (once).simpleUpdate() is the application's heartbeat.
-The update time unit is called ticks.simpleUpdate() method is the application's "heartbeat" (the time unit is called ticks).
+Here you change their properties to update the game state (repeatedly).
Exercises
Conclusion
Sample Code
package jme3test.helloworld;
@@ -31,18 +31,17 @@ import com.jme3.material.Material;
import com.jme3.material.RenderState.BlendMode;
import com.jme3.math.ColorRGBA;
import com.jme3.math.Vector3f;
+import com.jme3.renderer.queue.RenderQueue.Bucket;
import com.jme3.scene.Geometry;
import com.jme3.scene.shape.Box;
import com.jme3.scene.shape.Sphere;
import com.jme3.texture.Texture;
import com.jme3.util.TangentBinormalGenerator;
-import com.jme3.renderer.queue.RenderQueue.Bucket;
/** Sample 6 - how to give an object's surface a material and texture.
- * How to make objects transparent, or let colors "leak" through partially
- * transparent textures. How to make bumpy and shiny surfaces. */
-
+ * How to make objects transparent. How to make bumpy and shiny surfaces. */
public class HelloMaterial extends SimpleApplication {
+
public static void main(String[] args) {
HelloMaterial app = new HelloMaterial();
app.start();
@@ -50,58 +49,57 @@ public class HelloMaterial extends SimpleApplication {
@Override
public void simpleInitApp() {
+
/** A simple textured cube -- in good MIP map quality. */
- Box boxshape1 = new Box(new Vector3f(-3f,1.1f,0f), 1f,1f,1f);
- Geometry cube = new Geometry("My Textured Box", boxshape1);
- Material mat_stl = new Material(assetManager, "Common/MatDefs/Misc/Unshaded.j3md");
- Texture tex_ml = assetManager.loadTexture("Interface/Logo/Monkey.jpg");
- mat_stl.setTexture("ColorMap", tex_ml);
- cube.setMaterial(mat_stl);
- rootNode.attachChild(cube);
+ Box cube1Mesh = new Box( 1f,1f,1f);
+ Geometry cube1Geo = new Geometry("My Textured Box", cube1Mesh);
+ cube1Geo.setLocalTranslation(new Vector3f(-3f,1.1f,0f));
+ Material cube1Mat = new Material(assetManager,
+ "Common/MatDefs/Misc/Unshaded.j3md");
+ Texture cube1Tex = assetManager.loadTexture(
+ "Interface/Logo/Monkey.jpg");
+ cube1Mat.setTexture("ColorMap", cube1Tex);
+ cube1Geo.setMaterial(cube1Mat);
+ rootNode.attachChild(cube1Geo);
/** A translucent/transparent texture, similar to a window frame. */
- Box boxshape3 = new Box(new Vector3f(0f,0f,0f), 1f,1f,0.01f);
- Geometry window_frame = new Geometry("window frame", boxshape3);
- Material mat_tt = new Material(assetManager, "Common/MatDefs/Misc/Unshaded.j3md");
- mat_tt.setTexture("ColorMap", assetManager.loadTexture("Textures/ColoredTex/Monkey.png"));
- mat_tt.getAdditionalRenderState().setBlendMode(BlendMode.Alpha);
- window_frame.setMaterial(mat_tt);
-
- /** Objects with transparency need to be in the render bucket for transparent objects: */
- window_frame.setQueueBucket(Bucket.Transparent);
- rootNode.attachChild(window_frame);
-
- /** A cube with base color "leaking" through a partially transparent texture */
- Box boxshape4 = new Box(new Vector3f(3f,-1f,0f), 1f,1f,1f);
- Geometry cube_leak = new Geometry("Leak-through color cube", boxshape4);
- Material mat_tl = new Material(assetManager, "Common/MatDefs/Misc/Unshaded.j3md");
- mat_tl.setTexture("ColorMap", assetManager.loadTexture("Textures/ColoredTex/Monkey.png"));
- mat_tl.setColor("Color", new ColorRGBA(1f,0f,1f, 1f)); // purple
- cube_leak.setMaterial(mat_tl);
- rootNode.attachChild(cube_leak);
+ Box cube2Mesh = new Box( 1f,1f,0.01f);
+ Geometry cube2Geo = new Geometry("window frame", cube2Mesh);
+ Material cube2Mat = new Material(assetManager,
+ "Common/MatDefs/Misc/Unshaded.j3md");
+ cube2Mat.setTexture("ColorMap",
+ assetManager.loadTexture("Textures/ColoredTex/Monkey.png"));
+ cube2Mat.getAdditionalRenderState().setBlendMode(BlendMode.Alpha);
+ cube2Geo.setQueueBucket(Bucket.Transparent);
+ cube2Geo.setMaterial(cube2Mat);
+ rootNode.attachChild(cube2Geo);
- /** A bumpy rock with a shiny light effect */
- Sphere rock = new Sphere(32,32, 2f);
- Geometry shiny_rock = new Geometry("Shiny rock", rock);
- rock.setTextureMode(Sphere.TextureMode.Projected); // better quality on spheres
- TangentBinormalGenerator.generate(rock); // for lighting effect
- Material mat_lit = new Material(assetManager, "Common/MatDefs/Light/Lighting.j3md");
- mat_lit.setTexture("DiffuseMap", assetManager.loadTexture("Textures/Terrain/Pond/Pond.jpg"));
- mat_lit.setTexture("NormalMap", assetManager.loadTexture("Textures/Terrain/Pond/Pond_normal.png"));
- mat_lit.setBoolean("UseMaterialColors",true);
- mat_lit.setColor("Specular",ColorRGBA.White);
- mat_lit.setColor("Diffuse",ColorRGBA.White);
- mat_lit.setFloat("Shininess", 5f); // [1,128]
- shiny_rock.setMaterial(mat_lit);
- shiny_rock.setLocalTranslation(0,2,-2); // Move it a bit
- shiny_rock.rotate(1.6f, 0, 0); // Rotate it a bit
- rootNode.attachChild(shiny_rock);
+ /** A bumpy rock with a shiny light effect.*/
+ Sphere sphereMesh = new Sphere(32,32, 2f);
+ Geometry sphereGeo = new Geometry("Shiny rock", sphereMesh);
+ sphereMesh.setTextureMode(Sphere.TextureMode.Projected); // better quality on spheres
+ TangentBinormalGenerator.generate(sphereMesh); // for lighting effect
+ Material sphereMat = new Material(assetManager,
+ "Common/MatDefs/Light/Lighting.j3md");
+ sphereMat.setTexture("DiffuseMap",
+ assetManager.loadTexture("Textures/Terrain/Pond/Pond.jpg"));
+ sphereMat.setTexture("NormalMap",
+ assetManager.loadTexture("Textures/Terrain/Pond/Pond_normal.png"));
+ sphereMat.setBoolean("UseMaterialColors",true);
+ sphereMat.setColor("Diffuse",ColorRGBA.White);
+ sphereMat.setColor("Specular",ColorRGBA.White);
+ sphereMat.setFloat("Shininess", 64f); // [0,128]
+ sphereGeo.setMaterial(sphereMat);
+ sphereGeo.setLocalTranslation(0,2,-2); // Move it a bit
+ sphereGeo.rotate(1.6f, 0, 0); // Rotate it a bit
+ rootNode.attachChild(sphereGeo);
/** Must add a light to make the lit object visible! */
DirectionalLight sun = new DirectionalLight();
sun.setDirection(new Vector3f(1,0,-2).normalizeLocal());
sun.setColor(ColorRGBA.White);
rootNode.addLight(sun);
+
}
}
@@ -111,9 +109,7 @@ You should see
@@ -122,7 +118,7 @@ Move around with the WASD keys to have a closer look at the translucency, and th
Simple Unshaded Texture
/** A simple textured cube. */
- Box boxshape1 = new Box(new Vector3f(-3f,1.1f,0f), 1f,1f,1f);
- Geometry cube = new Geometry("My Textured Box", boxshape1);
- Material mat_stl = new Material(assetManager,
+
/** A simple textured cube -- in good MIP map quality. */
+ Box cube1Mesh = new Box( 1f,1f,1f);
+ Geometry cube1Geo = new Geometry("My Textured Box", cube1Mesh);
+ cube1Geo.setLocalTranslation(new Vector3f(-3f,1.1f,0f));
+ Material cube1Mat = new Material(assetManager,
"Common/MatDefs/Misc/Unshaded.j3md");
- Texture tex_ml = assetManager.loadTexture("Interface/Logo/Monkey.jpg");
- mat_stl.setTexture("ColorMap", tex_ml);
- cube.setMaterial(mat_stl);
- rootNode.attachChild(cube);
+ Texture cube1Tex = assetManager.loadTexture(
+ "Interface/Logo/Monkey.jpg");
+ cube1Mat.setTexture("ColorMap", cube1Tex);
+ cube1Geo.setMaterial(cube1Mat);
+ rootNode.attachChild(cube1Geo);
-
cube.cube1Geo from a Box mesh cube1Mesh. cube1Mat based on jME3's default Unshaded.j3md material definition.Unshaded.j3md material definition.cube1Tex from the Monkey.jpg file in the assets/Interface/Logo/ directory of the project. Monkey.jpg file and load it into the material.
-The ColorMap is the typical material layer where textures go.cube1Tex into the ColorMap layer of the material cube1Mat. Transparent Unshaded Texture
Monkey.png is the same texture as Monkey.jpg, but with an added alpha channel. The alpha channel allows you to specify which areas of the texture you want to be opaque or transparent: Black areas remain opaque, gray areas become translucent, and white areas become transparent.
+Monkey.png is the same texture as Monkey.jpg, but with an added alpha channel. The alpha channel allows you to specify which areas of the texture you want to be opaque or transparent: Black areas of the alpha channel remain opaque, gray areas become translucent, and white areas become transparent.
-
-BlendMode.AlphaBlendMode.AlphaBucket.Transparent render bucket. This bucket ensures that the translucent object is drawn on top of objects behind it, and they show up correctly under the translucent parts. (For non-translucent objects the drawing order is not so important, because the z-buffer keeps track of whether a pixel is behind something else or not, and the color of a pixel doesn't depend on the pixels under it, this is why opaque Geometries can be drawn in any order.)Bucket.Transparent render bucket.
+This bucket ensures that the transparent object is drawn on top of objects behind it, and they show up correctly under the transparent parts. /** A translucent/transparent texture. */
- Box boxshape3 = new Box(new Vector3f(0f,0f,0f), 1f,1f,0.01f);
- Geometry seethrough = new Geometry("see-through box", boxshape3);
- Material mat_tt = new Material(assetManager, "Common/MatDefs/Misc/Unshaded.j3md");
- mat_tt.setTexture("ColorMap", assetManager.loadTexture("Textures/ColoredTex/Monkey.png"));
- mat_tt.getAdditionalRenderState().setBlendMode(BlendMode.Alpha); // activate transparency
- seethrough.setMaterial(mat_tt);
- seethrough.setQueueBucket(Bucket.Transparent);
- rootNode.attachChild(seethrough);
+ /** A translucent/transparent texture, similar to a window frame. */
+ Box cube2Mesh = new Box( 1f,1f,0.01f);
+ Geometry cube2Geo = new Geometry("window frame", cube2Mesh);
+ Material cube2Mat = new Material(assetManager,
+ "Common/MatDefs/Misc/Unshaded.j3md");
+ cube2Mat.setTexture("ColorMap",
+ assetManager.loadTexture("Textures/ColoredTex/Monkey.png"));
+ cube2Mat.getAdditionalRenderState().setBlendMode(BlendMode.Alpha); // !
+ cube2Geo.setQueueBucket(Bucket.Transparent); // !
+ cube2Geo.setMaterial(cube2Mat);
+ rootNode.attachChild(cube2Geo);
+
+
-
@@ -213,59 +218,62 @@ The ColorMap is the material layer where textures go. This
+
cube2Geo from a Box mesh cube2Mesh. This Box Geometry is flat upright box (because z=0.01f).Unshaded.j3md material definition.cube2Mat based on jME3's default Unshaded.j3md material definition.Monkey.png file and load it into the material.
-The ColorMap is the material layer where textures go. This PNG file must have an alpha layer.cube2Tex from the Monkey.png file in the assets/Textures/ColoredTex/ directory of the project. This PNG file must have an alpha layer.Bucket.Transparent.Bucket.Transparent.cube2Tex into the ColorMap layer of the material cube2Mat.Shininess and Bumpiness
-
Sphere rock = new Sphere(32,32, 2f);
- Geometry shiny_rock = new Geometry("Shiny rock", rock);
+ Sphere sphereMesh = new Sphere(32,32, 2f);
+ Geometry sphereGeo = new Geometry("Shiny rock", sphereMesh);
-
rock.setTextureMode(Sphere.TextureMode.Projected);
+ sphereMesh.setTextureMode(Sphere.TextureMode.Projected);
TangentBinormalGenerator.generate(rock);
+ TangentBinormalGenerator.generate(sphereMesh);
Lighting.j3md default material. Material mat_lit = new Material(assetManager,
- "Common/MatDefs/Light/Lighting.j3md");
+Lighting.j3md default material. Material sphereMat = new Material(assetManager,
+ "Common/MatDefs/Light/Lighting.j3md");
DiffuseMap layer.
- mat_lit.setTexture("DiffuseMap", assetManager.loadTexture(
- "Textures/Terrain/Pond/Pond.jpg"));
+ sphereMat.setTexture("DiffuseMap",
+ assetManager.loadTexture("Textures/Terrain/Pond/Pond.jpg"));
NormalMap layer that contains the bumpiness. The NormalMap was generated for this particular DiffuseMap with a special tool (e.g. Blender).
mat_lit.setTexture("NormalMap", assetManager.loadTexture(
- "Textures/Terrain/Pond/Pond_normal.png"));
+NormalMap layer that contains the bumpiness. The NormalMap was generated for this particular DiffuseMap with a special tool (e.g. Blender).
sphereMat.setTexture("NormalMap",
+ assetManager.loadTexture("Textures/Terrain/Pond/Pond_normal.png"));
mat_lit.setFloat("Shininess", 5f); // [1,128]
+ sphereMat.setBoolean("UseMaterialColors",true);
+ sphereMat.setColor("Diffuse",ColorRGBA.White); // minimum material color
+ sphereMat.setColor("Specular",ColorRGBA.White); // for shininess
+ sphereMat.setFloat("Shininess", 64f); // [1,128] for shininess
shiny_rock.setMaterial(mat_lit);
+ sphereGeo.setMaterial(sphereMat);
shiny_rock.setLocalTranslation(0,2,-2); // Move it a bit
- shiny_rock.rotate(1.6f, 0, 0); // Rotate it a bit
- rootNode.attachChild(shiny_rock);
+ sphereGeo.setLocalTranslation(0,2,-2); // Move it a bit
+ sphereGeo.rotate(1.6f, 0, 0); // Rotate it a bit
+ rootNode.attachChild(sphereGeo);
Default Material Definitions
Shininess : Float
Exercises
Exercise 1: Custom .j3m Material
-
Unshaded.j3md Material definition.Lighting.j3md Material definition.Color parameter to purple (new ColorRGBA(1f,0f,1f,1f)).DiffuseMap and NormalMap to a texture path.ColorMap to a texture path.UseMaterialColors and sets Specular and Diffuse to 4 float values (RGBA color).Shininess to 64.
-
assets/Materials/LeakThrough.j3m in your project directory, with the following content:Material Leak Through : Common/MatDefs/Misc/Unshaded.j3md {
+assets/Materials/MyCustomMaterial.j3m in your project directory, with the following content:Material My shiny custom material : Common/MatDefs/Light/Lighting.j3md {
MaterialParameters {
- Color : 1 0 1 1
- ColorMap : Flip Textures/ColoredTex/Monkey.png
+ DiffuseMap : Textures/Terrain/Pond/Pond.jpg
+ NormalMap : Textures/Terrain/Pond/Pond_normal.png
+ UseMaterialColors : true
+ Specular : 1.0 1.0 1.0 1.0
+ Diffuse : 1.0 1.0 1.0 1.0
+ Shininess : 64.0
}
}
Material is a fixed keyword.Leak Through is a String that you can choose to name the material.My shiny custom material is a String that you can choose to describe the material.mat_tl in them.sphereMat in them.cube_leak.setMaterial((Material) assetManager.loadMaterial( "Materials/LeakThrough.j3m"));
+sphereGeo.setMaterial((Material) assetManager.loadMaterial(
+ "Materials/MyCustomMaterial.j3m"));
LeakThrough.j3m only takes one line. You have replaced the three lines of an on-the-fly material definition with one line that loads a custom material from a file. This method is very handy if you use the same material often.
+Using this new custom material MyCustomMaterial.j3m only takes one line. You have replaced the eight lines of an on-the-fly material definition with one line that loads a custom material from a file. Using .j3m files is very handy if you use the same material often.
Exercise 2: Bumpiness and Shininess
Conclusion
Understanding the Terminology
Position/move, turn, or resize an object Translate, or rotate, or scale an object = transform an object.
rootNode object from SimpleApplication. Everything attached to the rootNode is part of the scene graph. The elements of the scene graph are Spatials.
@@ -155,9 +154,9 @@ Every JME3 application has a rootNode: Your game automatically inherits the A box, a sphere, a player, a building, a piece of terrain, a vehicle, missiles, NPCs, etc??? The
-
+
-
+
rootNode, a floor node grouping several terrains, a custom vehicle-with-passengers node, a player-with-weapon node, an audio node, etc??? Understanding the Code
simpleInitApp() metho
Box box1 = new Box( Vector3f.ZERO, 1,1,1);
+
Box box1 = new Box(1,1,1);
Geometry blue = new Geometry("Box", box1);
- Material mat1 = new Material(assetManager,
- "Common/MatDefs/Misc/Unshaded.j3md");
+ blue.setLocalTranslation(new Vector3f(1,-1,1));
+ Material mat1 = new Material(assetManager,"Common/MatDefs/Misc/Unshaded.j3md");
mat1.setColor("Color", ColorRGBA.Blue);
- blue.setMaterial(mat1);
- blue.move(1,-1,1);
+ blue.setMaterial(mat1);
simpleInitApp() metho
Box box2 = new Box( Vector3f.ZERO, 1,1,1);
+
Box box2 = new Box(1,1,1);
Geometry red = new Geometry("Box", box2);
+ red.setLocalTranslation(new Vector3f(1,3,1));
Material mat2 = new Material(assetManager,
"Common/MatDefs/Misc/Unshaded.j3md");
mat2.setColor("Color", ColorRGBA.Red);
- red.setMaterial(mat2);
- red.move(1,3,1);
+ red.setMaterial(mat2);
What is a Pivot Node?
How do I Populate the Scenegraph?
@@ -298,9 +296,9 @@ thing.setMaterial(mat);
Specify what should be loaded at the start Everything you initialize and attach to the
rootNode in the simpleInitApp() method is part of the scene at the start of the game. How do I Transform Spatials?
+right -left +up -down +forward -backward
3 3 3 1 2 3
B C X
Transformations
u1 -u0 0
Translation
@@ -270,14 +294,14 @@ Translation requires a 4x4 matrix, where the vector (x,y,z) is mapped to (x,y,z,
ST 1
-
+
jME Class
Vector
Definition
Operations
Quaternion
Definition
Angle Axis
Three Angles
Three Axes
Rotation Matrix
Slerp
Multiplication
Utility Classes
Fast Math
Definition
Usage
Line
Definition
Usage
Example 1 - Find a Random Point on a Line
Line l = new Line(new Vector3f(0,1,0), new Vector3f(3,2,1));
Vector3f randomPoint = l.random();
Plane
Definition
Usage in jME
whichSide.
Example 1 - Determining if a Point is On the Positive Side of a Plane
Vector3f normal = new Vector3f(0,1,0);
@@ -860,7 +884,7 @@ if(side == Plane.NO_SIDE) {
}
Example 2 - For the Layperson
Ray
Definition
Example 1 - Create a Ray That Represents Where the Camera is Looking
Ray ray = new Ray(cam.getLocation(), cam.getDirection());
Rectangle
Definition
jME Usage
Example 1 : Define a Rectangle and Get a Point From It
Vector3f v1 = new Vector3f(1,0,0);
@@ -1002,7 +1026,7 @@ Rectangle r = new Rectangle(v1, v2, v3);
Vector3f point = r.random();
Triangle
Definition
Usage
Example 1 - Creating a Triangle
//the three points that make up the triangle
@@ -1042,12 +1066,12 @@ Vector3f p3 = new Vector3f(0,1,1);
Triangle t = new Triangle(p1, p2, p3);
Tips and Tricks
How do I get height/width of a spatial?
How do I position the center of a Geomtry?
geo.center().move(pos);
See Also
@@ -1079,5 +1103,5 @@ float z = ( (BoundingBox)spatial.getWorldBound()).getZEx
Procedural Textures
Animation
Rigging and Skinning
Kinematics
@@ -469,7 +469,7 @@ E.g. when the thigh bone moves, the leg is fully affected, the hips joints less
Controller and Channel
Artificial Intelligence (AI)
Math
Coordinates
The Origin
Vectors
Unit Vectors
Normalized Vectors
Surface Normal Vectors
Cross Product
Transformation
Slerp
Game Developer Jargon
@@ -688,7 +688,7 @@ Example: A burning meteorite Geometry slerps from "position p1, rotation r1
3D graphics Terminology Wiki book
@@ -697,5 +697,5 @@ Example: A burning meteorite Geometry slerps from "position p1, rotation r1
Requirements
Branding
Creating the Distributable
Desktop Application (JAR)
Desktop Executables (.EXE, .APP, .JAR)
Web Start (.JNLP)
+
+Planned features.
-
Known bugs/problems.
@@ -191,7 +199,7 @@ By default a BlenderModelLoader is registered with your assetManager to load ble
Using BlenderLoader instead of BlenderModelLoader
How does it work?
Surface Node The surface is transformed to the proper mesh
Notes
Handy things in jMonkeyEngine SDK Core
diff --git a/sdk/jme3-documentation/src/com/jme3/gde/docs/sdk/material_editing.html b/sdk/jme3-documentation/src/com/jme3/gde/docs/sdk/material_editing.html
index 0f88f5927..be7f4b7ab 100644
--- a/sdk/jme3-documentation/src/com/jme3/gde/docs/sdk/material_editing.html
+++ b/sdk/jme3-documentation/src/com/jme3/gde/docs/sdk/material_editing.html
@@ -112,7 +112,7 @@ Or in your Java code
-mywall.setMaterial(assetManager.loadAsset( "Materials/mat_wall.j3m"));
+mywall.setMaterial(assetManager.loadMaterial( "Materials/mat_wall.j3m"));
Editing Objects in the scene
@@ -47,7 +47,7 @@ You open the SceneExplorer by viewing a model (j3o file or other) in the jMonkey
Reorganizing Objects in the scene
@@ -58,7 +58,7 @@ You open the SceneExplorer by viewing a model (j3o file or other) in the jMonkey
Adding Objects to the scene
Specifying the JDK location
-
-
-
-
-Mac users right-click jMonkeyApplication.app (which actually is a directory) in the Finder and select "Show package contents". etc directory.
-Mac users navigate to Contents/Resources/jmonkeyplatform/etc/.jmonkeyplatform.conf in a text editor.jdkhome="/path/to/jdk"
-Graphics Card Driver
Contents/Resources/jmonkeyplatform/etc/.Stability / Graphics issues
Updating problems
Preferences and Settings
Log
Getting error messages and reporting issues
Specifying the JDK location
+
+
+
+
+Mac users right-click jMonkeyApplication.app (which actually is a directory) in the Finder and select "Show package contents". etc directory.
+Mac users navigate to Contents/Resources/jmonkeyplatform/etc/.jmonkeyplatform.conf in a text editor.jdkhome="/path/to/jdk"
+Known Issues
svnadmin create /home/joe/jMonkeyProjects/MyGame
-
-
+
Checking Out a Repository (Download)
-
@@ -117,7 +117,7 @@ Of course you can also check out existing repositories and access code from othe
Updating and Committing Changes (Send and Receive)
Comparing and Reverting Changes
@@ -187,7 +187,7 @@ Receiving the latest changes from the team's repository is referred to as <
No Version Control? Local History!