Home | History | Annotate | Download | only in filters 
      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.post.filters;
     33 
     34 import com.jme3.asset.AssetManager;
     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.material.Material;
     40 import com.jme3.math.ColorRGBA;
     41 import com.jme3.post.Filter;
     42 import com.jme3.renderer.RenderManager;
     43 import com.jme3.renderer.ViewPort;
     44 import java.io.IOException;
     45 
     46 /**
     47  * This filter simply multiply the whole scene by a color
     48  * @author Rmy Bouquet aka Nehon
     49  */
     50 public class ColorOverlayFilter extends Filter {
     51 
     52     private ColorRGBA color = ColorRGBA.White;
     53 
     54     /**
     55      * creates a colorOverlayFilter with a white coor (transparent)
     56      */
     57     public ColorOverlayFilter() {
     58         super("Color Overlay");
     59     }
     60 
     61     /**
     62      * creates a colorOverlayFilter with the given color
     63      * @param color
     64      */
     65     public ColorOverlayFilter(ColorRGBA color) {
     66         this();
     67         this.color = color;
     68     }
     69 
     70     @Override
     71     protected Material getMaterial() {
     72 
     73         material.setColor("Color", color);
     74         return material;
     75     }
     76 
     77     /**
     78      * returns the color
     79      * @return color
     80      */
     81     public ColorRGBA getColor() {
     82         return color;
     83     }
     84 
     85     /**
     86      * sets the color
     87      * @param color
     88      */
     89     public void setColor(ColorRGBA color) {
     90         this.color = color;
     91     }
     92 
     93     @Override
     94     protected void initFilter(AssetManager manager, RenderManager renderManager, ViewPort vp, int w, int h) {
     95         material = new Material(manager, "Common/MatDefs/Post/Overlay.j3md");
     96     }
     97 
     98     @Override
     99     public void write(JmeExporter ex) throws IOException {
    100         super.write(ex);
    101         OutputCapsule oc = ex.getCapsule(this);
    102         oc.write(color, "color", ColorRGBA.White);
    103     }
    104 
    105     @Override
    106     public void read(JmeImporter im) throws IOException {
    107         super.read(im);
    108         InputCapsule ic = im.getCapsule(this);
    109         color = (ColorRGBA) ic.readSavable("color", ColorRGBA.White);
    110     }
    111 }
    112