01: /*
02: * $RCSfile: ShaderAttributeBindingRetained.java,v $
03: *
04: * Copyright 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
05: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06: *
07: * This code is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU General Public License version 2 only, as
09: * published by the Free Software Foundation. Sun designates this
10: * particular file as subject to the "Classpath" exception as provided
11: * by Sun in the LICENSE file that accompanied this code.
12: *
13: * This code is distributed in the hope that it will be useful, but WITHOUT
14: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16: * version 2 for more details (a copy is included in the LICENSE file that
17: * accompanied this code).
18: *
19: * You should have received a copy of the GNU General Public License version
20: * 2 along with this work; if not, write to the Free Software Foundation,
21: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
22: *
23: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
24: * CA 95054 USA or visit www.sun.com if you need additional information or
25: * have any questions.
26: *
27: * $Revision: 1.5 $
28: * $Date: 2008/02/28 20:17:29 $
29: * $State: Exp $
30: */
31:
32: package javax.media.j3d;
33:
34: import javax.vecmath.*;
35:
36: /**
37: * The ShaderAttributeBinding object encapsulates a uniform attribute
38: * whose value is bound to a Java 3D system attribute. The
39: * shader variable <code>attrName</code> is implicitly set to the
40: * value of the corresponding Java 3D system attribute
41: * <code>j3dAttrName</code> during rendering. <code>attrName</code>
42: * must be the name of a valid uniform attribute in the shader in
43: * which it is used. Otherwise, the attribute name will be ignored and
44: * a runtime error may be generated. <code>j3dAttrName</code> must be
45: * the name of a predefined Java 3D system attribute. An
46: * IllegalArgumentException will be thrown if the specified
47: * <code>j3dAttrName</code> is not one of the predefined system
48: * attributes. Further, the type of the <code>j3dAttrName</code>
49: * attribute must match the type of the corresponding
50: * <code>attrName</code> variable in the shader in which it is
51: * used. Otherwise, the shader will not be able to use the attribute
52: * and a runtime error may be generated.
53: */
54:
55: class ShaderAttributeBindingRetained extends ShaderAttributeRetained {
56: String j3dAttrName;
57:
58: ShaderAttributeBindingRetained() {
59: }
60:
61: void initJ3dAttrName(String j3dAttrName) {
62: this .j3dAttrName = j3dAttrName;
63: }
64:
65: /**
66: * Retrieves the name of the Java 3D system attribute that is bound to this
67: * shader attribute.
68: *
69: * @return the name of the Java 3D system attribute that is bound to this
70: * shader attribute
71: */
72: String getJ3DAttributeName() {
73: return j3dAttrName;
74: }
75:
76: }
|