aboutsummaryrefslogtreecommitdiffstats
path: root/src/javax/media/j3d/PointAttributes.java
blob: 2c5135a6af14ff8d6f217fd5dcbd47b52d60fe9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
/*
 * Copyright 1997-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;

/**
 * The PointAttributes object defines all attributes that apply to
 * point primitives. The point attributes that can be defined are:<p>
 * <ul>
 * <li>Size - the size of the point, in pixels. The default is a point
 * size of one pixel.</li><p>
 * <li>Antialiasing - for points greater than one-pixel in size,
 * antialiasing smooths the outline of the point when it is rendered.</li>
 * <p></ul>
 * If antialiasing is disabled (the default), fractional point sizes
 * are rounded to integer sizes, and a screen-aligned square region
 * of pixels is drawn.<p>
 * <p>
 * If antialiasing is enabled, the points are considered transparent
 * for rendering purposes.  They are rendered with all the other transparent
 * objects and adhere to the other transparency settings such as the
 * View transparency sorting policy and the View depth buffer freeze
 * transparent enable.
 * </p>
 *
 * @see Appearance
 * @see View
 */
public class PointAttributes extends NodeComponent {

    /**
     * Specifies that this PointAttributes object allows reading its
     * point size information.
     */
    public static final int
    ALLOW_SIZE_READ = CapabilityBits.POINT_ATTRIBUTES_ALLOW_SIZE_READ;

    /**
     * Specifies that this PointAttributes object allows writing its
     * point size information.
     */
    public static final int
    ALLOW_SIZE_WRITE = CapabilityBits.POINT_ATTRIBUTES_ALLOW_SIZE_WRITE;

    /**
     * Specifies that this PointAttributes object allows reading its
     * point antialiasing flag.
     */
    public static final int
    ALLOW_ANTIALIASING_READ = CapabilityBits.POINT_ATTRIBUTES_ALLOW_ANTIALIASING_READ;

    /**
     * Specifies that this PointAttributes object allows writing its
     * point antialiasing flag.
     */
    public static final int
    ALLOW_ANTIALIASING_WRITE = CapabilityBits.POINT_ATTRIBUTES_ALLOW_ANTIALIASING_WRITE;

       // Array for setting default read capabilities
    private static final int[] readCapabilities = {
        ALLOW_SIZE_READ,
        ALLOW_ANTIALIASING_READ
    };

    /**
     * Constructs a PointAttributes object with default parameters.
     * The default values are as follows:
     * <ul>
     * point size : 1<br>
     * point antialiasing : false<br>
     * </ul>
     */
     public PointAttributes(){
        // set default read capabilities
        setDefaultReadCapabilities(readCapabilities);
      }

    /**
     * Constructs a PointAttributes object with specified values.
     * @param pointSize the size of points, in pixels
     * @param pointAntialiasing flag to set point antialising ON or OFF
     */
     public PointAttributes(float pointSize, boolean pointAntialiasing){
        // set default read capabilities
        setDefaultReadCapabilities(readCapabilities);

        ((PointAttributesRetained)this.retained).initPointSize(pointSize);
       ((PointAttributesRetained)this.retained).initPointAntialiasingEnable(pointAntialiasing);
     }

    /**
     * Sets the point size for this appearance component object.
     * @param pointSize the size, in pixels, of point primitives
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public void setPointSize(float pointSize) {
        if (isLiveOrCompiled())
            if(!this.getCapability(ALLOW_SIZE_WRITE))
              throw new CapabilityNotSetException(J3dI18N.getString("PointAttributes0"));

	if (isLive())
	    ((PointAttributesRetained)this.retained).setPointSize(pointSize);
	else
	    ((PointAttributesRetained)this.retained).initPointSize(pointSize);

    }

    /**
     * Gets the point size for this appearance component object.
     * @return the size, in pixels, of point primitives
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public float getPointSize() {
        if (isLiveOrCompiled())
            if(!this.getCapability(ALLOW_SIZE_READ))
              throw new CapabilityNotSetException(J3dI18N.getString("PointAttributes1"));
	return ((PointAttributesRetained)this.retained).getPointSize();
    }

    /**
     * Enables or disables point antialiasing
     * for this appearance component object.
     * <p>
     * If antialiasing is enabled, the points are considered transparent
     * for rendering purposes.  They are rendered with all the other
     * transparent objects and adhere to the other transparency settings
     * such as the View transparency sorting policy and the View depth
     * buffer freeze transparent enable.
     * </p>
     * @param state true or false to enable or disable point antialiasing
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     * @see View
     */
    public void setPointAntialiasingEnable(boolean state) {
        if (isLiveOrCompiled())
            if(!this.getCapability(ALLOW_ANTIALIASING_WRITE))
              throw new CapabilityNotSetException(J3dI18N.getString("PointAttributes2"));
	if (isLive())
	    ((PointAttributesRetained)this.retained).setPointAntialiasingEnable(state);
	else
	    ((PointAttributesRetained)this.retained).initPointAntialiasingEnable(state);

    }

    /**
     * Retrieves the state of the point antialiasing flag.
     * @return true if point antialiasing is enabled,
     * false if point antialiasing is disabled
     * @exception CapabilityNotSetException if appropriate capability is
     * not set and this object is part of live or compiled scene graph
     */
    public boolean getPointAntialiasingEnable() {
        if (isLiveOrCompiled())
            if(!this.getCapability(ALLOW_ANTIALIASING_READ))
              throw new CapabilityNotSetException(J3dI18N.getString("PointAttributes3"));
	return ((PointAttributesRetained)this.retained).getPointAntialiasingEnable();
    }

    /**
     * Creates a retained mode PointAttributesRetained object that this
     * PointAttributes component object will point to.
     */
    @Override
    void createRetained() {
	this.retained = new PointAttributesRetained();
	this.retained.setSource(this);
    }

   /**
    * @deprecated replaced with cloneNodeComponent(boolean forceDuplicate)
    */
    @Override
    public NodeComponent cloneNodeComponent() {
        PointAttributes pa = new PointAttributes();
        pa.duplicateNodeComponent(this);
        return pa;
    }


     /**
     * Copies all node information from <code>originalNodeComponent</code> into
     * the current node.  This method is called from the
     * <code>duplicateNode</code> method. This routine does
     * the actual duplication of all "local data" (any data defined in
     * this object).
     *
     * @param originalNodeComponent the original node to duplicate.
     * @param forceDuplicate when set to <code>true</code>, causes the
     *  <code>duplicateOnCloneTree</code> flag to be ignored.  When
     *  <code>false</code>, the value of each node's
     *  <code>duplicateOnCloneTree</code> variable determines whether
     *  NodeComponent data is duplicated or copied.
     *
     * @see Node#cloneTree
     * @see NodeComponent#setDuplicateOnCloneTree
     */
    @Override
    void duplicateAttributes(NodeComponent originalNodeComponent,
			     boolean forceDuplicate) {
	super.duplicateAttributes(originalNodeComponent, forceDuplicate);

	PointAttributesRetained attr = (PointAttributesRetained)
	                         originalNodeComponent.retained;
	PointAttributesRetained rt = (PointAttributesRetained) retained;

	rt.initPointSize(attr.getPointSize());
	rt.initPointAntialiasingEnable(attr.getPointAntialiasingEnable());
    }

}