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.Savable;
     36 import com.jme3.renderer.RenderManager;
     37 import com.jme3.renderer.ViewPort;
     38 import com.jme3.scene.Spatial;
     39 
     40 /**
     41  * An interface for scene-graph controls.
     42  * <p>
     43  * <code>Control</code>s are used to specify certain update and render logic
     44  * for a {@link Spatial}.
     45  *
     46  * @author Kirill Vainer
     47  */
     48 public interface Control extends Savable {
     49 
     50     /**
     51      * Creates a clone of the Control, the given Spatial is the cloned
     52      * version of the spatial to which this control is attached to.
     53      * @param spatial
     54      * @return A clone of this control for the spatial
     55      */
     56     public Control cloneForSpatial(Spatial spatial);
     57 
     58     /**
     59      * @param spatial the spatial to be controlled. This should not be called
     60      * from user code.
     61      */
     62     public void setSpatial(Spatial spatial);
     63 
     64     /**
     65      * @param enabled Enable or disable the control. If disabled, update()
     66      * should do nothing.
     67      */
     68     public void setEnabled(boolean enabled);
     69 
     70     /**
     71      * @return True if enabled, false otherwise.
     72      * @see Control#setEnabled(boolean)
     73      */
     74     public boolean isEnabled();
     75 
     76     /**
     77      * Updates the control. This should not be called from user code.
     78      * @param tpf Time per frame.
     79      */
     80     public void update(float tpf);
     81 
     82     /**
     83      * Should be called prior to queuing the spatial by the RenderManager. This
     84      * should not be called from user code.
     85      *
     86      * @param rm
     87      * @param vp
     88      */
     89     public void render(RenderManager rm, ViewPort vp);
     90 }
     91