aboutsummaryrefslogtreecommitdiffstats
path: root/src/javax/media/j3d/TextureCubeMap.java
diff options
context:
space:
mode:
authorJulien Gouesse <[email protected]>2015-11-28 15:11:48 +0100
committerJulien Gouesse <[email protected]>2015-11-28 15:11:48 +0100
commitdbc98deea1884e44da2c74d6ea807253cdefa693 (patch)
tree29c3ee7dea82d7dd773d81f33f645dde67e43a17 /src/javax/media/j3d/TextureCubeMap.java
parent2c99f1329dc55bd496bce91b9aba956ecba3c67e (diff)
Relocate package prefix to org.jogamp.java3d
Diffstat (limited to 'src/javax/media/j3d/TextureCubeMap.java')
-rw-r--r--src/javax/media/j3d/TextureCubeMap.java403
1 files changed, 0 insertions, 403 deletions
diff --git a/src/javax/media/j3d/TextureCubeMap.java b/src/javax/media/j3d/TextureCubeMap.java
deleted file mode 100644
index 10fbdd8..0000000
--- a/src/javax/media/j3d/TextureCubeMap.java
+++ /dev/null
@@ -1,403 +0,0 @@
-/*
- * Copyright 2001-2008 Sun Microsystems, Inc. All Rights Reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation. Sun designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Sun in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
- * CA 95054 USA or visit www.sun.com if you need additional information or
- * have any questions.
- *
- */
-
-package javax.media.j3d;
-
-
-/**
- * TextureCubeMap is a subclass of Texture class. It defines
- * a special kind of texture mapping which is composed of a set of six
- * 2D images representating the six faces of a cube. The texture coordinate
- * (s,t,r) is used as a 3D direction vector emanating from the center
- * of a cube to select a particular face of the cube based on the
- * largest magnitude coordinate (the major axis). A new 2D texture coordinate
- * (s,t) is then determined by dividing the other two coordinates (the minor
- * axes) by the major axis value. The new coordinate is then used for
- * texel lookup from the selected texture image of this cube map.
- *
- * The TextureCubeMap image is defined by specifying the images for each
- * face of the cube. The cube map texture can be thought of as centered at
- * the orgin of and aligned to an XYZ coordinate system. The names
- * of the cube faces are:
- *
- * <UL>
- * <LI>POSITIVE_X</LI>
- * <LI>NEGATIVE_X</LI>
- * <LI>POSITIVE_Y</LI>
- * <LI>NEGATIVE_Y</LI>
- * <LI>POSITIVE_Z</LI>
- * <LI>NEGATIVE_Z</LI>
- * </UL>
- *
- * <p>
- * Note that as of Java 3D 1.5, the texture width and height are no longer
- * required to be an exact power of two. However, not all graphics devices
- * supports non-power-of-two textures. If non-power-of-two texture mapping is
- * unsupported on a particular Canvas3D, textures with a width or height that
- * are not an exact power of two are ignored for that canvas.
- *
- * @see Canvas3D#queryProperties
- *
- * @since Java 3D 1.3
- */
-public class TextureCubeMap extends Texture {
-
- // TODO KCR : NPOT
-
- /**
- * Specifies the face of the cube that is pierced by the positive x axis
- */
- public static final int POSITIVE_X = 0;
-
- /**
- * Specifies the face of the cube that is pierced by the negative x axis
- */
- public static final int NEGATIVE_X = 1;
-
- /**
- * Specifies the face of the cube that is pierced by the positive y axis
- */
- public static final int POSITIVE_Y = 2;
-
- /**
- * Specifies the face of the cube that is pierced by the negative y axis
- */
- public static final int NEGATIVE_Y = 3;
-
- /**
- * Specifies the face of the cube that is pierced by the positive z axis
- */
- public static final int POSITIVE_Z = 4;
-
- /**
- * Specifies the face of the cube that is pierced by the negative z axis
- */
- public static final int NEGATIVE_Z = 5;
-
-
- /**
- * Constructs a texture object using default values.
- * Note that the default constructor creates a texture object with
- * a width of 0 and is, therefore, not useful.
- */
- public TextureCubeMap() {
- super();
- }
-
- /**
- * Constructs an empty TextureCubeMap object with specified mipmapMode
- * format, and width. Image at base level
- * must be set by
- * the application using 'setImage' method. If mipmapMode is
- * set to MULTI_LEVEL_MIPMAP, images for base level through maximum level
- * must be set.
- * Note that cube map is square in dimensions, hence specifying width
- * is sufficient.
- * Note also that a texture with a non-power-of-two width will
- * only be rendered on a graphics device that supports non-power-of-two
- * textures.
- *
- * @param mipmapMode type of mipmap for this Texture: One of
- * BASE_LEVEL, MULTI_LEVEL_MIPMAP.
- * @param format data format of Textures saved in this object.
- * One of INTENSITY, LUMINANCE, ALPHA, LUMINANCE_ALPHA, RGB, RGBA.
- * @param width width (and height) of image at level 0.
- * @exception IllegalArgumentException if width is not greater
- * than 0 OR invalid format/mipmapMode is specified.
- */
- public TextureCubeMap(
- int mipmapMode,
- int format,
- int width){
-
- super(mipmapMode, format, width, width);
- }
-
- /**
- * Constructs an empty TextureCubeMap object with specified mipmapMode
- * format, width, and boundary width. Image at base level
- * must be set by
- * the application using 'setImage' method. If mipmapMode is
- * set to MULTI_LEVEL_MIPMAP, images for base level through maximum level
- * must be set.
- * Note that cube map is square in dimensions, hence specifying width
- * is sufficient.
- * Note also that a texture with a non-power-of-two width will
- * only be rendered on a graphics device that supports non-power-of-two
- * textures.
- *
- * @param mipmapMode type of mipmap for this Texture: One of
- * BASE_LEVEL, MULTI_LEVEL_MIPMAP.
- * @param format data format of Textures saved in this object.
- * One of INTENSITY, LUMINANCE, ALPHA, LUMINANCE_ALPHA, RGB, RGBA.
- * @param width width (and height) of image at level 0. This
- * does not include the width of the boundary.
- * @param boundaryWidth width of the boundary, which must be 0 or 1.
- *
- * @exception IllegalArgumentException if width is not
- * greater than 0 OR invalid format/mipmapMode is specified.
- */
- public TextureCubeMap(
- int mipmapMode,
- int format,
- int width,
- int boundaryWidth){
-
- super(mipmapMode, format, width, width, boundaryWidth);
- }
-
- /**
- * Sets the image for a specified mipmap level of a specified face
- * of the cube map
- *
- * @param level mipmap level
- * @param face face of the cube map. One of:
- * <code>POSITIVE_X</code>, <code>NEGATIVE_X</code>,
- * <code>POSITIVE_Y</code>, <code>NEGATIVE_Y</code>,
- * <code>POSITIVE_Z</code> or <code>NEGATIVE_Z</code>.
- * @param image ImageComponent2D object containing the image
- *
- * @exception IllegalArgumentException if
- * <code>face</code> has a value other
- * than <code>POSITIVE_X</code>, <code>NEGATIVE_X</code>,
- * <code>POSITIVE_Y</code>, <code>NEGATIVE_Y</code>,
- * <code>POSITIVE_Z</code> or <code>NEGATIVE_Z</code>.
- *
- * @exception CapabilityNotSetException if appropriate capability is
- * not set and this object is part of live or compiled scene graph
- *
- * @exception IllegalSharingException if this TextureCubeMap is live and
- * the specified image is being used by a Canvas3D as an off-screen buffer.
- *
- * @exception IllegalSharingException if this TextureCubeMap is
- * being used by an immediate mode context and
- * the specified image is being used by a Canvas3D as an off-screen buffer.
- */
- public void setImage(int level, int face, ImageComponent2D image) {
- if (isLiveOrCompiled()) {
- if(!this.getCapability(ALLOW_IMAGE_WRITE))
- throw new CapabilityNotSetException(
- J3dI18N.getString("TextureCubeMap1"));
- }
-
- validateImageIllegalSharing(image);
-
- if (isLive())
- ((TextureCubeMapRetained)this.retained).setImage(level, face, image);
- else
- ((TextureCubeMapRetained)this.retained).initImage(level, face, image);
- }
-
- /**
- * Sets the array of images for mipmap levels from base level through
- * max level for a specified face of the cube map
- *
- * @param face face of the cube map. One of:
- * <code>POSITIVE_X</code>, <code>NEGATIVE_X</code>,
- * <code>POSITIVE_Y</code>, <code>NEGATIVE_Y</code>,
- * <code>POSITIVE_Z</code> or <code>NEGATIVE_Z</code>.
- * @param images array of ImageComponent2D objects containing the images
- *
- * @exception IllegalArgumentException if
- * <code>face</code> has a value other
- * than <code>POSITIVE_X</code>, <code>NEGATIVE_X</code>,
- * <code>POSITIVE_Y</code>, <code>NEGATIVE_Y</code>,
- * <code>POSITIVE_Z</code> or <code>NEGATIVE_Z</code>.
- *
- * @exception CapabilityNotSetException if appropriate capability is
- * not set and this object is part of live or compiled scene graph
- *
- * @exception IllegalSharingException if this TextureCubeMap is live and
- * any of the specified images are being used by a Canvas3D as an
- * off-screen buffer.
- *
- * @exception IllegalSharingException if this TextureCubeMap is
- * being used by an immediate mode context and
- * any of the specified images are being used by a Canvas3D as an
- * off-screen buffer.
- */
- public void setImages(int face, ImageComponent2D[] images) {
- if (isLiveOrCompiled()) {
- if(!this.getCapability(ALLOW_IMAGE_WRITE))
- throw new CapabilityNotSetException(
- J3dI18N.getString("TextureCubeMap1"));
- }
-
- // Do illegal sharing check
- for(int i=0; i<images.length; i++) {
- validateImageIllegalSharing(images[i]);
- }
-
- if (isLive())
- ((TextureCubeMapRetained)this.retained).setImages(face, images);
- else
- ((TextureCubeMapRetained)this.retained).initImages(face, images);
-
- }
-
-
- /**
- * Retrieves the image for a specified mipmap level of a particular
- * face of the cube map.
- * @param level mipmap level to get.
- * @param face face of the cube map. One of:
- * <code>POSITIVE_X</code>, <code>NEGATIVE_X</code>,
- * <code>POSITIVE_Y</code>, <code>NEGATIVE_Y</code>,
- * <code>POSITIVE_Z</code> or <code>NEGATIVE_Z</code>.
- * @return the ImageComponent object containing the texture image at
- * the specified mipmap level.
- *
- * @exception IllegalArgumentException if
- * <code>face</code> has a value other
- * than <code>POSITIVE_X</code>, <code>NEGATIVE_X</code>,
- * <code>POSITIVE_Y</code>, <code>NEGATIVE_Y</code>,
- * <code>POSITIVE_Z</code> or <code>NEGATIVE_Z</code>.
- *
- * @exception CapabilityNotSetException if appropriate capability is
- * not set and this object is part of live or compiled scene graph
- */
- public ImageComponent getImage(int level, int face) {
- if (isLiveOrCompiled()) {
- if(!this.getCapability(ALLOW_IMAGE_READ))
- throw new CapabilityNotSetException(
- J3dI18N.getString("TextureCubeMap2"));
- }
-
- return ((TextureCubeMapRetained)this.retained).getImage(level, face);
- }
-
- /**
- * Retrieves the array of images for all mipmap level of a particular
- * face of the cube map.
- * @param face face of the cube map. One of:
- * <code>POSITIVE_X</code>, <code>NEGATIVE_X</code>,
- * <code>POSITIVE_Y</code>, <code>NEGATIVE_Y</code>,
- * <code>POSITIVE_Z</code> or <code>NEGATIVE_Z</code>.
- * @return an array of ImageComponent object for the particular face of
- * of the cube map.
- *
- * @exception IllegalArgumentException if
- * <code>face</code> has a value other
- * than <code>POSITIVE_X</code>, <code>NEGATIVE_X</code>,
- * <code>POSITIVE_Y</code>, <code>NEGATIVE_Y</code>,
- * <code>POSITIVE_Z</code> or <code>NEGATIVE_Z</code>.
- *
- * @exception CapabilityNotSetException if appropriate capability is
- * not set and this object is part of live or compiled scene graph
- */
- public ImageComponent[] getImages(int face) {
- if (isLiveOrCompiled()) {
- if(!this.getCapability(ALLOW_IMAGE_READ))
- throw new CapabilityNotSetException(
- J3dI18N.getString("TextureCubeMap2"));
- }
-
- return ((TextureCubeMapRetained)this.retained).getImages(face);
- }
-
-
- /**
- * This method is not supported for TextureCubeMap.
- * A face of the cube map has to be specified when setting an image
- * for a particular level of the cube map.
- *
- * @exception UnsupportedOperationException this method is not supported
- *
- * @since Java 3D 1.3
- */
- @Override
- public void setImage(int level, ImageComponent image) {
- throw new UnsupportedOperationException();
- }
-
-
- /**
- * This method is not supported for TextureCubeMap.
- * A face of the cube map has to be specified when setting images
- * for the cube map.
- *
- * @exception UnsupportedOperationException this method is not supported
- *
- * @since Java 3D 1.3
- */
- @Override
- public void setImages(ImageComponent[] images) {
- throw new UnsupportedOperationException();
- }
-
- /**
- * This method is not supported for TextureCubeMap.
- * A face of the cube map has to be specified when retrieving an image
- * for a particular level of the cube map.
- *
- * @exception UnsupportedOperationException this method is not supported
- *
- * @since Java 3D 1.3
- */
- @Override
- public ImageComponent getImage(int level) {
- throw new UnsupportedOperationException();
- }
-
-
- /**
- * This method is not supported for TextureCubeMap.
- * A face of the cube map has to be specified when retrieving images
- * for the cube map.
- *
- * @exception UnsupportedOperationException this method is not supported
- *
- * @since Java 3D 1.3
- */
- @Override
- public ImageComponent[] getImages() {
- throw new UnsupportedOperationException();
- }
-
-
- /**
- * Creates a retained mode TextureCubeMapRetained object that this
- * TextureCubeMap component object will point to.
- */
- @Override
- void createRetained() {
- this.retained = new TextureCubeMapRetained();
- this.retained.setSource(this);
- }
-
- /**
- * NOTE: Applications should not call this method directly.
- * It should only be called by the cloneNode method.
- *
- * @deprecated replaced with duplicateNodeComponent(
- * NodeComponent originalNodeComponent, boolean forceDuplicate)
- */
- @Override
- public void duplicateNodeComponent(NodeComponent originalNodeComponent) {
- checkDuplicateNodeComponent(originalNodeComponent);
- }
-}
-