001: /*
002: * $RCSfile: ShaderAttributeValue.java,v $
003: *
004: * Copyright 2005-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:30 $
029: * $State: Exp $
030: */
031:
032: package javax.media.j3d;
033:
034: import javax.vecmath.*;
035:
036: /**
037: * The ShaderAttributeValue object encapsulates a uniform shader
038: * attribute whose value is specified explicitly. The shader variable
039: * <code>attrName</code> is explicitly set to the specified
040: * <code>value</code> during rendering. <code>attrName</code> must be
041: * the name of a valid uniform attribute in the shader in which it is
042: * used. Otherwise, the attribute name will be ignored and a runtime
043: * error may be generated. The <code>value</code> must be an instance
044: * of one of the allowed classes. The allowed classes are:
045: * <code>Integer</code>, <code>Float</code>,
046: * <code>Tuple{2,3,4}{i,f}</code>, <code>Matrix{3,4}f</code>. A
047: * ClassCastException will be thrown if a specified <code>value</code>
048: * object is not one of the allowed types. Further, the type of the
049: * value is immutable once a ShaderAttributeValue is constructed.
050: * Subsequent setValue operations must be called with an object of the
051: * same type as the one that was used to construct the
052: * ShaderAttributeValue. Finally, the type of the <code>value</code>
053: * object must match the type of the corresponding
054: * <code>attrName</code> variable in the shader in which it is
055: * used. Otherwise, the shader will not be able to use the attribute
056: * and a runtime error may be generated.
057: *
058: * @see ShaderAttributeSet
059: * @see ShaderProgram
060: *
061: * @since Java 3D 1.4
062: */
063:
064: public class ShaderAttributeValue extends ShaderAttributeObject {
065: /**
066: * Constructs a new ShaderAttributeValue object with the specified
067: * <code>(attrName, value)</code> pair.
068: * A copy of the object is stored.
069: *
070: * @param attrName the name of the shader attribute
071: * @param value the value of the shader attribute
072: *
073: * @exception NullPointerException if attrName or value is null
074: *
075: * @exception ClassCastException if value is not an instance of
076: * one of the allowed classes
077: */
078: public ShaderAttributeValue(String attrName, Object value) {
079: super (attrName, value);
080: }
081:
082: // Implement abstract getValue method
083: public Object getValue() {
084:
085: if (isLiveOrCompiled())
086: if (!this .getCapability(ALLOW_VALUE_READ))
087: throw new CapabilityNotSetException(J3dI18N
088: .getString("ShaderAttributeObject0"));
089:
090: return ((ShaderAttributeValueRetained) this .retained)
091: .getValue();
092: }
093:
094: // Implement abstract setValue method
095: public void setValue(Object value) {
096:
097: if (value == null) {
098: throw new NullPointerException();
099: }
100:
101: if (isLiveOrCompiled())
102: if (!this .getCapability(ALLOW_VALUE_WRITE))
103: throw new CapabilityNotSetException(J3dI18N
104: .getString("ShaderAttributeObject1"));
105:
106: if (isLive())
107: ((ShaderAttributeValueRetained) this .retained)
108: .setValue(value);
109: else
110: ((ShaderAttributeValueRetained) this .retained)
111: .initValue(value);
112:
113: }
114:
115: /**
116: * Creates a retained mode ShaderAttributeValueRetained object that this
117: * ShaderAttributeValue component object will point to.
118: */
119: void createRetained() {
120: this .retained = new ShaderAttributeValueRetained();
121: this.retained.setSource(this);
122: }
123:
124: }
|