001: /*
002: * $RCSfile: AmbientLight.java,v $
003: *
004: * Copyright 1996-2008 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
006: *
007: * This code is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU General Public License version 2 only, as
009: * published by the Free Software Foundation. Sun designates this
010: * particular file as subject to the "Classpath" exception as provided
011: * by Sun in the LICENSE file that accompanied this code.
012: *
013: * This code is distributed in the hope that it will be useful, but WITHOUT
014: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
015: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
016: * version 2 for more details (a copy is included in the LICENSE file that
017: * accompanied this code).
018: *
019: * You should have received a copy of the GNU General Public License version
020: * 2 along with this work; if not, write to the Free Software Foundation,
021: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
022: *
023: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
024: * CA 95054 USA or visit www.sun.com if you need additional information or
025: * have any questions.
026: *
027: * $Revision: 1.5 $
028: * $Date: 2008/02/28 20:17:19 $
029: * $State: Exp $
030: */
031:
032: package javax.media.j3d;
033:
034: import javax.vecmath.Color3f;
035:
036: /**
037: * An ambient light source object. Ambient light is that light
038: * that seems to come from all directions. The AmbientLight object
039: * has the same attributes as a Light node, including color,
040: * influencing bounds, scopes, and
041: * a flag indicating whether this light source is on or off.
042: * Ambient reflections do not depend on the orientation or
043: * position of a surface.
044: * Ambient light has only an ambient reflection component.
045: * It does not have diffuse or specular reflection components.
046: * <p>
047: * For more information on Java 3D lighting, see the class description
048: * for Light.
049: * <p>
050: */
051:
052: public class AmbientLight extends Light {
053: /**
054: * Constructs and initializes an ambient light using default parameters.
055: */
056: public AmbientLight() {
057: }
058:
059: /**
060: * Constructs and initializes an ambient light using the specified
061: * parameters.
062: * @param color the color of the light source.
063: */
064: public AmbientLight(Color3f color) {
065: super (color);
066: }
067:
068: /**
069: * Constructs and initializes an ambient light using the specified
070: * parameters.
071: * @param lightOn flag indicating whether this light is on or off.
072: * @param color the color of the light source.
073: */
074: public AmbientLight(boolean lightOn, Color3f color) {
075: super (lightOn, color);
076: }
077:
078: /**
079: * Creates the retained mode AmbientLightRetained object that this
080: * AmbientLight component object will point to.
081: */
082: void createRetained() {
083: this .retained = new AmbientLightRetained();
084: this .retained.setSource(this );
085: }
086:
087: /**
088: * Used to create a new instance of the node. This routine is called
089: * by <code>cloneTree</code> to duplicate the current node.
090: * @param forceDuplicate when set to <code>true</code>, causes the
091: * <code>duplicateOnCloneTree</code> flag to be ignored. When
092: * <code>false</code>, the value of each node's
093: * <code>duplicateOnCloneTree</code> variable determines whether
094: * NodeComponent data is duplicated or copied.
095: *
096: * @see Node#cloneTree
097: * @see Node#cloneNode
098: * @see Node#duplicateNode
099: * @see NodeComponent#setDuplicateOnCloneTree
100: */
101: public Node cloneNode(boolean forceDuplicate) {
102: AmbientLight a = new AmbientLight();
103: a.duplicateNode(this, forceDuplicate);
104: return a;
105: }
106:
107: }
|