1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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();
}
|
