Home | History | Annotate | Download | only in control 
      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 
     33 package com.jme3.scene.control;
     34 
     35 import com.jme3.export.InputCapsule;
     36 import com.jme3.export.JmeExporter;
     37 import com.jme3.export.JmeImporter;
     38 import com.jme3.export.OutputCapsule;
     39 import com.jme3.renderer.RenderManager;
     40 import com.jme3.renderer.ViewPort;
     41 import com.jme3.scene.Spatial;
     42 import java.io.IOException;
     43 
     44 /**
     45  * An abstract implementation of the Control interface.
     46  *
     47  * @author Kirill Vainer
     48  */
     49 public abstract class AbstractControl implements Control {
     50 
     51     protected boolean enabled = true;
     52     protected Spatial spatial;
     53 
     54     public AbstractControl(){
     55     }
     56 
     57     public void setSpatial(Spatial spatial) {
     58         if (this.spatial != null && spatial != null) {
     59             throw new IllegalStateException("This control has already been added to a Spatial");
     60         }
     61         this.spatial = spatial;
     62     }
     63 
     64     public Spatial getSpatial(){
     65         return spatial;
     66     }
     67 
     68     public void setEnabled(boolean enabled) {
     69         this.enabled = enabled;
     70     }
     71 
     72     public boolean isEnabled() {
     73         return enabled;
     74     }
     75 
     76     /**
     77      * To be implemented in subclass.
     78      */
     79     protected abstract void controlUpdate(float tpf);
     80 
     81     /**
     82      * To be implemented in subclass.
     83      */
     84     protected abstract void controlRender(RenderManager rm, ViewPort vp);
     85 
     86     public void update(float tpf) {
     87         if (!enabled)
     88             return;
     89 
     90         controlUpdate(tpf);
     91     }
     92 
     93     public void render(RenderManager rm, ViewPort vp) {
     94         if (!enabled)
     95             return;
     96 
     97         controlRender(rm, vp);
     98     }
     99 
    100     public void write(JmeExporter ex) throws IOException {
    101         OutputCapsule oc = ex.getCapsule(this);
    102         oc.write(enabled, "enabled", true);
    103         oc.write(spatial, "spatial", null);
    104     }
    105 
    106     public void read(JmeImporter im) throws IOException {
    107         InputCapsule ic = im.getCapsule(this);
    108         enabled = ic.readBoolean("enabled", true);
    109         spatial = (Spatial) ic.readSavable("spatial", null);
    110     }
    111 
    112 }
    113