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.lodcalc; 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.terrain.geomipmap.TerrainPatch; 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.terrain.geomipmap.UpdatedTerrainPatch; 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.io.IOException; 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.HashMap; 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.List; 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Calculates the LOD of the terrain based on its distance from the 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * cameras. Taking the minimum distance from all cameras. 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author bowens 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class DistanceLodCalculator implements LodCalculator { 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private int size; // size of a terrain patch 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float lodMultiplier = 2; 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private boolean turnOffLod = false; 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public DistanceLodCalculator() { 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public DistanceLodCalculator(int patchSize, float multiplier) { 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.size = patchSize; 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.lodMultiplier = multiplier; 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean calculateLod(TerrainPatch terrainPatch, List<Vector3f> locations, HashMap<String, UpdatedTerrainPatch> updates) { 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta float distance = getCenterLocation(terrainPatch).distance(locations.get(0)); 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (turnOffLod) { 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta // set to full detail 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta int prevLOD = terrainPatch.getLod(); 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta UpdatedTerrainPatch utp = updates.get(terrainPatch.getName()); 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (utp == null) { 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta utp = new UpdatedTerrainPatch(terrainPatch, 0); 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta updates.put(utp.getName(), utp); 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta utp.setNewLod(0); 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta utp.setPreviousLod(prevLOD); 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta utp.setReIndexNeeded(true); 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return true; 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta // go through each lod level to find the one we are in 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta for (int i = 0; i <= terrainPatch.getMaxLod(); i++) { 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (distance < getLodDistanceThreshold() * (i + 1)*terrainPatch.getWorldScale().x || i == terrainPatch.getMaxLod()) { 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta boolean reIndexNeeded = false; 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (i != terrainPatch.getLod()) { 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta reIndexNeeded = true; 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta //System.out.println("lod change: "+lod+" > "+i+" dist: "+distance); 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta int prevLOD = terrainPatch.getLod(); 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta //previousLod = lod; 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta //lod = i; 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta UpdatedTerrainPatch utp = updates.get(terrainPatch.getName()); 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (utp == null) { 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta utp = new UpdatedTerrainPatch(terrainPatch, i);//save in here, do not update actual variables 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta updates.put(utp.getName(), utp); 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta utp.setPreviousLod(prevLOD); 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta utp.setReIndexNeeded(reIndexNeeded); 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return reIndexNeeded; 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return false; 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected Vector3f getCenterLocation(TerrainPatch terrainPatch) { 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Vector3f loc = terrainPatch.getWorldTranslation().clone(); 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta loc.x += terrainPatch.getSize()*terrainPatch.getWorldScale().x / 2; 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta loc.z += terrainPatch.getSize()*terrainPatch.getWorldScale().z / 2; 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return loc; 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void write(JmeExporter ex) throws IOException { 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta OutputCapsule oc = ex.getCapsule(this); 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(size, "patchSize", 32); 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(lodMultiplier, "lodMultiplier", 32); 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void read(JmeImporter im) throws IOException { 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta InputCapsule ic = im.getCapsule(this); 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta size = ic.readInt("patchSize", 32); 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta lodMultiplier = ic.readFloat("lodMultiplier", 2.7f); 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public LodCalculator clone() { 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta DistanceLodCalculator clone = new DistanceLodCalculator(size, lodMultiplier); 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return clone; 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public String toString() { 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return "DistanceLodCalculator "+size+"*"+lodMultiplier; 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Gets the camera distance where the LOD level will change 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected float getLodDistanceThreshold() { 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return size*lodMultiplier; 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Does this calculator require the terrain to have the difference of 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LOD levels of neighbours to be more than 1. 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean usesVariableLod() { 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return false; 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public float getLodMultiplier() { 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return lodMultiplier; 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setLodMultiplier(float lodMultiplier) { 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.lodMultiplier = lodMultiplier; 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public int getSize() { 16359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return size; 16459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setSize(int size) { 16759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.size = size; 16859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void turnOffLod() { 17159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta turnOffLod = true; 17259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean isLodOff() { 17559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return turnOffLod; 17659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void turnOnLod() { 17959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta turnOffLod = false; 18059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 183