159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2009-2010 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.terrain.geomipmap; 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.InputCapsule; 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.JmeExporter; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.JmeImporter; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.OutputCapsule; 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.math.Vector3f; 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.renderer.Camera; 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.renderer.RenderManager; 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.renderer.ViewPort; 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.scene.Node; 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.scene.Spatial; 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.scene.control.AbstractControl; 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.scene.control.Control; 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.terrain.Terrain; 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.terrain.geomipmap.lodcalc.DistanceLodCalculator; 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.terrain.geomipmap.lodcalc.LodCalculator; 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.io.IOException; 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.ArrayList; 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.List; 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Tells the terrain to update its Level of Detail. 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * It needs the cameras to do this, and there could possibly 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * be several cameras in the scene, so it accepts a list 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * of cameras. 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NOTE: right now it just uses the first camera passed in, 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * in the future it will use all of them to determine what 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LOD to set. 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * This control serializes, but it does not save the Camera reference. 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * This camera reference has to be manually added in when you load the 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * terrain to the scene! 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author Brent Owens 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class TerrainLodControl extends AbstractControl { 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private Terrain terrain; 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private List<Camera> cameras; 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private List<Vector3f> cameraLocations = new ArrayList<Vector3f>(); 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private LodCalculator lodCalculator; 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private boolean hasResetLod = false; // used when enabled is set to false 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public TerrainLodControl() { 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public TerrainLodControl(Terrain terrain, Camera camera) { 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta List<Camera> cams = new ArrayList<Camera>(); 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta cams.add(camera); 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.terrain = terrain; 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.cameras = cams; 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta lodCalculator = new DistanceLodCalculator(65, 2.7f); // a default calculator 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Only uses the first camera right now. 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param terrain to act upon (must be a Spatial) 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param cameras one or more cameras to reference for LOD calc 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public TerrainLodControl(Terrain terrain, List<Camera> cameras) { 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.terrain = terrain; 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.cameras = cameras; 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta lodCalculator = new DistanceLodCalculator(65, 2.7f); // a default calculator 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected void controlRender(RenderManager rm, ViewPort vp) { 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void update(float tpf) { 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta controlUpdate(tpf); 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected void controlUpdate(float tpf) { 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta //list of cameras for when terrain supports multiple cameras (ie split screen) 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (lodCalculator == null) 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return; 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (!enabled) { 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (!hasResetLod) { 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta // this will get run once 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta hasResetLod = true; 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta lodCalculator.turnOffLod(); 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (cameras != null) { 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (cameraLocations.isEmpty() && !cameras.isEmpty()) { 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta for (Camera c : cameras) // populate them 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta { 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta cameraLocations.add(c.getLocation()); 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta terrain.update(cameraLocations, lodCalculator); 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Control cloneForSpatial(Spatial spatial) { 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (spatial instanceof Terrain) { 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta List<Camera> cameraClone = new ArrayList<Camera>(); 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (cameras != null) { 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta for (Camera c : cameras) { 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta cameraClone.add(c); 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta TerrainLodControl cloned = new TerrainLodControl((Terrain) spatial, cameraClone); 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta cloned.setLodCalculator(lodCalculator.clone()); 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return cloned; 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return null; 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setCamera(Camera camera) { 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta List<Camera> cams = new ArrayList<Camera>(); 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta cams.add(camera); 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setCameras(cams); 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setCameras(List<Camera> cameras) { 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.cameras = cameras; 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta cameraLocations.clear(); 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta for (Camera c : cameras) { 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta cameraLocations.add(c.getLocation()); 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 16359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setSpatial(Spatial spatial) { 16459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.setSpatial(spatial); 16559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (spatial instanceof Terrain) { 16659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.terrain = (Terrain) spatial; 16759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setTerrain(Terrain terrain) { 17159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.terrain = terrain; 17259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public LodCalculator getLodCalculator() { 17559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return lodCalculator; 17659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setLodCalculator(LodCalculator lodCalculator) { 17959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.lodCalculator = lodCalculator; 18059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 18359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setEnabled(boolean enabled) { 18459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.enabled = enabled; 18559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (!enabled) { 18659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta // reset the lod levels to max detail for the terrain 18759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta hasResetLod = false; 18859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } else { 18959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta hasResetLod = true; 19059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta lodCalculator.turnOnLod(); 19159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 19559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void write(JmeExporter ex) throws IOException { 19659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.write(ex); 19759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta OutputCapsule oc = ex.getCapsule(this); 19859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write((Node)terrain, "terrain", null); 19959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(lodCalculator, "lodCalculator", null); 20059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 20259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 20359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void read(JmeImporter im) throws IOException { 20459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.read(im); 20559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta InputCapsule ic = im.getCapsule(this); 20659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta terrain = (Terrain) ic.readSavable("terrain", null); 20759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta lodCalculator = (LodCalculator) ic.readSavable("lodCalculator", new DistanceLodCalculator()); 20859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 21059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 211