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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_06) on Thu Aug 17 01:51:18 CDT 2006 -->
<TITLE>
Material
</TITLE>
<META NAME="keywords" CONTENT="net.java.joglutils.lighting.Material class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Material";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Material.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/java/joglutils/lighting/LightPanel.html" title="class in net.java.joglutils.lighting"><B>PREV CLASS</B></A>
<A HREF="../../../../net/java/joglutils/lighting/MaterialPanel.html" title="class in net.java.joglutils.lighting"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/java/joglutils/lighting/Material.html" target="_top"><B>FRAMES</B></A>
<A HREF="Material.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.java.joglutils.lighting</FONT>
<BR>
Class Material</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.java.joglutils.lighting.Material</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>Material</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
This class encapsulates OpenGL material settings in an object-oriented interface.
The class operates in two modes:
<br> 1. If a <CODE>GL</CODE> Context is attached, setter methods apply the settings to the
OpenGL state as well as the object. the apply() and retrieve() method can be
used for all of the settings
<br> 2. If no <CODE>GL</CODE> Context is attached, apply(GL) and retrieve(GL) set / get
the OpenGL state from this object.
<br> Note: GL_LIGHTING must be enabled in the OpenGL context by the user - this object will not do so.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#Material()">Material</A></B>()</CODE>
<BR>
Creates a new instance of Material from the OpenGL default material settings</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#Material(javax.media.opengl.GL)">Material</A></B>(javax.media.opengl.GL gl)</CODE>
<BR>
Creates a new instance of material, with the specified GL context attached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#Material(javax.media.opengl.GL, int)">Material</A></B>(javax.media.opengl.GL gl,
int face)</CODE>
<BR>
Creates a new instance of material, with the specified GL context attached.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#apply()">apply</A></B>()</CODE>
<BR>
Sets the state on the attached OpenGL Context to match this Material.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#apply(javax.media.opengl.GL)">apply</A></B>(javax.media.opengl.GL gl)</CODE>
<BR>
Sets the OpenGL State in the supplied context based on the settings in this Material.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#applyGlobalAmbient(java.awt.Color)">applyGlobalAmbient</A></B>(java.awt.Color ambient)</CODE>
<BR>
Sets the light model parameter GL_LIGHT_MODEL_AMBIENT for the attached GL context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#applyGlobalAmbient(javax.media.opengl.GL, java.awt.Color)">applyGlobalAmbient</A></B>(javax.media.opengl.GL gl,
java.awt.Color ambient)</CODE>
<BR>
Sets the light model parameter GL_LIGHT_MODEL_AMBIENT for the specified GL context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#detachGL()">detachGL</A></B>()</CODE>
<BR>
Detaches the currently attached OpenGL context from this object</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.awt.Color</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#getAmbient()">getAmbient</A></B>()</CODE>
<BR>
This retrieves the ambient color from this Material.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> javax.media.opengl.GL</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#getAttachedGL()">getAttachedGL</A></B>()</CODE>
<BR>
Returns the OpenGL context attached to this Lighting object</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.awt.Color</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#getDiffuse()">getDiffuse</A></B>()</CODE>
<BR>
This retrieves the diffuse color from this Material.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.awt.Color</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#getEmissive()">getEmissive</A></B>()</CODE>
<BR>
This retrieves the emissive color from this Material.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#getFace()">getFace</A></B>()</CODE>
<BR>
Determines what face the material settings are applied to or retrieved from.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.awt.Color</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#getGlobalAmbient()">getGlobalAmbient</A></B>()</CODE>
<BR>
Retrieves the GL_LIGHT_MODEL_AMBIENT color from the attached OpenGL context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.awt.Color</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#getGlobalAmbient(javax.media.opengl.GL)">getGlobalAmbient</A></B>(javax.media.opengl.GL gl)</CODE>
<BR>
Retrieves the GL_LIGHT_MODEL_AMBIENT color from a specified OpenGL context.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> float</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#getShininess()">getShininess</A></B>()</CODE>
<BR>
Retrieves the shininess from this Material.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.awt.Color</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#getSpecular()">getSpecular</A></B>()</CODE>
<BR>
Retrieves the specular color from this Material.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#isAttached()">isAttached</A></B>()</CODE>
<BR>
Determines if an OpenGL context is attached.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#retrieve()">retrieve</A></B>()</CODE>
<BR>
Sets this Material object from the attached OpenGL state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#retrieve(javax.media.opengl.GL)">retrieve</A></B>(javax.media.opengl.GL gl)</CODE>
<BR>
Sets the settings in this Material from the specified OpenGL context's state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#setAmbient(java.awt.Color)">setAmbient</A></B>(java.awt.Color ambient)</CODE>
<BR>
Sets this object's ambient color from an input Color.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#setAttachedGL(javax.media.opengl.GL)">setAttachedGL</A></B>(javax.media.opengl.GL gl)</CODE>
<BR>
Attached the specified OpenGL context to this object</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#setDiffuse(java.awt.Color)">setDiffuse</A></B>(java.awt.Color diffuse)</CODE>
<BR>
Sets this object's diffuse color from an input Color.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#setEmissive(java.awt.Color)">setEmissive</A></B>(java.awt.Color emissive)</CODE>
<BR>
Sets this object's emissive color from an input Color.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#setFace(int)">setFace</A></B>(int face)</CODE>
<BR>
Specifies the face for subsequent apply method calls to apply and retrieve the material settings.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#setShininess(float)">setShininess</A></B>(float shininess)</CODE>
<BR>
Sets the shininess for this Material.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/java/joglutils/lighting/Material.html#setSpecular(java.awt.Color)">setSpecular</A></B>(java.awt.Color specular)</CODE>
<BR>
Sets this object's specular color from an input Color.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Material()"><!-- --></A><H3>
Material</H3>
<PRE>
public <B>Material</B>()</PRE>
<DL>
<DD>Creates a new instance of Material from the OpenGL default material settings
<P>
</DL>
<HR>
<A NAME="Material(javax.media.opengl.GL, int)"><!-- --></A><H3>
Material</H3>
<PRE>
public <B>Material</B>(javax.media.opengl.GL gl,
int face)</PRE>
<DL>
<DD>Creates a new instance of material, with the specified GL context attached.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>gl</CODE> - the OpenGL context to attach<DD><CODE>face</CODE> - the face to use for configuring the material</DL>
</DL>
<HR>
<A NAME="Material(javax.media.opengl.GL)"><!-- --></A><H3>
Material</H3>
<PRE>
public <B>Material</B>(javax.media.opengl.GL gl)</PRE>
<DL>
<DD>Creates a new instance of material, with the specified GL context attached. Settings are applied to front and back.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>gl</CODE> - the OpenGL context to attach</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="setAttachedGL(javax.media.opengl.GL)"><!-- --></A><H3>
setAttachedGL</H3>
<PRE>
public void <B>setAttachedGL</B>(javax.media.opengl.GL gl)</PRE>
<DL>
<DD>Attached the specified OpenGL context to this object
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>gl</CODE> - the OpenGL context to attach this to</DL>
</DD>
</DL>
<HR>
<A NAME="getAttachedGL()"><!-- --></A><H3>
getAttachedGL</H3>
<PRE>
public javax.media.opengl.GL <B>getAttachedGL</B>()</PRE>
<DL>
<DD>Returns the OpenGL context attached to this Lighting object
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the attached OpenGL context, or null if there is no attached context</DL>
</DD>
</DL>
<HR>
<A NAME="detachGL()"><!-- --></A><H3>
detachGL</H3>
<PRE>
public void <B>detachGL</B>()</PRE>
<DL>
<DD>Detaches the currently attached OpenGL context from this object
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isAttached()"><!-- --></A><H3>
isAttached</H3>
<PRE>
public boolean <B>isAttached</B>()</PRE>
<DL>
<DD>Determines if an OpenGL context is attached.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if an OpenGL context is attached to this object.</DL>
</DD>
</DL>
<HR>
<A NAME="apply(javax.media.opengl.GL)"><!-- --></A><H3>
apply</H3>
<PRE>
public void <B>apply</B>(javax.media.opengl.GL gl)</PRE>
<DL>
<DD>Sets the OpenGL State in the supplied context based on the settings in this Material.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>gl</CODE> - the OpenGL Context upon which to apply the settings from this Material.</DL>
</DD>
</DL>
<HR>
<A NAME="retrieve(javax.media.opengl.GL)"><!-- --></A><H3>
retrieve</H3>
<PRE>
public void <B>retrieve</B>(javax.media.opengl.GL gl)</PRE>
<DL>
<DD>Sets the settings in this Material from the specified OpenGL context's state.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>gl</CODE> - the OpenGL Context to use in setting this Material's settings.</DL>
</DD>
</DL>
<HR>
<A NAME="apply()"><!-- --></A><H3>
apply</H3>
<PRE>
public void <B>apply</B>()
throws <A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></PRE>
<DL>
<DD>Sets the state on the attached OpenGL Context to match this Material.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>sddm.lighting.LightingException</CODE> - if no OpenGL Context is attached.
<DD><CODE><A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="retrieve()"><!-- --></A><H3>
retrieve</H3>
<PRE>
public void <B>retrieve</B>()
throws <A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></PRE>
<DL>
<DD>Sets this Material object from the attached OpenGL state.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>sddm.lighting.LightingException</CODE> - if no OpenGL Context is attached.
<DD><CODE><A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setFace(int)"><!-- --></A><H3>
setFace</H3>
<PRE>
public void <B>setFace</B>(int face)
throws <A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></PRE>
<DL>
<DD>Specifies the face for subsequent apply method calls to apply and retrieve the material settings. If
GL_FRONT_AND_BACK, will retrieve from GL_FRONT.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>face</CODE> - the face to apply material settings upon. Must be GL.GL_FRONT_AND_BACK, GL.GL_FRONT, or GL.GL_BACK
<DT><B>Throws:</B>
<DD><CODE>sddm.lighting.LightingException</CODE> - if an invalid input is provided
<DD><CODE><A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getFace()"><!-- --></A><H3>
getFace</H3>
<PRE>
public int <B>getFace</B>()</PRE>
<DL>
<DD>Determines what face the material settings are applied to or retrieved from.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the face used - can be GL.GL_FRONT_AND_BACK, GL.GL_FRONT, or GL.GL_BACK</DL>
</DD>
</DL>
<HR>
<A NAME="setSpecular(java.awt.Color)"><!-- --></A><H3>
setSpecular</H3>
<PRE>
public void <B>setSpecular</B>(java.awt.Color specular)</PRE>
<DL>
<DD>Sets this object's specular color from an input Color. Default is {0,0,0,1}.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>specular</CODE> - the color that the specular color is copied from - later changes to the Color object will not be reflected in this Material.</DL>
</DD>
</DL>
<HR>
<A NAME="getSpecular()"><!-- --></A><H3>
getSpecular</H3>
<PRE>
public java.awt.Color <B>getSpecular</B>()</PRE>
<DL>
<DD>Retrieves the specular color from this Material.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a new Color with components copied from this Material.</DL>
</DD>
</DL>
<HR>
<A NAME="setShininess(float)"><!-- --></A><H3>
setShininess</H3>
<PRE>
public void <B>setShininess</B>(float shininess)</PRE>
<DL>
<DD>Sets the shininess for this Material. Defaults to 0.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shininess</CODE> - the value to use for shininess</DL>
</DD>
</DL>
<HR>
<A NAME="getShininess()"><!-- --></A><H3>
getShininess</H3>
<PRE>
public float <B>getShininess</B>()</PRE>
<DL>
<DD>Retrieves the shininess from this Material.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the shininess value</DL>
</DD>
</DL>
<HR>
<A NAME="setEmissive(java.awt.Color)"><!-- --></A><H3>
setEmissive</H3>
<PRE>
public void <B>setEmissive</B>(java.awt.Color emissive)</PRE>
<DL>
<DD>Sets this object's emissive color from an input Color. Default is {0,0,0,1}.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>emissive</CODE> - the color that the specular color is copied from - later changes to the Color object will not be reflected in this Material.</DL>
</DD>
</DL>
<HR>
<A NAME="getEmissive()"><!-- --></A><H3>
getEmissive</H3>
<PRE>
public java.awt.Color <B>getEmissive</B>()</PRE>
<DL>
<DD>This retrieves the emissive color from this Material.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a new Color with components copied from this Material.</DL>
</DD>
</DL>
<HR>
<A NAME="setAmbient(java.awt.Color)"><!-- --></A><H3>
setAmbient</H3>
<PRE>
public void <B>setAmbient</B>(java.awt.Color ambient)</PRE>
<DL>
<DD>Sets this object's ambient color from an input Color. Defaults to {0.2,0.2,0.2,1.0}.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ambient</CODE> - the color that the specular color is copied from - later changes to the Color object will not be reflected in this Material.</DL>
</DD>
</DL>
<HR>
<A NAME="getAmbient()"><!-- --></A><H3>
getAmbient</H3>
<PRE>
public java.awt.Color <B>getAmbient</B>()</PRE>
<DL>
<DD>This retrieves the ambient color from this Material.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a new Color with components copied from this Material.</DL>
</DD>
</DL>
<HR>
<A NAME="setDiffuse(java.awt.Color)"><!-- --></A><H3>
setDiffuse</H3>
<PRE>
public void <B>setDiffuse</B>(java.awt.Color diffuse)</PRE>
<DL>
<DD>Sets this object's diffuse color from an input Color. Defaults to {0.8,0.8,0.8,1.0}.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>diffuse</CODE> - the color that the specular color is copied from - later changes to the Color object will not be reflected in this Material.</DL>
</DD>
</DL>
<HR>
<A NAME="getDiffuse()"><!-- --></A><H3>
getDiffuse</H3>
<PRE>
public java.awt.Color <B>getDiffuse</B>()</PRE>
<DL>
<DD>This retrieves the diffuse color from this Material.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a new Color with components copied from this Material.</DL>
</DD>
</DL>
<HR>
<A NAME="applyGlobalAmbient(java.awt.Color)"><!-- --></A><H3>
applyGlobalAmbient</H3>
<PRE>
public void <B>applyGlobalAmbient</B>(java.awt.Color ambient)
throws <A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></PRE>
<DL>
<DD>Sets the light model parameter GL_LIGHT_MODEL_AMBIENT for the attached GL context. This applies for all lighted fragments on this GL context.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ambient</CODE> - the ambient color to be applied.
<DT><B>Throws:</B>
<DD><CODE>sddm.lighting.LightingException</CODE> - if no OpenGL Context is attached.
<DD><CODE><A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getGlobalAmbient()"><!-- --></A><H3>
getGlobalAmbient</H3>
<PRE>
public java.awt.Color <B>getGlobalAmbient</B>()
throws <A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></PRE>
<DL>
<DD>Retrieves the GL_LIGHT_MODEL_AMBIENT color from the attached OpenGL context.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the ambient color in the specified OpenGL Context.
<DT><B>Throws:</B>
<DD><CODE>sddm.lighting.LightingException</CODE> - if no OpenGL Context is attached.
<DD><CODE><A HREF="../../../../net/java/joglutils/lighting/LightingException.html" title="class in net.java.joglutils.lighting">LightingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="applyGlobalAmbient(javax.media.opengl.GL, java.awt.Color)"><!-- --></A><H3>
applyGlobalAmbient</H3>
<PRE>
public static void <B>applyGlobalAmbient</B>(javax.media.opengl.GL gl,
java.awt.Color ambient)</PRE>
<DL>
<DD>Sets the light model parameter GL_LIGHT_MODEL_AMBIENT for the specified GL context. This applies for all lighted fragments on this GL context.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>gl</CODE> - the OpenGL context to apply this color to.<DD><CODE>ambient</CODE> - the ambient color to be applied.</DL>
</DD>
</DL>
<HR>
<A NAME="getGlobalAmbient(javax.media.opengl.GL)"><!-- --></A><H3>
getGlobalAmbient</H3>
<PRE>
public static java.awt.Color <B>getGlobalAmbient</B>(javax.media.opengl.GL gl)</PRE>
<DL>
<DD>Retrieves the GL_LIGHT_MODEL_AMBIENT color from a specified OpenGL context.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>gl</CODE> - the OpenGL Context from which to get the color.
<DT><B>Returns:</B><DD>the ambient color in the specified OpenGL Context.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Material.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/java/joglutils/lighting/LightPanel.html" title="class in net.java.joglutils.lighting"><B>PREV CLASS</B></A>
<A HREF="../../../../net/java/joglutils/lighting/MaterialPanel.html" title="class in net.java.joglutils.lighting"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/java/joglutils/lighting/Material.html" target="_top"><B>FRAMES</B></A>
<A HREF="Material.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|
