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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
|
/*
* 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;
import javax.vecmath.Color4f;
/**
* The TextureAttributes object defines attributes that apply to
* texture mapping.
* The texture attributes include the following:<P>
* <UL>
* <LI>Texture mode - defines how the object and texture colors
* are blended. The mode may be one of the following:</LI><P>
* <UL>
* <LI>MODULATE - modulates the incoming color with the texture
* color.<P>
* <UL>
* C' = C Ct
* </UL></LI><P>
* <LI>DECAL - applies the texture color to the incoming color as a decal.<P>
* <UL>
* C'<sub>rgb</sub> = C<sub>rgb</sub> (1 - Ct<sub>a</sub>) + Ct<sub>rgb</sub> Ct<sub>a</sub><P>
* C'<sub>a</sub> = C<sub>a</sub>
* </UL></LI><P>
* <LI>BLEND - blends the texture blend color with the incoming color.<P>
* <UL>
* C'<sub>rgb</sub> = C<sub>rgb</sub> (1 - Ct<sub>rgb</sub>) + Cb<sub>rgb</sub> Ct<sub>rgb</sub><P>
* C'<sub>a</sub> = C<sub>a</sub> Ct<sub>a</sub><P>
* </UL>
* Note that if the texture format is INTENSITY, alpha is computed identically
* to red, green, and blue: <P>
* <UL>
* C'<sub>a</sub> = C<sub>a</sub> (1 - Ct<sub>a</sub>) + Cb<sub>a</sub> Ct<sub>a</sub>
* </UL></LI><P>
* <LI>REPLACE - replaces the incoming color with the texture color.<P>
* <UL>
* C' = Ct <P>
* </UL></LI><P>
* <LI>COMBINE - combines the object color with the texture color or texture
* blend color according to the combine operation as specified in the
* texture combine mode. </LI><P>
* <p>
* </UL>
* C = Incoming color to the texture unit state. For texture unit state 0, C is the object color
* Ct = Texture color<br>
* Cb = Texture blend color<br>
* <p>
* <LI>Combine Mode - defines the combine operation when texture mode
* specifies COMBINE. The combine mode includes the following:<p>
* <UL>
* <LI>COMBINE_REPLACE<P>
* <UL>
* C' = C<sub>0</sub> <P>
* </UL></LI><P>
* <LI>COMBINE_MODULATE<P>
* <UL>
* C' = C<sub>0</sub> C<sub>1</sub>
* </UL></LI><P>
* <LI>COMBINE_ADD<P>
* <UL>
* C' = C<sub>0</sub> + C<sub>1</sub> <P>
* </UL></LI><P>
* <LI>COMBINE_ADD_SIGNED <P>
* <UL>
* C' = C<sub>0</sub> + C<sub>1</sub> - 0.5 <P>
* </UL></LI><P>
* <LI>COMBINE_SUBTRACT <P>
* <UL>
* C' = C<sub>0</sub> - C<sub>1</sub> <P>
* </UL></LI><P>
* <LI>COMBINE_INTERPOLATE<P>
* <UL>
* C' = C<sub>0</sub> C<sub>2</sub> + C<sub>1</sub> (1 - C<sub>2</sub>) <P>
* </UL></LI><P>
* <LI>COMBINE_DOT3<P>
* <UL>
* C' = 4 * (
* (C<sub>0<sub>r</sub></sub> - 0.5) * (C<sub>1<sub>r</sub></sub> - 0.5) +
* (C<sub>0<sub>g</sub></sub> - 0.5) * (C<sub>1<sub>g</sub></sub> - 0.5) +
* (C<sub>0<sub>b</sub></sub> - 0.5) * (C<sub>1<sub>b</sub></sub> - 0.5))<P>
* where C<sub>N<sub>x</sub></sub> is the x component of the Nth color operand
* in the combine operation.<P>
* The value C' will be placed to the all three r,g,b components or the
* a component of the output.
* </UL></LI><P>
* </UL></LI><P>
* where C<sub>0</sub>, C<sub>1</sub> and C<sub>2</sub> are determined by
* the color source, and the color operand.
* </UL></LI><P>
* <UL>
* <LI>Combine Color Source - defines the source for a color operand in the
* combine operation. The color source includes the following:<p>
* <UL>
* <LI> COMBINE_OBJECT_COLOR - object color<P>
* <LI> COMBINE_TEXTURE_COLOR - texture color<P>
* <LI> COMBINE_CONSTANT_COLOR - texture blend color<P>
* <LI> COMBINE_PREVIOUS_TEXTURE_UNIT_STATE - color from the previous texture
* unit state. For texture unit state 0, this is equivalent to
* COMBINE_OBJECT_COLOR.<P>
* </UL></LI><P>
* <LI>Combine Color Function - specifies the function for a color operand
* in the combine operation. The valid values are:<P>
* <UL>
* <LI>COMBINE_SRC_COLOR - the color function is f = C<sub>rgb</sub><P>
* <LI>COMBINE_ONE_MINUS_SRC_COLOR - the color function is f = (1 - C<sub>rgb</sub>)<P>
* <LI>COMBINE_SRC_ALPHA - the color function is f = C<sub>a</sub><P>
* <LI>COMBINE_ONE_MINUS_SRC_ALPHA - the color function is f = (1 - C<sub>a</sub>)<P>
* </UL></LI><P>
* <LI>Combine scale factor - specifies the scale factor to be applied to
* the output color of the combine operation. The valid values include:
* 1, 2, or 4.</LI><P>
* <LI>Transform - the texture transform object used to transform
* texture coordinates. The texture transform can translate, scale,
* or rotate the texture coordinates before the texture is applied
* to the object.</LI><P>
* <LI>Blend color - the constant texture blend color</LI><P>
* <LI>Perspective correction - the perspective correction mode
* used for color and texture coordinate interpolation. One of
* the following:</LI><P>
* <UL>
* <LI>NICEST - uses the nicest (highest quality) available
* method for texture mapping perspective correction.</LI><P>
* <LI>FASTEST - uses the fastest available method for texture
* mapping perspective correction.</LI><P>
* </UL>
* <LI>Texture color table - defines a table that is used to look up
* texture colors before applying the texture mode.</LI>
* </UL>
*
* @see Appearance
* @see Canvas3D#queryProperties
*/
public class TextureAttributes extends NodeComponent {
/**
* Specifies that this TextureAttributes object allows
* reading its texture mode component
* information and perspective correction mode.
*/
public static final int
ALLOW_MODE_READ = CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_MODE_READ;
/**
* Specifies that this TextureAttributes object allows
* writing its texture mode component
* information and perspective correction mode.
*/
public static final int
ALLOW_MODE_WRITE = CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_MODE_WRITE;
/**
* Specifies that this TextureAttributes object allows
* reading its texture blend color component
* information.
*/
public static final int
ALLOW_BLEND_COLOR_READ = CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_BLEND_COLOR_READ;
/**
* Specifies that this TextureAttributes object allows
* writing its texture blend color component
* information.
*/
public static final int
ALLOW_BLEND_COLOR_WRITE = CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_BLEND_COLOR_WRITE;
/**
* Specifies that this TextureAttributes object allows
* reading its texture transform component
* information.
*/
public static final int
ALLOW_TRANSFORM_READ = CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_TRANSFORM_READ;
/**
* Specifies that this TextureAttributes object allows
* writing its texture transform component
* information.
*/
public static final int
ALLOW_TRANSFORM_WRITE = CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_TRANSFORM_WRITE;
/**
* Specifies that this TextureAttributes object allows
* reading its texture color table component
* information.
*
* @since Java 3D 1.2
*/
public static final int ALLOW_COLOR_TABLE_READ =
CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_COLOR_TABLE_READ;
/**
* Specifies that this TextureAttributes object allows
* writing its texture color table component
* information.
*
* @since Java 3D 1.2
*/
public static final int ALLOW_COLOR_TABLE_WRITE =
CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_COLOR_TABLE_WRITE;
/**
* Specifies that this TextureAttributes object allows
* reading its texture combine mode information. (e.g. combine mode,
* combine color source, combine color function, combine scale factor)
*
* @since Java 3D 1.3
*/
public static final int ALLOW_COMBINE_READ =
CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_COMBINE_READ;
/**
* Specifies that this TextureAttributes object allows
* writing its texture combine mode information. (e.g. combine mode,
* combine color source, combine color function, combine scale factor)
*
* @since Java 3D 1.3
*/
public static final int ALLOW_COMBINE_WRITE =
CapabilityBits.TEXTURE_ATTRIBUTES_ALLOW_COMBINE_WRITE;
/**
* Use the fastest available method for perspective correction.
* @see #setPerspectiveCorrectionMode
*/
public static final int FASTEST = 0;
/**
* Use the nicest (highest quality) available method for texture
* mapping perspective correction.
* @see #setPerspectiveCorrectionMode
*/
public static final int NICEST = 1;
/**
* Modulate the object color with the texture color.
* @see #setTextureMode
*/
public static final int MODULATE = 2;
/**
* Apply the texture color to the object as a decal.
* @see #setTextureMode
*/
public static final int DECAL = 3;
/**
* Blend the texture blend color with the object color.
* @see #setTextureMode
*/
public static final int BLEND = 4;
/**
* Replace the object color with the texture color.
* @see #setTextureMode
*/
public static final int REPLACE = 5;
/**
* Combine the object color with texture color as specified in
* the combine mode.
*
* @see #setTextureMode
* @since Java 3D 1.3
*/
public static final int COMBINE = 6;
/**
* Replace the input color with the specified color.
*
* @since Java 3D 1.3
* @see #setCombineRgbMode
* @see #setCombineAlphaMode
*/
public static final int COMBINE_REPLACE = 0;
/**
* Modulates one color with another color.
*
* @since Java 3D 1.3
* @see #setCombineRgbMode
* @see #setCombineAlphaMode
*/
public static final int COMBINE_MODULATE = 1;
/**
* Add two colors.
*
* @since Java 3D 1.3
* @see #setCombineRgbMode
* @see #setCombineAlphaMode
*/
public static final int COMBINE_ADD = 2;
/**
* Add two colors plus an implicit offset.
*
* @since Java 3D 1.3
* @see #setCombineRgbMode
* @see #setCombineAlphaMode
*/
public static final int COMBINE_ADD_SIGNED = 3;
/**
* Subtract one color from another color.
*
* @since Java 3D 1.3
* @see #setCombineRgbMode
* @see #setCombineAlphaMode
*/
public static final int COMBINE_SUBTRACT = 4;
/**
* Interpolate two colors with a factor.
*
* @since Java 3D 1.3
* @see #setCombineRgbMode
* @see #setCombineAlphaMode
*/
public static final int COMBINE_INTERPOLATE = 5;
/**
* Dot product of two colors.
*
* @since Java 3D 1.3
* @see #setCombineRgbMode
* @see #setCombineAlphaMode
*/
public static final int COMBINE_DOT3 = 6;
/**
* Object color coming into the texturing state.
*
* @since Java 3D 1.3
* @see #setCombineRgbSource
* @see #setCombineAlphaSource
*/
public static final int COMBINE_OBJECT_COLOR = 0;
/**
* Texture color of the corresponding texture unit state.
*
* @since Java 3D 1.3
* @see #setCombineRgbSource
* @see #setCombineAlphaSource
*/
public static final int COMBINE_TEXTURE_COLOR = 1;
/**
* Texture blend color.
*
* @since Java 3D 1.3
* @see #setCombineRgbSource
* @see #setCombineAlphaSource
*/
public static final int COMBINE_CONSTANT_COLOR = 2;
/**
* Color from the previous texture unit state.
*
* @since Java 3D 1.3
* @see #setCombineRgbSource
* @see #setCombineAlphaSource
*/
public static final int COMBINE_PREVIOUS_TEXTURE_UNIT_STATE = 3;
/**
* Color function is f = C<sub>rgb</sub>
*
* @since Java 3D 1.3
* @see #setCombineRgbFunction
*/
public static final int COMBINE_SRC_COLOR = 0;
/**
* Color function is f = (1 - C<sub>rgb</sub>)
*
* @since Java 3D 1.3
* @see #setCombineRgbFunction
*/
public static final int COMBINE_ONE_MINUS_SRC_COLOR = 1;
/**
* Color function is f = C<sub>a</sub>
*
* @since Java 3D 1.3
* @see #setCombineRgbFunction
* @see #setCombineAlphaFunction
*/
public static final int COMBINE_SRC_ALPHA = 2;
/**
* Color function is f = (1 - C<sub>a</sub>)
*
* @since Java 3D 1.3
* @see #setCombineRgbFunction
* @see #setCombineAlphaFunction
*/
public static final int COMBINE_ONE_MINUS_SRC_ALPHA = 3;
// Array for setting default read capabilities
private static final int[] readCapabilities = {
ALLOW_BLEND_COLOR_READ,
ALLOW_COLOR_TABLE_READ,
ALLOW_COMBINE_READ,
ALLOW_MODE_READ,
ALLOW_TRANSFORM_READ
};
/**
* Constructs a TextureAttributes object with default parameters.
* The default values are as follows:
* <ul>
* texture mode : REPLACE<br>
* blend color : black (0,0,0,0)<br>
* transform : identity<br>
* perspective correction mode : NICEST<br>
* texture color table : null<br>
* combine rgb mode : COMBINE_MODULATE<br>
* combine alpha mode : COMBINE_MODULATE<br>
* combine rgb source :
* <ul>
* C<sub>0</sub>=COMBINE_TEXTURE_COLOR<br>
* C<sub>1</sub>=COMBINE_PREVIOUS_TEXTURE_UNIT_STATE<br>
* C<sub>2</sub>=COMBINE_CONSTANT_COLOR<br>
* </ul>
* combine alpha source :
* <ul>
* C<sub>0</sub>=COMBINE_TEXTURE_COLOR<br>
* C<sub>1</sub>=COMBINE_PREVIOUS_TEXTURE_UNIT_STATE<br>
* C<sub>2</sub>=COMBINE_CONSTANT_COLOR<br>
* </ul>
* combine rgb function : COMBINE_SRC_COLOR<br>
* combine alpha function : COMBINE_SRC_ALPHA<br>
* combine rgb scale : 1<br>
* combine alpha scale : 1<br>
* </ul>
*/
public TextureAttributes() {
// set default read capabilities
setDefaultReadCapabilities(readCapabilities);
}
/**
* Constructs a TextureAttributes object with the specified values.
* @param textureMode the texture mode; one of <code>MODULATE</code>,
* <code>DECAL</code>, <code>BLEND</code>, <code>REPLACE</code>, or
* <code>COMBINE</code>
* @param transform the transform object, used to transform texture
* coordinates
* @param textureBlendColor the texture constant color
* @param perspCorrectionMode the perspective correction mode to
* be used for color and/or texture coordinate interpolation;
* one of <code>NICEST</code> or <code>FASTEST</code>
* @exception IllegalArgumentException if <code>textureMode</code>
* is a value other than <code>MODULATE</code>,
* <code>DECAL</code>, <code>BLEND</code>, <code>REPLACE</code>, or
* <code>COMBINE</code>
* @exception IllegalArgumentException if mode value is other
* than <code>FASTEST</code> or <code>NICEST</code>.
*/
public TextureAttributes(int textureMode, Transform3D transform,
Color4f textureBlendColor,
int perspCorrectionMode) {
if ((textureMode < MODULATE) || (textureMode > COMBINE)) {
throw new IllegalArgumentException(J3dI18N.getString("TextureAttributes10"));
}
if ((perspCorrectionMode != FASTEST) &&
(perspCorrectionMode!= NICEST)) {
throw new IllegalArgumentException(J3dI18N.getString("TextureAttributes9"));
}
// set default read capabilities
setDefaultReadCapabilities(readCapabilities);
((TextureAttributesRetained)this.retained).initTextureMode(textureMode);
((TextureAttributesRetained)this.retained).initTextureBlendColor(textureBlendColor);
((TextureAttributesRetained)this.retained).initTextureTransform(transform);
((TextureAttributesRetained)this.retained).initPerspectiveCorrectionMode(perspCorrectionMode);
}
/**
* Sets the texture mode parameter for this
* appearance component object.
* @param textureMode the texture mode, one of: <code>MODULATE</code>,
* <code>DECAL</code>, <code>BLEND</code>, <code>REPLACE</code>, or
* <code>COMBINE</code>
* @exception IllegalArgumentException if <code>textureMode</code>
* is a value other than <code>MODULATE</code>,
* <code>DECAL</code>, <code>BLEND</code>, <code>REPLACE</code>, or
* <code>COMBINE</code>
*
* @see Canvas3D#queryProperties
*/
public void setTextureMode(int textureMode) {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_MODE_WRITE))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes0"));
if ((textureMode < MODULATE) || (textureMode > COMBINE)) {
throw new IllegalArgumentException(J3dI18N.getString("TextureAttributes10"));
}
if (isLive())
((TextureAttributesRetained)this.retained).setTextureMode(textureMode);
else
((TextureAttributesRetained)this.retained).initTextureMode(textureMode);
}
/**
* Gets the texture mode parameter for this
* texture attributes object.
* @return textureMode the texture mode
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*/
public int getTextureMode() {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_MODE_READ))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes1"));
return ((TextureAttributesRetained)this.retained).getTextureMode();
}
/**
* Sets the texture constant color for this
* texture attributes object.
* @param textureBlendColor the texture constant color
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*/
public void setTextureBlendColor(Color4f textureBlendColor) {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_BLEND_COLOR_WRITE))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes2"));
if (isLive())
((TextureAttributesRetained)this.retained).setTextureBlendColor(textureBlendColor);
else
((TextureAttributesRetained)this.retained).initTextureBlendColor(textureBlendColor);
}
/**
* Sets the texture blend color for this
* appearance component object.
* @param r the red component of the color
* @param g the green component of the color
* @param b the blue component of the color
* @param a the alpha component of the color
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*/
public void setTextureBlendColor(float r, float g, float b, float a) {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_BLEND_COLOR_WRITE))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes3"));
if (isLive())
((TextureAttributesRetained)this.retained).setTextureBlendColor(r, g, b, a);
else
((TextureAttributesRetained)this.retained).initTextureBlendColor(r, g, b, a);
}
/**
* Gets the texture blend color for this
* appearance component object.
* @param textureBlendColor the vector that will receive the texture
* constant color
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*/
public void getTextureBlendColor(Color4f textureBlendColor) {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_BLEND_COLOR_READ))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes4"));
((TextureAttributesRetained)this.retained).getTextureBlendColor(textureBlendColor);
}
/**
* Sets the texture transform object used to transform texture
* coordinates. A copy of the specified Transform3D object is
* stored in this TextureAttributes object.
* @param transform the new transform object
* @exception CapabilityNotSetException if the method is called
* when this object is part of live or compiled scene graph.
*/
public void setTextureTransform(Transform3D transform) {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_TRANSFORM_WRITE))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes5"));
if (isLive())
((TextureAttributesRetained)this.retained).setTextureTransform(transform);
else
((TextureAttributesRetained)this.retained).initTextureTransform(transform);
}
/**
* Retrieves a copy of the texture transform object.
* @param transform the transform object that will receive the
* current texture transform
* @exception CapabilityNotSetException if the method is called
* when this object is part of live or compiled scene graph.
*/
public void getTextureTransform(Transform3D transform) {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_TRANSFORM_READ))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes6"));
((TextureAttributesRetained)this.retained).getTextureTransform(transform);
}
/**
* Sets perspective correction mode to be used for color
* and/or texture coordinate interpolation.
* A value of <code>NICEST</code> indicates that perspective correction should be
* performed and that the highest quality method should be used.
* A value of <code>FASTEST</code> indicates that the most efficient perspective
* correction method should be used.
* @param mode one of <code>NICEST</code> or <code>FASTEST</code>
* The default value is <code>NICEST</code>.
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
* @exception IllegalArgumentException if mode value is other
* than <code>FASTEST</code> or <code>NICEST</code>.
*/
public void setPerspectiveCorrectionMode(int mode) {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_MODE_WRITE))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes7"));
if ((mode != FASTEST) && (mode!= NICEST))
throw new IllegalArgumentException(J3dI18N.getString("TextureAttributes9"));
if (isLive())
((TextureAttributesRetained)this.retained).setPerspectiveCorrectionMode(mode);
else
((TextureAttributesRetained)this.retained).initPerspectiveCorrectionMode(mode);
}
/**
* Gets perspective correction mode value.
* @return mode the value of perspective correction mode
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*/
public int getPerspectiveCorrectionMode() {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_MODE_READ))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes8"));
return ((TextureAttributesRetained)this.retained).getPerspectiveCorrectionMode();
}
/**
* Sets the texture color table from the specified table. The
* individual integer array elements are copied. The array is
* indexed first by color component (<i>r</i>, <i>g</i>, <i>b</i>,
* and <i>a</i>, respectively) and then by color value;
* <code>table.length</code> defines the number of color
* components and <code>table[0].length</code> defines the texture
* color table size. If the table is non-null, the number of
* color components must either be 3, for <i>rgb</i> data, or 4,
* for <i>rgba</i> data. The size of each array for each color
* component must be the same and must be a power of 2. If table
* is null or if the texture color table size is 0, the texture
* color table is disabled. If the texture color table size is
* greater than the device-dependent maximum texture color table
* size for a particular Canvas3D, the texture color table is
* ignored for that canvas.
*
* <p>
* When enabled, the texture color table is applied after the
* texture filtering operation and before texture application.
* Each of the <i>r</i>, <i>g</i>, <i>b</i>, and <i>a</i>
* components are clamped to the range [0,1], multiplied by
* <code>textureColorTableSize-1</code>, and rounded to the
* nearest integer. The resulting value for each component is
* then used as an index into the respective table for that
* component. If the texture color table contains 3 components,
* alpha is passed through unmodified.
*
* @param table the new texture color table
*
* @exception IllegalArgumentException if <code>table.length</code>
* is not 3 or 4, or if the arrays for each component are not all
* the same length, or if the texture color table size
* is not a power of 2
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @see Canvas3D#queryProperties
*
* @since Java 3D 1.2
*/
public void setTextureColorTable(int[][] table) {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_COLOR_TABLE_WRITE))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes11"));
if (isLive())
((TextureAttributesRetained)this.retained).setTextureColorTable(table);
else
((TextureAttributesRetained)this.retained).initTextureColorTable(table);
}
/**
* Retrieves the texture color table and copies it into the
* specified array. If the current texture color table is null,
* no values are copied.
*
* @param table the array that will receive a copy of the
* texture color table from this TextureAttributes object.
* The array must be allocated by the caller and must be large
* enough to hold the entire table (that is,
* <code>int[numTextureColorTableComponents][textureColorTableSize]</code>).
*
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @since Java 3D 1.2
*/
public void getTextureColorTable(int[][] table) {
if (isLiveOrCompiled())
if (!this.getCapability(ALLOW_COLOR_TABLE_READ))
throw new CapabilityNotSetException(J3dI18N.getString("TextureAttributes12"));
((TextureAttributesRetained)this.retained).getTextureColorTable(table);
return;
}
/**
* Retrieves the number of color components in the current texture
* color table. A value of 0 is returned if the texture color
* table is null.
*
* @return the number of color components in the texture color
* table, or 0 if the table is null
*
* @since Java 3D 1.2
*/
public int getNumTextureColorTableComponents() {
return (((TextureAttributesRetained)this.retained).getNumTextureColorTableComponents());
}
/**
* Retrieves the size of the current texture color table. A value
* of 0 is returned if the texture color table is null.
*
* @return the size of the texture color table, or 0 if the table
* is null
*
* @since Java 3D 1.2
*/
public int getTextureColorTableSize() {
return (((TextureAttributesRetained)this.retained).getTextureColorTableSize());
}
/**
* Sets the combine mode for the rgb components of the output color
* for this object.
*
* @param combineMode the combine mode, one of:
* <code>COMBINE_REPLACE</code>,
* <code>COMBINE_MODULATE</code>, <code>COMBINE_ADD</code>,
* <code>COMBINE_ADD_SIGNED</code>, <code>COMBINE_SUBTRACT</code>,
* <code>COMBINE_INTERPOLATE</code>, or <code>COMBINE_DOT3</code>
*
* @exception IllegalArgumentException if <code>combineMode</code>
* is a value other than <code>COMBINE_REPLACE</code>,
* <code>COMBINE_MODULATE</code>, <code>COMBINE_ADD</code>,
* <code>COMBINE_ADD_SIGNED</code>, <code>COMBINE_SUBTRACT</code>,
* <code>COMBINE_INTERPOLATE</code>, or <code>COMBINE_DOT3</code>
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @see Canvas3D#queryProperties
*
* @since Java 3D 1.3
*/
public void setCombineRgbMode(int combineMode) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_WRITE)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes16"));
}
}
if ((combineMode < COMBINE_REPLACE) || (combineMode > COMBINE_DOT3)) {
throw new IllegalArgumentException(
J3dI18N.getString("TextureAttributes20"));
}
if (isLive()) {
((TextureAttributesRetained)this.retained).setCombineRgbMode(combineMode);
} else {
((TextureAttributesRetained)this.retained).initCombineRgbMode(combineMode);
}
}
/**
* Sets the combine mode for the alpha component of the output color
* for this object.
*
* @param combineMode the combine mode, one of:
* <code>COMBINE_REPLACE</code>,
* <code>COMBINE_MODULATE</code>, <code>COMBINE_ADD</code>,
* <code>COMBINE_ADD_SIGNED</code>, <code>COMBINE_SUBTRACT</code>,
* <code>COMBINE_INTERPOLATE</code>, or <code>COMBINE_DOT3</code>
*
* @exception IllegalArgumentException if <code>combineMode</code>
* is a value other than <code>COMBINE_REPLACE</code>,
* <code>COMBINE_MODULATE</code>, <code>COMBINE_ADD</code>,
* <code>COMBINE_ADD_SIGNED</code>, <code>COMBINE_SUBTRACT</code>,
* <code>COMBINE_INTERPOLATE</code>, or <code>COMBINE_DOT3</code>
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @see Canvas3D#queryProperties
*
* @since Java 3D 1.3
*/
public void setCombineAlphaMode(int combineMode) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_WRITE)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes18"));
}
}
if ((combineMode < COMBINE_REPLACE) || (combineMode > COMBINE_DOT3)) {
throw new IllegalArgumentException(
J3dI18N.getString("TextureAttributes20"));
}
if (isLive()) {
((TextureAttributesRetained)this.retained).setCombineAlphaMode(combineMode);
} else {
((TextureAttributesRetained)this.retained).initCombineAlphaMode(combineMode);
}
}
/**
* Retrieves the combine mode for the rgb components of the output color
* for this object.
* @return the combine mode for the rgb components.
*
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @since Java 3D 1.3
*/
public int getCombineRgbMode() {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_READ)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes17"));
}
}
return ((TextureAttributesRetained)this.retained).getCombineRgbMode();
}
/**
* Retrieves the combine mode for the alpha component of the output color
* for this object.
* @return the combine mode for the alpha component.
*
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @since Java 3D 1.3
*/
public int getCombineAlphaMode() {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_READ)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes19"));
}
}
return ((TextureAttributesRetained)this.retained).getCombineAlphaMode();
}
/**
* Sets the source for the rgb components of the specified color operand
* for this object.
*
* @param index color operand in the combine operation
* @param src the color source, one of: <code>COMBINE_OBJECT_COLOR</code>,
* <code>COMBINE_TEXTURE_COLOR</code>,
* <code>COMBINE_CONSTANT_COLOR</code>, or
* <code>COMBINE_PREVIOUS_TEXTURE_UNIT_STATE</code>
*
* @exception IndexOutOfBoundsException if <code>index</code> < 0 or
* <code>index</code> > 2
* @exception IllegalArgumentException if <code>src</code>
* is a value other than <code>COMBINE_OBJECT_COLOR</code>,
* <code>COMBINE_TEXTURE_COLOR</code>,
* <code>COMBINE_CONSTANT_COLOR</code>, or
* <code>COMBINE_PREVIOUS_TEXTURE_UNIT_STATE</code>
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @see Canvas3D#queryProperties
*
* @since Java 3D 1.3
*/
public void setCombineRgbSource(int index, int src) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_WRITE)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes21"));
}
}
if ((index < 0) || (index > 2)) {
throw new IndexOutOfBoundsException(
J3dI18N.getString("TextureAttributes25"));
}
if ((src < COMBINE_OBJECT_COLOR) ||
(src > COMBINE_PREVIOUS_TEXTURE_UNIT_STATE)) {
throw new IllegalArgumentException(
J3dI18N.getString("TextureAttributes26"));
}
if (isLive()) {
((TextureAttributesRetained)this.retained).setCombineRgbSource(
index, src);
} else {
((TextureAttributesRetained)this.retained).initCombineRgbSource(
index, src);
}
}
/**
* Sets the source for the alpha component of the specified color operand
* for this object.
*
* @param index color operand in the combine operation
* @param src the color source, one of: <code>COMBINE_OBJECT_COLOR</code>,
* <code>COMBINE_TEXTURE_COLOR</code>,
* <code>COMBINE_CONSTANT_COLOR</code>, or
* <code>COMBINE_PREVIOUS_TEXTURE_UNIT_STATE</code>
*
* @exception IndexOutOfBoundsException if <code>index</code> < 0 or
* <code>index</code> > 2
* @exception IllegalArgumentException if <code>src</code>
* is a value other than <code>COMBINE_OBJECT_COLOR</code>,
* <code>COMBINE_TEXTURE_COLOR</code>,
* <code>COMBINE_CONSTANT_COLOR</code>, or
* <code>COMBINE_PREVIOUS_TEXTURE_UNIT_STATE</code>
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @see Canvas3D#queryProperties
*
* @since Java 3D 1.3
*/
public void setCombineAlphaSource(int index, int src) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_WRITE)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes23"));
}
}
if ((index < 0) || (index > 2)) {
throw new IndexOutOfBoundsException(
J3dI18N.getString("TextureAttributes25"));
}
if ((src < COMBINE_OBJECT_COLOR) ||
(src > COMBINE_PREVIOUS_TEXTURE_UNIT_STATE)) {
throw new IllegalArgumentException(
J3dI18N.getString("TextureAttributes26"));
}
if (isLive()) {
((TextureAttributesRetained)this.retained).setCombineAlphaSource(
index, src);
} else {
((TextureAttributesRetained)this.retained).initCombineAlphaSource(
index, src);
}
}
/**
* Retrieves the source for the rgb components of the specified
* color operand for this object.
*
* @param index color operand in the combine operation
*
* @return the source for the rgb components of the specified color
* operand for this object
*
* @exception IndexOutOfBoundsException if <code>index</code> < 0 or
* <code>index</code> > 2
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @since Java 3D 1.3
*/
public int getCombineRgbSource(int index) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_READ)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes22"));
}
}
if ((index < 0) || (index > 2)) {
throw new IndexOutOfBoundsException(
J3dI18N.getString("TextureAttributes25"));
}
return ((TextureAttributesRetained)this.retained).getCombineRgbSource(index);
}
/**
* Retrieves the source for the alpha component of the specified
* color operand for this object.
*
* @param index color operand in the combine operation
*
* @return the source for the alpha component of the specified color
* operand for this object
*
* @exception IndexOutOfBoundsException if <code>index</code> < 0 or
* <code>index</code> > 2
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @since Java 3D 1.3
*/
public int getCombineAlphaSource(int index) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_READ)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes24"));
}
}
if ((index < 0) || (index > 2)) {
throw new IndexOutOfBoundsException(
J3dI18N.getString("TextureAttributes25"));
}
return ((TextureAttributesRetained)this.retained).getCombineAlphaSource(index);
}
/**
* Sets the function for the rgb components of the specified color operand
* for this object.
*
* @param index color operand in the combine operation
* @param function the color function, one of:
* <code>COMBINE_SRC_COLOR</code>,
* <code>COMBINE_ONE_MINUS_SRC_COLOR</code>,
* <code>COMBINE_SRC_ALPHA</code>, or
* <code>COMBINE_ONE_MINUS_SRC_ALPHA</code>
*
* @exception IndexOutOfBoundsException if <code>index</code> < 0 or
* <code>index</code> > 2
* @exception IllegalArgumentException if <code>function</code>
* is a value other than <code>COMBINE_SRC_COLOR</code>,
* <code>COMBINE_ONE_MINUS_SRC_COLOR</code>,
* <code>COMBINE_SRC_ALPHA</code>, or
* <code>COMBINE_ONE_MINUS_SRC_ALPHA</code>
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @see Canvas3D#queryProperties
*
* @since Java 3D 1.3
*/
public void setCombineRgbFunction(int index, int function) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_WRITE)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes27"));
}
}
if ((index < 0) || (index > 2)) {
throw new IndexOutOfBoundsException(
J3dI18N.getString("TextureAttributes25"));
}
if ((function < COMBINE_SRC_COLOR) ||
(function > COMBINE_ONE_MINUS_SRC_ALPHA)) {
throw new IllegalArgumentException(
J3dI18N.getString("TextureAttributes31"));
}
if (isLive()) {
((TextureAttributesRetained)this.retained).setCombineRgbFunction(
index, function);
} else {
((TextureAttributesRetained)this.retained).initCombineRgbFunction(
index, function);
}
}
/**
* Sets the function for the alpha component of the specified color operand
* for this object.
*
* @param index color operand in the combine operation
* @param function the color function, one of:
* <code>COMBINE_SRC_ALPHA</code>, or
* <code>COMBINE_ONE_MINUS_SRC_ALPHA</code>
*
* @exception IndexOutOfBoundsException if <code>index</code> < 0 or
* <code>index</code> > 2
* @exception IllegalArgumentException if <code>function</code>
* is a value other than
* <code>COMBINE_SRC_ALPHA</code> or
* <code>COMBINE_ONE_MINUS_SRC_ALPHA</code>
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @see Canvas3D#queryProperties
*
* @since Java 3D 1.3
*/
public void setCombineAlphaFunction(int index, int function) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_WRITE)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes29"));
}
}
if ((index < 0) || (index > 2)) {
throw new IndexOutOfBoundsException(
J3dI18N.getString("TextureAttributes25"));
}
if ((function < COMBINE_SRC_ALPHA) ||
(function > COMBINE_ONE_MINUS_SRC_ALPHA)) {
throw new IllegalArgumentException(
J3dI18N.getString("TextureAttributes31"));
}
if (isLive()) {
((TextureAttributesRetained)this.retained).setCombineAlphaFunction(
index, function);
} else {
((TextureAttributesRetained)this.retained).initCombineAlphaFunction(
index, function);
}
}
/**
* Retrieves the function for the rgb components of the specified color
* operand for this object.
*
* @param index color operand in the combine operation
*
* @return the function for the rgb components of the specified color
* operand for this object.
*
* @exception IndexOutOfBoundsException if <code>index</code> < 0 or
* <code>index</code> > 2
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @since Java 3D 1.3
*/
public int getCombineRgbFunction(int index) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_READ)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes28"));
}
}
if ((index < 0) || (index > 2)) {
throw new IndexOutOfBoundsException(
J3dI18N.getString("TextureAttributes25"));
}
return ((TextureAttributesRetained)this.retained).getCombineRgbFunction(index);
}
/**
* Retrieves the function for the alpha component of the specified color
* operand for this object.
*
* @param index color operand in the combine operation
*
* @return the function for the alpha component of the specified color
* operand for this object.
*
* @exception IndexOutOfBoundsException if <code>index</code> < 0 or
* <code>index</code> > 2
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @since Java 3D 1.3
*/
public int getCombineAlphaFunction(int index) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_READ)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes30"));
}
}
if ((index < 0) || (index > 2)) {
throw new IndexOutOfBoundsException(
J3dI18N.getString("TextureAttributes25"));
}
return ((TextureAttributesRetained)this.retained).getCombineAlphaFunction(index);
}
/**
* Sets the scale factor for the rgb components of the output color
* for this object.
*
* @param scale the scale factor for the rgb components of the output
* color. It must be one of the following: 1, 2, or 4.
*
* @exception IllegalArgumentException if <code>scale</code> is a
* value other than 1, 2, or 4.
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @see Canvas3D#queryProperties
*
* @since Java 3D 1.3
*/
public void setCombineRgbScale(int scale) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_WRITE)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes32"));
}
}
if ((scale != 1) && (scale != 2) && (scale != 4)) {
throw new IllegalArgumentException(
J3dI18N.getString("TextureAttributes36"));
}
if (isLive()) {
((TextureAttributesRetained)this.retained).setCombineRgbScale(scale);
} else {
((TextureAttributesRetained)this.retained).initCombineRgbScale(scale);
}
}
/**
* Sets the scale factor for the alpha component of the output color
* for this object.
*
* @param scale the scale factor for the alpha component of the output
* color. It must be one of the following: 1, 2, or 4.
*
* @exception IllegalArgumentException if <code>scale</code> is a
* value other than 1, 2, or 4.
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @see Canvas3D#queryProperties
*
* @since Java 3D 1.3
*/
public void setCombineAlphaScale(int scale) {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_WRITE)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes34"));
}
}
if ((scale != 1) && (scale != 2) && (scale != 4)) {
throw new IllegalArgumentException(
J3dI18N.getString("TextureAttributes36"));
}
if (isLive()) {
((TextureAttributesRetained)this.retained).setCombineAlphaScale(scale);
} else {
((TextureAttributesRetained)this.retained).initCombineAlphaScale(scale);
}
}
/**
* Retrieves the scale factor for the rgb components of the output color
* for this object.
*
* @return the scale factor for the rgb components of the output color
*
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @since Java 3D 1.3
*/
public int getCombineRgbScale() {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_READ)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes33"));
}
}
return ((TextureAttributesRetained)this.retained).getCombineRgbScale();
}
/**
* Retrieves the scale factor for the alpha component of the output color
* for this object.
*
* @return the scale factor for the alpha component of the output color
*
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @since Java 3D 1.3
*/
public int getCombineAlphaScale() {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_COMBINE_READ)) {
throw new CapabilityNotSetException(
J3dI18N.getString("TextureAttributes35"));
}
}
return ((TextureAttributesRetained)this.retained).getCombineAlphaScale();
}
/**
* Creates a retained mode TextureAttributesRetained object that this
* TextureAttributes component object will point to.
*/
@Override
void createRetained() {
this.retained = new TextureAttributesRetained();
this.retained.setSource(this);
}
/**
* @deprecated replaced with cloneNodeComponent(boolean forceDuplicate)
*/
@Override
public NodeComponent cloneNodeComponent() {
TextureAttributes ta = new TextureAttributes();
ta.duplicateNodeComponent(this);
return ta;
}
/**
* 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);
TextureAttributesRetained attr =
(TextureAttributesRetained) originalNodeComponent.retained;
TextureAttributesRetained rt = (TextureAttributesRetained) retained;
Color4f c = new Color4f();
attr.getTextureBlendColor(c);
Transform3D t = new Transform3D();
attr.getTextureTransform(t);
rt.initTextureMode(attr.getTextureMode());
rt.initPerspectiveCorrectionMode(attr.getPerspectiveCorrectionMode());
rt.initTextureBlendColor(c);
rt.initTextureTransform(t);
if ((attr.getNumTextureColorTableComponents() != 0) &&
(attr.getTextureColorTableSize() != 0)) {
int table[][] = new
int[attr.getNumTextureColorTableComponents()][attr.getTextureColorTableSize()];
attr.getTextureColorTable(table);
rt.initTextureColorTable(table);
}
// start fix issue 636
rt.initCombineRgbMode(attr.getCombineRgbMode());
rt.initCombineAlphaMode(attr.getCombineAlphaMode());
rt.initCombineRgbScale(attr.getCombineRgbScale());
rt.initCombineAlphaScale(attr.getCombineAlphaScale());
// Check one of the combine source or function arrays
if (attr.combineRgbSrc != null) {
for (int i=0; i < 3; i++) {
rt.initCombineRgbSource(i, attr.getCombineRgbSource(i));
rt.initCombineAlphaSource(i, attr.getCombineAlphaSource(i));
rt.initCombineRgbFunction(i, attr.getCombineRgbFunction(i));
rt.initCombineAlphaFunction(i, attr.getCombineAlphaFunction(i));
}
}
// end fix
}
}
|