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 Barta 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.light; 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.*; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.math.ColorRGBA; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.scene.Spatial; 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.io.IOException; 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Abstract class for representing a light source. 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <p> 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All light source types have a color. 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic abstract class Light implements Savable, Cloneable { 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Describes the light type. 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public enum Type { 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Directional light 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @see DirectionalLight 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Directional(0), 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Point light 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @see PointLight 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Point(1), 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Spot light. 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <p> 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Not supported by jMonkeyEngine 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Spot(2), 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Ambient light 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @see AmbientLight 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Ambient(3); 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private int typeId; 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Type(int type){ 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.typeId = type; 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns an index for the light type 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return an index for the light type 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public int getId(){ 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return typeId; 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected ColorRGBA color = new ColorRGBA(1f,1f,1f,1f); 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Used in LightList for caching the distance 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * to the owner spatial. Should be reset after the sorting. 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected transient float lastDistance = -1; 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * If light is disabled, it will not have any 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected boolean enabled = true; 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * The light name. 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected String name; 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns the color of the light. 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return The color of the light. 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public ColorRGBA getColor() { 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return color; 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * This method sets the light name. 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param name the light name 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setName(String name) { 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.name = name; 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Return the light name. 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return the light name 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public String getName() { 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return name; 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /* 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setLastDistance(float lastDistance){ 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.lastDistance = lastDistance; 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public float getLastDistance(){ 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return lastDistance; 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Sets the light color. 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param color the light color. 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setColor(ColorRGBA color){ 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.color.set(color); 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /* 16159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns true if the light is enabled 16259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 16359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return true if the light is enabled 16459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 16559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @see Light#setEnabled(boolean) 16659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 16759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /* 16859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean isEnabled() { 16959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return enabled; 17059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 17259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 17459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Light clone(){ 17559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta try { 17659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return (Light) super.clone(); 17759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } catch (CloneNotSupportedException ex) { 17859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new AssertionError(); 17959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void write(JmeExporter ex) throws IOException { 18359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta OutputCapsule oc = ex.getCapsule(this); 18459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(color, "color", null); 18559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(enabled, "enabled", true); 18659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta oc.write(name, "name", null); 18759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void read(JmeImporter im) throws IOException { 19059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta InputCapsule ic = im.getCapsule(this); 19159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta color = (ColorRGBA) ic.readSavable("color", null); 19259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta enabled = ic.readBoolean("enabled", true); 19359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta name = ic.readString("name", null); 19459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 19759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Used internally to compute the last distance value. 19859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 19959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected abstract void computeLastDistance(Spatial owner); 20059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 20159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 20259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns the light type 20359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 20459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return the light type 20559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 20659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @see Type 20759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 20859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public abstract Type getType(); 20959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 21059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 211