Home | History | Annotate | Download | only in scene 
      1 /*
      2  * Copyright (c) 2009-2010 jMonkeyEngine
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions are
      7  * met:
      8  *
      9  * * Redistributions of source code must retain the above copyright
     10  *   notice, this list of conditions and the following disclaimer.
     11  *
     12  * * Redistributions in binary form must reproduce the above copyright
     13  *   notice, this list of conditions and the following disclaimer in the
     14  *   documentation and/or other materials provided with the distribution.
     15  *
     16  * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
     17  *   may be used to endorse or promote products derived from this software
     18  *   without specific prior written permission.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
     24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
     28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 package com.jme3.scene;
     33 
     34 import com.jme3.light.Light;
     35 import com.jme3.scene.control.LightControl;
     36 import com.jme3.scene.control.LightControl.ControlDirection;
     37 
     38 /**
     39  * <code>LightNode</code> is used to link together a {@link Light} object
     40  * with a {@link Node} object.
     41  *
     42  * @author Tim8Dev
     43  */
     44 public class LightNode extends Node {
     45 
     46     private LightControl lightControl;
     47 
     48     /**
     49      * Serialization only. Do not use.
     50      */
     51     public LightNode() {
     52     }
     53 
     54     public LightNode(String name, Light light) {
     55         this(name, new LightControl(light));
     56     }
     57 
     58     public LightNode(String name, LightControl control) {
     59         super(name);
     60         addControl(control);
     61         lightControl = control;
     62     }
     63 
     64     /**
     65      * Enable or disable the <code>LightNode</code> functionality.
     66      *
     67      * @param enabled If false, the functionality of LightNode will
     68      * be disabled.
     69      */
     70     public void setEnabled(boolean enabled) {
     71         lightControl.setEnabled(enabled);
     72     }
     73 
     74     public boolean isEnabled() {
     75         return lightControl.isEnabled();
     76     }
     77 
     78     public void setControlDir(ControlDirection controlDir) {
     79         lightControl.setControlDir(controlDir);
     80     }
     81 
     82     public void setLight(Light light) {
     83         lightControl.setLight(light);
     84     }
     85 
     86     public ControlDirection getControlDir() {
     87         return lightControl.getControlDir();
     88     }
     89 
     90     public Light getLight() {
     91         return lightControl.getLight();
     92     }
     93 }
     94