aboutsummaryrefslogtreecommitdiff
path: root/engine/src/core/com/jme3/light/Light.java
diff options
context:
space:
mode:
Diffstat (limited to 'engine/src/core/com/jme3/light/Light.java')
-rw-r--r--engine/src/core/com/jme3/light/Light.java210
1 files changed, 210 insertions, 0 deletions
diff --git a/engine/src/core/com/jme3/light/Light.java b/engine/src/core/com/jme3/light/Light.java
new file mode 100644
index 0000000..965eaf9
--- /dev/null
+++ b/engine/src/core/com/jme3/light/Light.java
@@ -0,0 +1,210 @@
+/*
+ * Copyright (c) 2009-2010 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.light;
+
+import com.jme3.export.*;
+import com.jme3.math.ColorRGBA;
+import com.jme3.scene.Spatial;
+import java.io.IOException;
+
+/**
+ * Abstract class for representing a light source.
+ * <p>
+ * All light source types have a color.
+ */
+public abstract class Light implements Savable, Cloneable {
+
+ /**
+ * Describes the light type.
+ */
+ public enum Type {
+
+ /**
+ * Directional light
+ *
+ * @see DirectionalLight
+ */
+ Directional(0),
+
+ /**
+ * Point light
+ *
+ * @see PointLight
+ */
+ Point(1),
+
+ /**
+ * Spot light.
+ * <p>
+ * Not supported by jMonkeyEngine
+ */
+ Spot(2),
+
+ /**
+ * Ambient light
+ *
+ * @see AmbientLight
+ */
+ Ambient(3);
+
+ private int typeId;
+
+ Type(int type){
+ this.typeId = type;
+ }
+
+ /**
+ * Returns an index for the light type
+ * @return an index for the light type
+ */
+ public int getId(){
+ return typeId;
+ }
+ }
+
+ protected ColorRGBA color = new ColorRGBA(1f,1f,1f,1f);
+
+ /**
+ * Used in LightList for caching the distance
+ * to the owner spatial. Should be reset after the sorting.
+ */
+ protected transient float lastDistance = -1;
+
+ /**
+ * If light is disabled, it will not have any
+ */
+ protected boolean enabled = true;
+
+ /**
+ * The light name.
+ */
+ protected String name;
+
+ /**
+ * Returns the color of the light.
+ *
+ * @return The color of the light.
+ */
+ public ColorRGBA getColor() {
+ return color;
+ }
+
+ /**
+ * This method sets the light name.
+ *
+ * @param name the light name
+ */
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Return the light name.
+ *
+ * @return the light name
+ */
+ public String getName() {
+ return name;
+ }
+
+ /*
+ public void setLastDistance(float lastDistance){
+ this.lastDistance = lastDistance;
+ }
+
+ public float getLastDistance(){
+ return lastDistance;
+ }
+ */
+
+ /**
+ * Sets the light color.
+ *
+ * @param color the light color.
+ */
+ public void setColor(ColorRGBA color){
+ this.color.set(color);
+ }
+
+
+ /*
+ * Returns true if the light is enabled
+ *
+ * @return true if the light is enabled
+ *
+ * @see Light#setEnabled(boolean)
+ */
+ /*
+ public boolean isEnabled() {
+ return enabled;
+ }
+ */
+
+ @Override
+ public Light clone(){
+ try {
+ return (Light) super.clone();
+ } catch (CloneNotSupportedException ex) {
+ throw new AssertionError();
+ }
+ }
+
+ public void write(JmeExporter ex) throws IOException {
+ OutputCapsule oc = ex.getCapsule(this);
+ oc.write(color, "color", null);
+ oc.write(enabled, "enabled", true);
+ oc.write(name, "name", null);
+ }
+
+ public void read(JmeImporter im) throws IOException {
+ InputCapsule ic = im.getCapsule(this);
+ color = (ColorRGBA) ic.readSavable("color", null);
+ enabled = ic.readBoolean("enabled", true);
+ name = ic.readString("name", null);
+ }
+
+ /**
+ * Used internally to compute the last distance value.
+ */
+ protected abstract void computeLastDistance(Spatial owner);
+
+ /**
+ * Returns the light type
+ *
+ * @return the light type
+ *
+ * @see Type
+ */
+ public abstract Type getType();
+
+}