001: /*
002: * $RCSfile: DepthComponentFloat.java,v $
003: *
004: * Copyright 1997-2008 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
006: *
007: * This code is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU General Public License version 2 only, as
009: * published by the Free Software Foundation. Sun designates this
010: * particular file as subject to the "Classpath" exception as provided
011: * by Sun in the LICENSE file that accompanied this code.
012: *
013: * This code is distributed in the hope that it will be useful, but WITHOUT
014: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
015: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
016: * version 2 for more details (a copy is included in the LICENSE file that
017: * accompanied this code).
018: *
019: * You should have received a copy of the GNU General Public License version
020: * 2 along with this work; if not, write to the Free Software Foundation,
021: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
022: *
023: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
024: * CA 95054 USA or visit www.sun.com if you need additional information or
025: * have any questions.
026: *
027: * $Revision: 1.5 $
028: * $Date: 2008/02/28 20:17:20 $
029: * $State: Exp $
030: */
031:
032: package javax.media.j3d;
033:
034: /**
035: * A 2D array of depth (Z) values in floating point format in the range [0,1].
036: * A value of 0.0 indicates the closest Z value to the user while a value of
037: * 1.0 indicates the farthest Z value.
038: */
039:
040: public class DepthComponentFloat extends DepthComponent {
041:
042: /**
043: * Package scope defualt constructor used by cloneNodeComponent
044: */
045: DepthComponentFloat() {
046: }
047:
048: /**
049: * Constructs a new floating-point depth (z-buffer) component object with
050: * the specified width and height.
051: * @param width the width of the array of depth values
052: * @param height the height of the array of depth values
053: */
054: public DepthComponentFloat(int width, int height) {
055: ((DepthComponentFloatRetained) this .retained).initialize(width,
056: height);
057: }
058:
059: /**
060: * Copies the specified depth data to this object.
061: * @param depthData array of floats containing the depth data
062: * @exception RestrictedAccessException if the method is called
063: * when this object is part of live or compiled scene graph.
064: */
065: public void setDepthData(float[] depthData) {
066: checkForLiveOrCompiled();
067: ((DepthComponentFloatRetained) this .retained)
068: .setDepthData(depthData);
069: }
070:
071: /**
072: * Copies the depth data from this object to the specified array.
073: * The array must be large enough to hold all of the floats.
074: * @param depthData array of floats that will receive a copy of
075: * the depth data
076: * @exception CapabilityNotSetException if appropriate capability is
077: * not set and this object is part of live or compiled scene graph
078: */
079: public void getDepthData(float[] depthData) {
080: if (isLiveOrCompiled())
081: if (!this .getCapability(DepthComponent.ALLOW_DATA_READ))
082: throw new CapabilityNotSetException(J3dI18N
083: .getString("DepthComponentFloat0"));
084: ((DepthComponentFloatRetained) this .retained)
085: .getDepthData(depthData);
086: }
087:
088: /**
089: * Creates a retained mode DepthComponentFloatRetained object that this
090: * DepthComponentFloat component object will point to.
091: */
092: void createRetained() {
093: this .retained = new DepthComponentFloatRetained();
094: this .retained.setSource(this );
095: }
096:
097: /**
098: * @deprecated replaced with cloneNodeComponent(boolean forceDuplicate)
099: */
100: public NodeComponent cloneNodeComponent() {
101: DepthComponentFloatRetained rt = (DepthComponentFloatRetained) retained;
102: DepthComponentFloat d = new DepthComponentFloat(rt.width,
103: rt.height);
104: d.duplicateNodeComponent(this );
105: return d;
106: }
107:
108: /**
109: * Copies all node information from <code>originalNodeComponent</code> into
110: * the current node. This method is called from the
111: * <code>duplicateNode</code> method. This routine does
112: * the actual duplication of all "local data" (any data defined in
113: * this object).
114: *
115: * @param originalNodeComponent the original node to duplicate.
116: * @param forceDuplicate when set to <code>true</code>, causes the
117: * <code>duplicateOnCloneTree</code> flag to be ignored. When
118: * <code>false</code>, the value of each node's
119: * <code>duplicateOnCloneTree</code> variable determines whether
120: * NodeComponent data is duplicated or copied.
121: *
122: * @see Node#cloneTree
123: * @see NodeComponent#setDuplicateOnCloneTree
124: */
125: void duplicateAttributes(NodeComponent originalNodeComponent,
126: boolean forceDuplicate) {
127: super
128: .duplicateAttributes(originalNodeComponent,
129: forceDuplicate);
130: // width, height is copied in cloneNode before
131: int len = getWidth() * getHeight();
132: float f[] = new float[len];
133:
134: ((DepthComponentFloatRetained) originalNodeComponent.retained)
135: .getDepthData(f);
136: ((DepthComponentFloatRetained) retained).setDepthData(f);
137: }
138:
139: }
|