Home | History | Annotate | Download | only in state 
      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.app.state;
     34 
     35 import com.jme3.app.Application;
     36 import com.jme3.renderer.RenderManager;
     37 
     38 /**
     39  * <code>AbstractAppState</code> implements some common methods
     40  * that make creation of AppStates easier.
     41  * @author Kirill Vainer
     42  */
     43 public class AbstractAppState implements AppState {
     44 
     45     /**
     46      * <code>initialized</code> is set to true when the method
     47      * {@link AbstractAppState#initialize(com.jme3.app.state.AppStateManager, com.jme3.app.Application) }
     48      * is called. When {@link AbstractAppState#cleanup() } is called, <code>initialized</code>
     49      * is set back to false.
     50      */
     51     protected boolean initialized = false;
     52     private boolean enabled = true;
     53 
     54     public void initialize(AppStateManager stateManager, Application app) {
     55         initialized = true;
     56     }
     57 
     58     public boolean isInitialized() {
     59         return initialized;
     60     }
     61 
     62     public void setEnabled(boolean enabled) {
     63         this.enabled = enabled;
     64     }
     65 
     66     public boolean isEnabled() {
     67         return enabled;
     68     }
     69 
     70     public void stateAttached(AppStateManager stateManager) {
     71     }
     72 
     73     public void stateDetached(AppStateManager stateManager) {
     74     }
     75 
     76     public void update(float tpf) {
     77     }
     78 
     79     public void render(RenderManager rm) {
     80     }
     81 
     82     public void postRender(){
     83     }
     84 
     85     public void cleanup() {
     86         initialized = false;
     87     }
     88 
     89 }
     90