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 * Describes a cubemap texture. 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * The image specified by setImage must contain 6 data units, 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * each data contains a 2D image representing a cube's face. 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * The slices are specified in this order:<br/> 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <br/> 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 0 => Positive X (+x)<br/> 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1 => Negative X (-x)<br/> 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2 => Positive Y (+y)<br/> 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 3 => Negative Y (-y)<br/> 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 4 => Positive Z (+z)<br/> 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 5 => Negative Z (-z)<br/> 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author Joshua Slack 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class TextureCubeMap extends Texture { 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private WrapMode wrapS = WrapMode.EdgeClamp; 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private WrapMode wrapT = WrapMode.EdgeClamp; 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private WrapMode wrapR = WrapMode.EdgeClamp; 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Face of the Cubemap as described by its directional offset from the 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * origin. 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta// public enum Face { 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta// PositiveX, NegativeX, PositiveY, NegativeY, PositiveZ, NegativeZ; 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta// } 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public TextureCubeMap(){ 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(); 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public TextureCubeMap(Image img){ 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(); 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setImage(img); 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Texture createSimpleClone() { 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return createSimpleClone(new TextureCubeMap()); 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Texture createSimpleClone(Texture rVal) { 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta rVal.setWrap(WrapAxis.S, wrapS); 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta rVal.setWrap(WrapAxis.T, wrapT); 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta rVal.setWrap(WrapAxis.R, wrapR); 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return super.createSimpleClone(rVal); 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>setWrap</code> sets the wrap mode of this texture for a 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * particular axis. 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param axis 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the texture axis to define a wrapmode on. 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param mode 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the wrap mode for the given axis of the texture. 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @throws IllegalArgumentException 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * if axis or mode are null 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setWrap(WrapAxis axis, WrapMode mode) { 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (mode == null) { 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new IllegalArgumentException("mode can not be null."); 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } else if (axis == null) { 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new IllegalArgumentException("axis can not be null."); 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta switch (axis) { 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case S: 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapS = mode; 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta break; 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case T: 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapT = mode; 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta break; 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case R: 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapR = mode; 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta break; 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>setWrap</code> sets the wrap mode of this texture for all axis. 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param mode 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the wrap mode for the given axis of the texture. 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @throws IllegalArgumentException 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * if mode is null 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setWrap(WrapMode mode) { 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (mode == null) { 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new IllegalArgumentException("mode can not be null."); 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapS = mode; 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapT = mode; 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapR = mode; 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * <code>getWrap</code> returns the wrap mode for a given coordinate axis 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * on this texture. 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param axis 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the axis to return for 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @return the wrap mode of the texture. 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @throws IllegalArgumentException 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * if axis is null 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public WrapMode getWrap(WrapAxis axis) { 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta switch (axis) { 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case S: 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return wrapS; 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case T: 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return wrapT; 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta case R: 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return wrapR; 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new IllegalArgumentException("invalid WrapAxis: " + axis); 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 16159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Type getType() { 16259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return Type.CubeMap; 16359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 16659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean equals(Object other) { 16759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (!(other instanceof TextureCubeMap)) { 16859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return false; 16959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta TextureCubeMap that = (TextureCubeMap) other; 17159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (this.getWrap(WrapAxis.S) != that.getWrap(WrapAxis.S)) 17259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return false; 17359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (this.getWrap(WrapAxis.T) != that.getWrap(WrapAxis.T)) 17459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return false; 17559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (this.getWrap(WrapAxis.R) != that.getWrap(WrapAxis.R)) 17659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return false; 17759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return super.equals(other); 17859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 18159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public int hashCode() { 18259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta int hash = super.hashCode(); 18359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta hash = 53 * hash + (this.wrapS != null ? this.wrapS.hashCode() : 0); 18459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta hash = 53 * hash + (this.wrapT != null ? this.wrapT.hashCode() : 0); 18559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta hash = 53 * hash + (this.wrapR != null ? this.wrapR.hashCode() : 0); 18659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return hash; 18759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 19059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void write(JmeExporter e) throws IOException { 19159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.write(e); 19259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta OutputCapsule capsule = e.getCapsule(this); 19359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta capsule.write(wrapS, "wrapS", WrapMode.EdgeClamp); 19459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta capsule.write(wrapT, "wrapT", WrapMode.EdgeClamp); 19559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta capsule.write(wrapR, "wrapR", WrapMode.EdgeClamp); 19659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 19959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void read(JmeImporter e) throws IOException { 20059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super.read(e); 20159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta InputCapsule capsule = e.getCapsule(this); 20259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta wrapS = capsule.readEnum("wrapS", WrapMode.class, WrapMode.EdgeClamp); 20359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta wrapT = capsule.readEnum("wrapT", WrapMode.class, WrapMode.EdgeClamp); 20459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta wrapR = capsule.readEnum("wrapR", WrapMode.class, WrapMode.EdgeClamp); 20559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 207