summaryrefslogtreecommitdiff
path: root/src/Visual3d/Visual3d_Light.cxx
blob: 7e0915b549cfed24d895027c78c0c7c803727743 (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
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
/***********************************************************************

     FUNCTION :
     ----------
        File Visual3d_Light :

	Declaration of variables specific to light sources

     NOTES:
     ----------

	A light source is defined by :
	- type
	- color
	- reduction factors  ( for positional and spot only )
	- its angle ( for spot only )
	- its concentration ( for spot only )
	- its direction ( directional and spot only )
	- its position ( positional and spot only )

	It is active in a view, in the associated context.

     ATTENTION:
     ----------

	- AngleCone is given in radian [Pex] while OpenGl works in 
	degreees. The limits for Pex are [0,PI] while for OpenGl this is [0,90].
	- Two reduction factors are used with Pex while OpenGl uses three.
	- The ereduction factors have range [0.0,1.0] for Pex and 
	for OpenGl the range is [0.0,n] 
	- The concentration varies from [0.,1.0] for Pex to [0,128] for OpenGl.	

************************************************************************/

/*----------------------------------------------------------------------*/
/*
 * Includes
 */ 

#include <Visual3d_Light.ixx>

#include <Graphic3d_GraphicDriver.hxx>

/*----------------------------------------------------------------------*/

Visual3d_Light::Visual3d_Light ():
MyType (Visual3d_TOLS_AMBIENT) {

	MyCLight.WsId		= -1;
	MyCLight.ViewId		= 0; /* not used */
	MyCLight.LightType	= int (MyType);
	MyCLight.Headlight      = 0;

Quantity_Color White (Quantity_NOC_WHITE);

	MyCLight.Color.r	= float (White.Red ());
	MyCLight.Color.g	= float (White.Green ());
	MyCLight.Color.b	= float (White.Blue ());

	MyCLight.LightId	=
		Graphic3d_GraphicDriver::Light (MyCLight, Standard_False);

}

/*----------------------------------------------------------------------*/

Visual3d_Light::Visual3d_Light (const Quantity_Color& Color):
MyType (Visual3d_TOLS_AMBIENT) {

	MyCLight.WsId		= -1;
	MyCLight.ViewId		= 0; /* not used */
	MyCLight.LightType	= int (MyType);
	MyCLight.Headlight      = 0;

	MyCLight.Color.r	= float (Color.Red ());
	MyCLight.Color.g	= float (Color.Green ());
	MyCLight.Color.b	= float (Color.Blue ());

	MyCLight.LightId	=
		Graphic3d_GraphicDriver::Light (MyCLight, Standard_False);

}

/*----------------------------------------------------------------------*/

Visual3d_Light::Visual3d_Light(const Quantity_Color& Color,const Graphic3d_Vector& Direction,const Standard_Boolean Headlight): MyType (Visual3d_TOLS_DIRECTIONAL) {

	if (Direction.LengthZero ())
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightDirection");

	MyCLight.WsId		= -1;
	MyCLight.ViewId		= 0; /* not used */
	MyCLight.LightType	= int (MyType);
	MyCLight.Headlight      = Headlight? 1:0;

Standard_Real Norme, X, Y, Z;

	Color.Values (X, Y, Z, Quantity_TOC_RGB);
	MyCLight.Color.r	= float (X);
	MyCLight.Color.g	= float (Y);
	MyCLight.Color.b	= float (Z);

	Direction.Coord (X, Y, Z);
	Norme	= Sqrt (X*X+Y*Y+Z*Z);
	// Direction.LengthZero () == Standard_False
	MyCLight.Direction.x	= float (X/Norme);
	MyCLight.Direction.y	= float (Y/Norme);
	MyCLight.Direction.z	= float (Z/Norme);

	MyCLight.LightId	=
		Graphic3d_GraphicDriver::Light (MyCLight, Standard_False);

}

/*----------------------------------------------------------------------*/

Visual3d_Light::Visual3d_Light (const Quantity_Color& Color, const Graphic3d_Vertex& Position, const Standard_Real Fact1, const Standard_Real Fact2):
MyType (Visual3d_TOLS_POSITIONAL) {

	if ( (Fact1 == 0.0) && (Fact2 == 0.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAttenuation");

	if ( (Fact1 < 0.0) && (Fact1 > 1.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAttenuation");

	if ( (Fact2 < 0.0) && (Fact2 > 1.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAttenuation");

	MyCLight.WsId		= -1;
	MyCLight.ViewId		= 0; /* not used */
	MyCLight.LightType	= int (MyType);
	MyCLight.Headlight      = 0;

	MyCLight.Color.r	= float (Color.Red ());
	MyCLight.Color.g	= float (Color.Green ());
	MyCLight.Color.b	= float (Color.Blue ());

	MyCLight.Position.x	= float (Position.X ());
	MyCLight.Position.y	= float (Position.Y ());
	MyCLight.Position.z	= float (Position.Z ());

	MyCLight.Attenuation[0] = float (Fact1);
	MyCLight.Attenuation[1] = float (Fact2);

	MyCLight.LightId	=
		Graphic3d_GraphicDriver::Light (MyCLight, Standard_False);

}

/*----------------------------------------------------------------------*/

Visual3d_Light::Visual3d_Light (const Quantity_Color& Color, const Graphic3d_Vertex& Position, const Graphic3d_Vector& Direction, const Standard_Real Concentration, const Standard_Real Fact1, const Standard_Real Fact2, const Standard_Real AngleCone):
MyType (Visual3d_TOLS_SPOT) {

	if (Direction.LengthZero ())
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightDirection");

	if ( (Concentration < 0.0) || (Concentration > 1.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightConcentration");

	if ( (Fact1 == 0.0) && (Fact2 == 0.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAttenuation");

	if ( (Fact1 < 0.0) && (Fact1 > 1.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAttenuation");

	if ( (Fact2 < 0.0) && (Fact2 > 1.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAttenuation");

	if (Visual3d_Light::IsValid (AngleCone)) {

		MyCLight.WsId		= -1;
		MyCLight.ViewId		= 0; /* not used */
		MyCLight.LightType	= int (MyType);
		MyCLight.Headlight      = 0;

Standard_Real X, Y, Z;

		Color.Values (X, Y, Z, Quantity_TOC_RGB);
		MyCLight.Color.r	= float (X);
		MyCLight.Color.g	= float (Y);
		MyCLight.Color.b	= float (Z);

		Position.Coord (X, Y, Z);
		MyCLight.Position.x	= float (X);
		MyCLight.Position.y	= float (Y);
		MyCLight.Position.z	= float (Z);

		Direction.Coord (X, Y, Z);
		MyCLight.Direction.x	= float (X);
		MyCLight.Direction.y	= float (Y);
		MyCLight.Direction.z	= float (Z);

		MyCLight.Concentration	= float (Concentration);

		MyCLight.Attenuation[0] = float (Fact1);
		MyCLight.Attenuation[1] = float (Fact2);

		MyCLight.Angle		= float (AngleCone);

		MyCLight.LightId	=
		  Graphic3d_GraphicDriver::Light (MyCLight, Standard_False);

	}
	else
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAngle");

}

/*----------------------------------------------------------------------*/

Quantity_Color Visual3d_Light::Color () const {

Quantity_Color AColor  (Standard_Real (MyCLight.Color.r),
			Standard_Real (MyCLight.Color.g),
			Standard_Real (MyCLight.Color.b),
			Quantity_TOC_RGB);

	return (AColor);

}

/*----------------------------------------------------------------------*/

Visual3d_TypeOfLightSource Visual3d_Light::LightType () const {

	return (MyType);

}

/*----------------------------------------------------------------------*/
Standard_Boolean Visual3d_Light::Headlight () const {
  return MyCLight.Headlight==0? Standard_False:Standard_True;
}

/*----------------------------------------------------------------------*/

void Visual3d_Light::Values (Quantity_Color& Color) const {

Quantity_Color AColor  (Standard_Real (MyCLight.Color.r),
			Standard_Real (MyCLight.Color.g),
			Standard_Real (MyCLight.Color.b),
			Quantity_TOC_RGB);

	if (MyType == Visual3d_TOLS_AMBIENT)
		Color		= AColor;
	else Visual3d_LightDefinitionError::Raise
		("Light Type != Visual3d_TOLS_AMBIENT");

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::Values (Quantity_Color& Color, Graphic3d_Vector& Direction) const {

Quantity_Color AColor  (Standard_Real (MyCLight.Color.r),
			Standard_Real (MyCLight.Color.g),
			Standard_Real (MyCLight.Color.b),
			Quantity_TOC_RGB);

Graphic3d_Vector ADirection    (Standard_Real (MyCLight.Direction.x),
				Standard_Real (MyCLight.Direction.y),
				Standard_Real (MyCLight.Direction.z));

	if (MyType == Visual3d_TOLS_DIRECTIONAL) {
		Color		= AColor;
		Direction	= ADirection;
	}
	else Visual3d_LightDefinitionError::Raise
		("Light Type != Visual3d_TOLS_DIRECTIONAL");

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::Values (Quantity_Color& Color, Graphic3d_Vertex& Position, Standard_Real& Fact1, Standard_Real& Fact2) const {

Quantity_Color AColor  (Standard_Real (MyCLight.Color.r),
			Standard_Real (MyCLight.Color.g),
			Standard_Real (MyCLight.Color.b),
			Quantity_TOC_RGB);

Graphic3d_Vertex APosition     (Standard_Real (MyCLight.Position.x),
				Standard_Real (MyCLight.Position.y),
				Standard_Real (MyCLight.Position.z));

	if (MyType == Visual3d_TOLS_POSITIONAL) {
		Color		= AColor;
		Position	= APosition;
		Fact1		= Standard_Real (MyCLight.Attenuation[0]);
		Fact2		= Standard_Real (MyCLight.Attenuation[1]);
	}
	else Visual3d_LightDefinitionError::Raise
		("Light Type != Visual3d_TOLS_POSITIONAL");

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::Values (Quantity_Color& Color, Graphic3d_Vertex& Position, Graphic3d_Vector& Direction, Standard_Real& Concentration, Standard_Real& Fact1, Standard_Real& Fact2, Standard_Real& AngleCone) const {

Quantity_Color AColor  (Standard_Real (MyCLight.Color.r),
			Standard_Real (MyCLight.Color.g),
			Standard_Real (MyCLight.Color.b),
			Quantity_TOC_RGB);

Graphic3d_Vertex APosition     (Standard_Real (MyCLight.Position.x),
				Standard_Real (MyCLight.Position.y),
				Standard_Real (MyCLight.Position.z));

Graphic3d_Vector ADirection    (Standard_Real (MyCLight.Direction.x),
				Standard_Real (MyCLight.Direction.y),
				Standard_Real (MyCLight.Direction.z));

	if (MyType == Visual3d_TOLS_SPOT) {
		Color		= AColor;
		Position	= APosition;
		Direction	= ADirection;
		Concentration	= Standard_Real (MyCLight.Concentration);
		Fact1		= Standard_Real (MyCLight.Attenuation[0]);
		Fact2		= Standard_Real (MyCLight.Attenuation[1]);
		AngleCone	= Standard_Real (MyCLight.Angle);
	}
	else Visual3d_LightDefinitionError::Raise
		("Light Type != Visual3d_TOLS_SPOT");

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::SetAngle (const Standard_Real AngleCone) {

	if (! Visual3d_Light::IsValid (AngleCone))
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAngle");

	if (MyType == Visual3d_TOLS_SPOT) {
		MyCLight.Angle	= float (AngleCone);

		MyCLight.LightId	=
		  Graphic3d_GraphicDriver::Light (MyCLight, Standard_True);

	}
	else Visual3d_LightDefinitionError::Raise
		("Light Type != Visual3d_TOLS_SPOT");

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::SetAttenuation1 (const Standard_Real Fact1) {

	if ( (Fact1 < 0.0) && (Fact1 > 1.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAttenuation");

	if ( (MyType == Visual3d_TOLS_POSITIONAL) ||
	     (MyType == Visual3d_TOLS_SPOT) ) {
		MyCLight.Attenuation[0] = float (Fact1);

		MyCLight.LightId	=
		  Graphic3d_GraphicDriver::Light (MyCLight, Standard_True);

	}
	else Visual3d_LightDefinitionError::Raise
	("Light Type != Visual3d_TOLS_POSITIONAL and != Visual3d_TOLS_SPOT");

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::SetAttenuation2 (const Standard_Real Fact2) {

	if ( (Fact2 < 0.0) && (Fact2 > 1.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightAttenuation");

	if ( (MyType == Visual3d_TOLS_POSITIONAL) ||
	     (MyType == Visual3d_TOLS_SPOT) ) {
		MyCLight.Attenuation[1] = float (Fact2);

		MyCLight.LightId	=
		  Graphic3d_GraphicDriver::Light (MyCLight, Standard_True);

	}
	else Visual3d_LightDefinitionError::Raise
	("Light Type != Visual3d_TOLS_POSITIONAL and != Visual3d_TOLS_SPOT");

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::SetColor (const Quantity_Color& Color) {

	MyCLight.Color.r	= float (Color.Red ());
	MyCLight.Color.g	= float (Color.Green ());
	MyCLight.Color.b	= float (Color.Blue ());

	MyCLight.LightId	=
		  Graphic3d_GraphicDriver::Light (MyCLight, Standard_True);

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::SetConcentration (const Standard_Real Concentration) {

	if ( (Concentration < 0.0) || (Concentration > 1.0) )
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightConcentration");

	if (MyType == Visual3d_TOLS_SPOT) {
		MyCLight.Concentration	= float (Concentration);

		MyCLight.LightId	=
		  Graphic3d_GraphicDriver::Light (MyCLight, Standard_True);
	}
	else Visual3d_LightDefinitionError::Raise
		("Light Type != Visual3d_TOLS_SPOT");

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::SetDirection (const Graphic3d_Vector& Direction) {

	if (Direction.LengthZero ())
		Visual3d_LightDefinitionError::Raise
			("Bad value for LightDirection");

	if ( (MyType == Visual3d_TOLS_DIRECTIONAL) ||
	     (MyType == Visual3d_TOLS_SPOT) ) {

Standard_Real Norme, X, Y, Z;
		Direction.Coord (X, Y, Z);
		Norme	= Sqrt (X*X+Y*Y+Z*Z);
		// Direction.LengthZero () == Standard_False
		MyCLight.Direction.x	= float (X/Norme);
		MyCLight.Direction.y	= float (Y/Norme);
		MyCLight.Direction.z	= float (Z/Norme);

		MyCLight.LightId	=
		  Graphic3d_GraphicDriver::Light (MyCLight, Standard_True);

	}
	else Visual3d_LightDefinitionError::Raise
	("Light Type != Visual3d_TOLS_DIRECTIONAL and != Visual3d_TOLS_SPOT");

}

/*----------------------------------------------------------------------*/

void Visual3d_Light::SetPosition (const Graphic3d_Vertex& Position) {

	if ( (MyType == Visual3d_TOLS_POSITIONAL) ||
	     (MyType == Visual3d_TOLS_SPOT) ) {

		MyCLight.Position.x	= float (Position.X ());
		MyCLight.Position.y	= float (Position.Y ());
		MyCLight.Position.z	= float (Position.Z ());

		MyCLight.LightId	=
		  Graphic3d_GraphicDriver::Light (MyCLight, Standard_True);

	}
	else Visual3d_LightDefinitionError::Raise
	("Light Type != Visual3d_TOLS_POSITIONAL and != Visual3d_TOLS_SPOT");

}

/*----------------------------------------------------------------------*/

Standard_Integer Visual3d_Light::Limit () {

	// Old method, replaced by GraphicDriver::InquireLightLimit ()
	return 0;

}

/*----------------------------------------------------------------------*/

Standard_Integer Visual3d_Light::Identification () const {

	return (Standard_Integer (MyCLight.LightId));

}

/*----------------------------------------------------------------------*/

Standard_Boolean Visual3d_Light::IsValid (const Standard_Real AAngle) {

	return ( (AAngle <  Standard_PI) && (AAngle >= 0.0) );

}

/*----------------------------------------------------------------------*/