159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2009-2010 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.texture; 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.InputCapsule; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.JmeExporter; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.JmeImporter; 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.export.OutputCapsule; 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.io.IOException; 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author Joshua Slack 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class Texture2D extends Texture { 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private WrapMode wrapS = WrapMode.EdgeClamp; 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private WrapMode wrapT = WrapMode.EdgeClamp; 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Creates a new two-dimensional texture with default attributes. 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Texture2D(){ 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(); 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Creates a new two-dimensional texture using the given image. 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param img The image to use. 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Texture2D(Image img){ 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(); 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setImage(img); 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (img.getFormat().isDepthFormat()){ 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setMagFilter(MagFilter.Nearest); 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setMinFilter(MinFilter.NearestNoMipMaps); 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Creates a new two-dimensional texture for the purpose of offscreen 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * rendering. 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @see com.jme3.texture.FrameBuffer 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param width 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param height 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param format 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Texture2D(int width, int height, Image.Format format){ 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this(new Image(format, width, height, null)); 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Creates a new two-dimensional texture for the purpose of offscreen 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * rendering. 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @see com.jme3.texture.FrameBuffer 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param width 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param height 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param format 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param numSamples 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Texture2D(int width, int height, int numSamples, Image.Format format){ 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this(new Image(format, width, height, null)); 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta getImage().setMultiSamples(numSamples); 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Texture createSimpleClone() { 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Texture2D clone = new Texture2D(); 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta createSimpleClone(clone); 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return clone; 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Texture createSimpleClone(Texture rVal) { 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta rVal.setWrap(WrapAxis.S, wrapS); 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta rVal.setWrap(WrapAxis.T, wrapT); 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return super.createSimpleClone(rVal); 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>setWrap</code> sets the wrap mode of this texture for a 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * particular axis. 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param axis 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the texture axis to define a wrapmode on. 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param mode 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the wrap mode for the given axis of the texture. 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @throws IllegalArgumentException 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * if axis or mode are null 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setWrap(WrapAxis axis, WrapMode mode) { 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (mode == null) { 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new IllegalArgumentException("mode can not be null."); 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } else if (axis == null) { 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new IllegalArgumentException("axis can not be null."); 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta switch (axis) { 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case S: 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapS = mode; 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta break; 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case T: 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapT = mode; 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta break; 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta default: 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new IllegalArgumentException("Not applicable for 2D textures"); 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>setWrap</code> sets the wrap mode of this texture for all axis. 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param mode 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the wrap mode for the given axis of the texture. 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @throws IllegalArgumentException 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * if mode is null 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setWrap(WrapMode mode) { 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (mode == null) { 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new IllegalArgumentException("mode can not be null."); 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapS = mode; 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapT = mode; 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>getWrap</code> returns the wrap mode for a given coordinate axis 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * on this texture. 16159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 16259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param axis 16359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the axis to return for 16459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return the wrap mode of the texture. 16559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @throws IllegalArgumentException 16659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * if axis is null 16759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 16859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public WrapMode getWrap(WrapAxis axis) { 16959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta switch (axis) { 17059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case S: 17159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return wrapS; 17259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case T: 17359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return wrapT; 17459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta default: 17559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new IllegalArgumentException("invalid WrapAxis: " + axis); 17659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 18059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Type getType() { 18159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return Type.TwoDimensional; 18259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 18559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean equals(Object other) { 18659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (!(other instanceof Texture2D)) { 18759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return false; 18859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Texture2D that = (Texture2D) other; 19059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (this.getWrap(WrapAxis.S) != that.getWrap(WrapAxis.S)) 19159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return false; 19259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (this.getWrap(WrapAxis.T) != that.getWrap(WrapAxis.T)) 19359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return false; 19459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return super.equals(other); 19559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 19859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public int hashCode() { 19959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta int hash = super.hashCode(); 20059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta hash = 79 * hash + (this.wrapS != null ? this.wrapS.hashCode() : 0); 20159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta hash = 79 * hash + (this.wrapT != null ? this.wrapT.hashCode() : 0); 20259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return hash; 20359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 20559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 20659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void write(JmeExporter e) throws IOException { 20759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.write(e); 20859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta OutputCapsule capsule = e.getCapsule(this); 20959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta capsule.write(wrapS, "wrapS", WrapMode.EdgeClamp); 21059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta capsule.write(wrapT, "wrapT", WrapMode.EdgeClamp); 21159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 21259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 21359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 21459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void read(JmeImporter e) throws IOException { 21559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.read(e); 21659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta InputCapsule capsule = e.getCapsule(this); 21759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta wrapS = capsule.readEnum("wrapS", WrapMode.class, WrapMode.EdgeClamp); 21859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta wrapT = capsule.readEnum("wrapT", WrapMode.class, WrapMode.EdgeClamp); 21959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 22059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 22159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 222