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
|
/*******************************************************************************
* trace.h
*
* ---------------------------------------------------------------------------
* Persistence of Vision Ray Tracer ('POV-Ray') version 3.7.
* Copyright 1991-2013 Persistence of Vision Raytracer Pty. Ltd.
*
* POV-Ray is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* POV-Ray 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* ---------------------------------------------------------------------------
* POV-Ray is based on the popular DKB raytracer version 2.12.
* DKBTrace was originally written by David K. Buck.
* DKBTrace Ver 2.0-2.12 were written by David K. Buck & Aaron A. Collins.
* ---------------------------------------------------------------------------
* $File: //depot/public/povray/3.x/source/backend/render/trace.h $
* $Revision: #1 $
* $Change: 6069 $
* $DateTime: 2013/11/06 11:59:40 $
* $Author: chrisc $
*******************************************************************************/
#ifndef POVRAY_BACKEND_TRACE_H
#define POVRAY_BACKEND_TRACE_H
#include <vector>
#include <boost/thread.hpp>
#include "backend/frame.h"
#include "backend/povray.h"
#include "backend/scene/atmosph.h"
#include "backend/scene/threaddata.h"
#include "backend/scene/objects.h"
#include "backend/support/bsptree.h"
#include "backend/support/randomsequences.h"
#include "povrayold.h"
namespace pov
{
class SceneData;
class ViewData;
class Task;
class PhotonGatherer;
struct NoSomethingFlagRayObjectCondition : public RayObjectCondition
{
virtual bool operator()(const Ray& ray, const ObjectBase* object, double) const
{
if(ray.IsImageRay() && Test_Flag(object, NO_IMAGE_FLAG))
return false;
if(ray.IsReflectionRay() && Test_Flag(object, NO_REFLECTION_FLAG))
return false;
if(ray.IsRadiosityRay() && Test_Flag(object, NO_RADIOSITY_FLAG))
return false;
if(ray.IsPhotonRay() && Test_Flag(object, NO_SHADOW_FLAG))
return false;
return true;
}
};
struct LitInterval
{
bool lit;
double s0, s1, ds;
size_t l0, l1;
LitInterval() :
lit(false), s0(0.0), s1(0.0), ds(0.0), l0(0), l1(0) { }
LitInterval(bool nlit, double ns0, double ns1, size_t nl0, size_t nl1) :
lit(nlit), s0(ns0), s1(ns1), ds(ns1 - ns0), l0(nl0), l1(nl1) { }
};
struct MediaInterval
{
bool lit;
int samples;
double s0, s1, ds;
size_t l0, l1;
RGBColour od;
RGBColour te;
RGBColour te2;
MediaInterval() :
lit(false), samples(0), s0(0.0), s1(0.0), ds(0.0), l0(0), l1(0) { }
MediaInterval(bool nlit, int nsamples, double ns0, double ns1, double nds, size_t nl0, size_t nl1) :
lit(nlit), samples(nsamples), s0(ns0), s1(ns1), ds(nds), l0(nl0), l1(nl1) { }
MediaInterval(bool nlit, int nsamples, double ns0, double ns1, double nds, size_t nl0, size_t nl1, const RGBColour& nod, const RGBColour& nte, const RGBColour& nte2) :
lit(nlit), samples(nsamples), s0(ns0), s1(ns1), ds(nds), l0(nl0), l1(nl1), od(nod), te(nte), te2(nte2) { }
bool operator<(const MediaInterval& other) const { return (s0 < other.s0); }
};
struct LightSourceIntersectionEntry
{
double s;
size_t l;
bool lit;
LightSourceIntersectionEntry() :
s(0.0), l(0), lit(false) { }
LightSourceIntersectionEntry(double ns, size_t nl, bool nlit) :
s(ns), l(nl), lit(nlit) { }
bool operator<(const LightSourceIntersectionEntry& other) const { return (s < other.s); }
};
struct LightSourceEntry
{
double s0, s1;
LightSource *light;
LightSourceEntry() :
s0(0.0), s1(0.0), light(NULL) { }
LightSourceEntry(LightSource *nlight) :
s0(0.0), s1(0.0), light(nlight) { }
LightSourceEntry(double ns0, double ns1, LightSource *nlight) :
s0(ns0), s1(ns1), light(nlight) { }
bool operator<(const LightSourceEntry& other) const { return (s0 < other.s0); }
};
// TODO: these sizes will need tweaking.
typedef FixedSimpleVector<Media *, MEDIA_VECTOR_SIZE> MediaVector; // TODO FIXME - cannot allow this to be fixed size [trf]
typedef FixedSimpleVector<MediaInterval, MEDIA_INTERVAL_VECTOR_SIZE> MediaIntervalVector; // TODO FIXME - cannot allow this to be fixed size [trf]
typedef FixedSimpleVector<LitInterval, LIT_INTERVAL_VECTOR_SIZE> LitIntervalVector; // TODO FIXME - cannot allow this to be fixed size [trf]
typedef FixedSimpleVector<LightSourceIntersectionEntry, LIGHT_INTERSECTION_VECTOR_SIZE> LightSourceIntersectionVector; // TODO FIXME - cannot allow this to be fixed size [trf]
typedef FixedSimpleVector<LightSourceEntry, LIGHTSOURCE_VECTOR_SIZE> LightSourceEntryVector; // TODO FIXME - cannot allow this to be fixed size [trf]
/**
* Ray tracing and shading engine.
* This class provides the fundamental functionality to trace rays and determine the effective colour.
*/
class Trace
{
public:
struct TraceTicket
{
/// trace recursion level
unsigned int traceLevel;
/// maximum trace recursion level allowed
unsigned int maxAllowedTraceLevel;
/// maximum trace recursion level found
unsigned int maxFoundTraceLevel;
/// adc bailout
double adcBailout;
/// whether background should be rendered all transparent
bool alphaBackground;
/// something the radiosity algorithm needs
unsigned int radiosityRecursionDepth;
/// something the radiosity algorithm needs
float radiosityImportanceQueried;
/// something the radiosity algorithm needs
float radiosityImportanceFound;
/// set by radiosity code according to the sample quality encountered (1.0 is ideal, 0.0 really sucks)
float radiosityQuality;
/// something the subsurface scattering algorithm needs
unsigned int subsurfaceRecursionDepth;
TraceTicket(unsigned int mtl, double adcb, bool ab = true, unsigned int rrd = 0, unsigned int ssrd = 0, float riq = -1.0, float rq = 1.0):
traceLevel(0), maxAllowedTraceLevel(mtl), maxFoundTraceLevel(0), adcBailout(adcb), alphaBackground(ab), radiosityRecursionDepth(rrd), subsurfaceRecursionDepth(ssrd),
radiosityImportanceQueried(riq), radiosityImportanceFound(-1.0), radiosityQuality(rq) {}
};
class CooperateFunctor
{
public:
virtual void operator()() { }
};
class MediaFunctor
{
public:
virtual void ComputeMedia(vector<Media>&, const Ray&, Intersection&, Colour&, Trace::TraceTicket& ticket) { }
virtual void ComputeMedia(const RayInteriorVector&, const Ray&, Intersection&, Colour&, Trace::TraceTicket& ticket) { }
virtual void ComputeMedia(MediaVector&, const Ray&, Intersection&, Colour&, Trace::TraceTicket& ticket) { }
};
class RadiosityFunctor
{
public:
virtual void ComputeAmbient(const Vector3d& ipoint, const Vector3d& raw_normal, const Vector3d& layer_normal, RGBColour& ambient_colour, double weight, Trace::TraceTicket& ticket) { }
virtual bool CheckRadiosityTraceLevel(const Trace::TraceTicket& ticket) { return false; }
};
Trace(shared_ptr<SceneData> sd, TraceThreadData *td, unsigned int qf,
CooperateFunctor& cf, MediaFunctor& mf, RadiosityFunctor& af);
virtual ~Trace();
/**
* Trace a ray.
*
* @param[in] ray ray
* @param[out] colour computed colour
* @param[in] weight importance of this computation
* @param[in,out] ticket additional information passed through to/from secondary rays
* @param[in] continuedRay set to true when tracing a ray after it went through some surface
* without a change in direction; this governs trace level handling
* @param[in] maxDepth objects at or beyond this distance won't be hit by the ray (ignored if < EPSILON)
* @return the distance to the nearest object hit
*/
virtual double TraceRay(const Ray& ray, Colour& colour, COLC weight, TraceTicket& ticket, bool continuedRay, DBL maxDepth = 0.0);
bool FindIntersection(Intersection& isect, const Ray& ray);
bool FindIntersection(Intersection& isect, const Ray& ray, const RayObjectCondition& precondition, const RayObjectCondition& postcondition);
bool FindIntersection(ObjectPtr object, Intersection& isect, const Ray& ray, double closest = HUGE_VAL);
bool FindIntersection(ObjectPtr object, Intersection& isect, const Ray& ray, const RayObjectCondition& postcondition, double closest = HUGE_VAL);
unsigned int GetHighestTraceLevel();
bool TestShadow(const LightSource &light, double& depth, Ray& light_source_ray, const Vector3d& p, RGBColour& colour, TraceTicket& ticket); // TODO FIXME - this should not be exposed here
protected: // TODO FIXME - should be private
/// structure used to cache reflection information for multi-layered textures
struct WNRX
{
double weight;
Vector3d normal;
RGBColour reflec;
SNGL reflex;
WNRX(DBL w, const Vector3d& n, const RGBColour& r, SNGL x) :
weight(w), normal(n), reflec(r), reflex(x) { }
};
typedef vector<const TEXTURE *> TextureVectorData;
typedef RefPool<TextureVectorData> TextureVectorPool;
typedef Ref<TextureVectorData, RefClearContainer<TextureVectorData> > TextureVector;
typedef vector<WNRX> WNRXVectorData;
typedef RefPool<WNRXVectorData> WNRXVectorPool;
typedef Ref<WNRXVectorData, RefClearContainer<WNRXVectorData> > WNRXVector;
/// structure used to cache shadow test results for complex textures
struct LightColorCache
{
bool tested;
RGBColour colour;
};
typedef vector<LightColorCache> LightColorCacheList;
typedef vector<LightColorCacheList> LightColorCacheListList;
/// List (well really vector) of lists of LightColorCaches.
/// Each list is expected to have as many elements as there are global light sources.
/// The number of lists should be at least that of max trace level.
LightColorCacheListList lightColorCache;
/// current index into lightColorCaches
int lightColorCacheIndex;
/// scene data
shared_ptr<SceneData> sceneData;
/// maximum trace recursion level found
unsigned int maxFoundTraceLevel;
/// adc bailout
unsigned int qualityFlags;
/// bounding slabs priority queue
PriorityQueue priorityQueue;
/// BSP tree mailbox
BSPTree::Mailbox mailbox;
/// area light grid buffer
vector<RGBColour> lightGrid;
/// fast stack pool
IStackPool stackPool;
/// fast texture list pool
TextureVectorPool texturePool;
/// fast WNRX list pool
WNRXVectorPool wnrxPool;
/// light source shadow cache for shadow tests of first trace level intersections
vector<ObjectPtr> lightSourceLevel1ShadowCache;
/// light source shadow cache for shadow tests of higher trace level intersections
vector<ObjectPtr> lightSourceOtherShadowCache;
/// crand random number generator
unsigned int crandRandomNumberGenerator;
/// pseudo-random number sequence
RandomDoubleSequence randomNumbers;
/// pseudo-random number generator based on random number sequence
RandomDoubleSequence::Generator randomNumberGenerator;
/// sub-random uniform 3d points on sphere sequence
vector<SequentialVectorGeneratorPtr> ssltUniformDirectionGenerator;
/// sub-random uniform numbers sequence
vector<SequentialDoubleGeneratorPtr> ssltUniformNumberGenerator;
/// sub-random cos-weighted 3d points on hemisphere sequence
vector<SequentialVectorGeneratorPtr> ssltCosWeightedDirectionGenerator;
/// thread data
TraceThreadData *threadData;
CooperateFunctor& cooperate;
MediaFunctor& media;
RadiosityFunctor& radiosity;
/**
***************************************************************************************************************
*
* @name Texture Computations
*
* The following methods compute the effective colour of a given, possibly complex, texture.
*
* @{
*/
/**
* Compute the effective contribution of an intersection point as seen from the ray's origin, or deposits
* photons.
*
* Computations include any media effects between the ray's origin and the point of intersection.
*
* @remark The computed contribution is @e added to the value passed in @c colour (does not apply to photon pass).
* @see36 Determine_Apparent_Colour() in lighting.cpp
* @todo Some input parameters are non-const references.
*
* @param[in] isect intersection information
* @param[in,out] colour computed colour [in,out]; during photon pass: light colour [in]
* @param[in] ray ray
* @param[in] weight importance of this computation
* @param[in] photonpass whether to deposit photons instead of computing a colour
* @param[in,out] ticket additional information passed through to/from secondary rays
*/
void ComputeTextureColour(Intersection& isect, Colour& colour, const Ray& ray, COLC weight, bool photonpass, TraceTicket& ticket);
/**
* Compute the effective colour of an arbitrarily complex texture, or deposits photons.
*
* @remark The computed contribution @e overwrites any value passed in @c colour (does not apply to photon pass).
* @remark Computations do @e not include media effects between the ray's origin and the point of intersection any longer.
* @see36 do_texture_map() in lighting.cpp
* @todo Some input parameters are non-const references or pointers.
*
* @param[in,out] resultcolour computed colour [out]; during photon pass: light colour [in]
* @param[in] texture texture
* @param[in] warps stack of warps to be applied
* @param[in] ipoint intersection point (possibly with earlier warps already applied)
* @param[in] rawnormal geometric (possibly smoothed) surface normal
* @param[in] ray ray
* @param[in] weight importance of this computation
* @param[in] isect intersection information
* @param[in] shadowflag whether to perform only computations necessary for shadow testing
* @param[in] photonpass whether to deposit photons instead of computing a colour
* @param[in,out] ticket additional information passed through to/from secondary rays
*/
void ComputeOneTextureColour(Colour& resultcolour, const TEXTURE *texture, vector<const TEXTURE *>& warps, const Vector3d& ipoint,
const Vector3d& rawnormal, const Ray& ray, COLC weight, Intersection& isect, bool shadowflag,
bool photonpass, TraceTicket& ticket);
/**
* Compute the effective colour of an averaged texture, or deposits photons.
*
* @remark The computed contribution @e overwrites any value passed in @c colour (does not apply to photon pass).
* @remark Computations do @e not include media effects between the ray's origin and the point of intersection
* any longer.
* @todo Some input parameters are non-const references or pointers.
*
* @param[in,out] resultcolour computed colour [out]; during photon pass: light colour [in]
* @param[in] texture texture
* @param[in] warps stack of warps to be applied
* @param[in] ipoint intersection point (possibly with earlier warps already applied)
* @param[in] rawnormal geometric (possibly smoothed) surface normal
* @param[in] ray ray
* @param[in] weight importance of this computation
* @param[in] isect intersection information
* @param[in] shadowflag whether to perform only computations necessary for shadow testing
* @param[in] photonpass whether to deposit photons instead of computing a colour
* @param[in,out] ticket additional information passed through to/from secondary rays
*/
void ComputeAverageTextureColours(Colour& resultcolour, const TEXTURE *texture, vector<const TEXTURE *>& warps, const Vector3d& ipoint,
const Vector3d& rawnormal, const Ray& ray, COLC weight, Intersection& isect, bool shadowflag,
bool photonpass, TraceTicket& ticket);
/**
* Compute the effective colour of a simple or layered texture.
*
* Computations include secondary rays, as well as any media effects between the ray's origin and the point of intersection.
*
* @remark The computed contribution @e overwrites any value passed in @c colour.
* @remark Computations do @e not include media effects between the ray's origin and the point of intersection any longer.
* @remark pov::PhotonTrace overrides this method to deposit photons instead.
* @see36 compute_lighted_texture()
* @todo Some input parameters are non-const references or pointers.
*
* @param[in,out] resultcolour computed colour [out]; during photon pass: light colour [in]
* @param[in] texture texture
* @param[in] warps stack of warps to be applied
* @param[in] ipoint intersection point (possibly with earlier warps already applied)
* @param[in] rawnormal geometric (possibly smoothed) surface normal
* @param[in] ray ray
* @param[in] weight importance of this computation
* @param[in] isect intersection information
* @param[in,out] ticket additional information passed through to/from secondary rays
*/
virtual void ComputeLightedTexture(Colour& resultcolour, const TEXTURE *texture, vector<const TEXTURE *>& warps, const Vector3d& ipoint,
const Vector3d& rawnormal, const Ray& ray, COLC weight, Intersection& isect, TraceTicket& ticket);
/**
* Compute the effective filtering effect of a simple or layered texture.
*
* @remark The computed contribution @e overwrites any value passed in @c colour.
* @remark Computations do @e not include media effects between the ray's origin and the point of intersection any longer.
* @todo Some input parameters are non-const references or pointers.
*
* @param[in,out] filtercolour computed filter colour [out]; during photon pass: light colour [in]
* @param[in] texture texture
* @param[in] warps stack of warps to be applied
* @param[in] ipoint intersection point (possibly with earlier warps already applied)
* @param[in] rawnormal geometric (possibly smoothed) surface normal
* @param[in] ray ray
* @param[in] isect intersection information
* @param[in,out] ticket additional information passed through to/from secondary rays
*/
void ComputeShadowTexture(Colour& filtercolour, const TEXTURE *texture, vector<const TEXTURE *>& warps, const Vector3d& ipoint,
const Vector3d& rawnormal, const Ray& ray, Intersection& isect, TraceTicket& ticket);
/**
* @}
*
***************************************************************************************************************
*
* @name Reflection and Refraction Computations
*
* The following methods compute the contribution of secondary (reflected and refracted) rays.
*
* @{
*/
void ComputeReflection(const FINISH* finish, const Vector3d& ipoint, const Ray& ray, const Vector3d& normal, const Vector3d& rawnormal, Colour& colour, COLC weight, TraceTicket& ticket);
bool ComputeRefraction(const FINISH* finish, Interior *interior, const Vector3d& ipoint, const Ray& ray, const Vector3d& normal, const Vector3d& rawnormal, Colour& colour, COLC weight, TraceTicket& ticket);
bool TraceRefractionRay(const FINISH* finish, const Vector3d& ipoint, const Ray& ray, Ray& nray, double ior, double n, const Vector3d& normal, const Vector3d& rawnormal, const Vector3d& localnormal, Colour& colour, COLC weight, TraceTicket& ticket);
/**
* @}
*
***************************************************************************************************************
*
* @name Classic Light Source Computations
*
* The following methods compute the (additional) contribution of classic lighting.
*
* @{
*/
/// @todo The name is misleading, as it computes all contributions of classic lighting, including highlights.
void ComputeDiffuseLight(const FINISH *finish, const Vector3d& ipoint, const Ray& eye, const Vector3d& layer_normal, const RGBColour& layer_pigment_colour,
RGBColour& colour, double attenuation, ObjectPtr object, TraceTicket& ticket);
/// @todo The name is misleading, as it computes all contributions of classic lighting, including highlights.
void ComputeOneDiffuseLight(const LightSource &lightsource, const Vector3d& reye, const FINISH *finish, const Vector3d& ipoint, const Ray& eye,
const Vector3d& layer_normal, const RGBColour& Layer_Pigment_Colour, RGBColour& colour, double Attenuation, ConstObjectPtr Object, TraceTicket& ticket, int light_index = -1);
/// @todo The name is misleading, as it computes all contributions of classic lighting, including highlights.
void ComputeFullAreaDiffuseLight(const LightSource &lightsource, const Vector3d& reye, const FINISH *finish, const Vector3d& ipoint, const Ray& eye,
const Vector3d& layer_normal, const RGBColour& layer_pigment_colour, RGBColour& colour, double attenuation,
double lightsourcedepth, Ray& lightsourceray, const RGBColour& lightcolour,
bool isDoubleIlluminated); // JN2007: Full area lighting
/**
* Compute the direction, distance and unshadowed brightness of an unshadowed light source.
*
* Computations include spotlight falloff and distance-based attenuation.
*
* @param[in] lightsource light source
* @param[out] lightsourcedepth distance to the light source
* @param[in,out] lightsourceray ray to the light source
* @param[in] ipoint intersection point
* @param[out] lightcolour effective brightness
* @param[in] forceAttenuate true to immediately apply distance-based attenuation even for full area lights
*/
void ComputeOneLightRay(const LightSource &lightsource, double& lightsourcedepth, Ray& lightsourceray, const Vector3d& ipoint, RGBColour& lightcolour, bool forceAttenuate = false);
void TraceShadowRay(const LightSource &light, double depth, const Ray& lightsourceray, const Vector3d& point, RGBColour& colour, TraceTicket& ticket);
void TracePointLightShadowRay(const LightSource &lightsource, double& lightsourcedepth, Ray& lightsourceray, RGBColour& lightcolour, TraceTicket& ticket);
void TraceAreaLightShadowRay(const LightSource &lightsource, double& lightsourcedepth, Ray& lightsourceray,
const Vector3d& ipoint, RGBColour& lightcolour, TraceTicket& ticket);
void TraceAreaLightSubsetShadowRay(const LightSource &lightsource, double& lightsourcedepth, Ray& lightsourceray,
const Vector3d& ipoint, RGBColour& lightcolour, int u1, int v1, int u2, int v2, int level, const Vector3d& axis1, const Vector3d& axis2,
TraceTicket& ticket);
/**
* Compute the filtering effect of an object on incident light from a particular light source.
*
* Computations include any media effects between the ray's origin and the point of intersection.
*
* @todo Some input parameters are non-const references.
*
* @param[in] lightsource light source
* @param[in] isect intersection information
* @param[in,out] lightsourceray ray to the light source
* @param[in,out] colour computed effect on the incident light
* @param[in,out] ticket additional information passed through to/from secondary rays
*/
void ComputeShadowColour(const LightSource &lightsource, Intersection& isect, Ray& lightsourceray, RGBColour& colour, TraceTicket& ticket);
/**
* Compute the direction and distance of a single light source to a given intersection point.
*
* @remark The @c Origin and @c Direction member of @c lightsourceray are updated, all other members are left unchanged;
* the distance is returned in a separate parameter. For cylindrical light sources, the values are set accordingly.
* @todo The name is misleading, as it just computes direction and distance.
*
* @param[in] lightsource light source
* @param[out] lightsourcedepth distance to the light source
* @param[in,out] lightsourceray ray to the light source
* @param[in] ipoint intersection point
* @param[in] jitter jitter to apply to the light source
*/
void ComputeOneWhiteLightRay(const LightSource &lightsource, double& lightsourcedepth, Ray& lightsourceray, const Vector3d& ipoint, const Vector3d& jitter = Vector3d());
/**
* @}
*
***************************************************************************************************************
*
* @name Photon Light Source Computations
*
* The following methods compute the (additional) contribution of photon-based lighting.
*
* @{
*/
/// @todo The name is misleading, as it computes all contributions of classic lighting, including highlights.
void ComputePhotonDiffuseLight(const FINISH *Finish, const Vector3d& IPoint, const Ray& Eye, const Vector3d& Layer_Normal, const Vector3d& Raw_Normal,
const RGBColour& Layer_Pigment_Colour, RGBColour& colour, double Attenuation,
ConstObjectPtr Object, PhotonGatherer& renderer);
/**
* @}
*
***************************************************************************************************************
*
* @name Material Finish Computations
*
* The following methods compute the contribution of a finish illuminated by light from a given direction.
*
* @{
*/
/**
* Compute the diffuse contribution of a finish illuminated by light from a given direction.
*
* @remark The computed contribution is @e added to the value passed in @c colour.
*
* @param[in] finish finish
* @param[in] lightsourceray ray from intersection to light source
* @param[in] layer_normal effective (possibly pertubed) surface normal
* @param[in,out] colour effective surface colour
* @param[in] light_colour effective light colour
* @param[in] layer_pigment_colour nominal pigment colour
* @param[in] attenuation attenuation factor to account for partial transparency
* @param[in] backside whether to use backside instead of frontside diffuse brightness factor
*/
void ComputeDiffuseColour(const FINISH *finish, const Ray& lightsourceray, const Vector3d& layer_normal, RGBColour& colour,
const RGBColour& light_colour, const RGBColour& layer_pigment_colour, double attenuation, bool backside);
/**
* Compute the iridescence contribution of a finish illuminated by light from a given direction.
*
* @remark The computed contribution is @e added to the value passed in @c colour.
*
* @param[in] finish finish
* @param[in] lightsourceray ray from intersection to light source
* @param[in] layer_normal effective (possibly pertubed) surface normal
* @param[in] ipoint intersection point (possibly with earlier warps already applied)
* @param[in,out] colour effective surface colour
*/
void ComputeIridColour(const FINISH *finish, const Vector3d& lightsource, const Vector3d& eye, const Vector3d& layer_normal, const Vector3d& ipoint, RGBColour& colour);
/**
* Compute the Phong highlight contribution of a finish illuminated by light from a given direction.
*
* Computation uses the classic Phong highlight model
*
* @remark The model used is @e not energy-conserving
* @remark The computed contribution is @e added to the value passed in @c colour.
*
* @param[in] finish finish
* @param[in] lightsourceray ray from intersection to light source
* @param[in] layer_normal effective (possibly pertubed) surface normal
* @param[in,out] colour effective surface colour
* @param[in] light_colour effective light colour
* @param[in] layer_pigment_colour nominal pigment colour
*/
void ComputePhongColour(const FINISH *finish, const Ray& lightsourceray, const Vector3d& eye, const Vector3d& layer_normal, RGBColour& colour,
const RGBColour& light_colour, const RGBColour& layer_pigment_colour);
/**
* Compute the specular highlight contribution of a finish illuminated by light from a given direction.
*
* Computation uses the Blinn-Phong highlight model
*
* @remark The model used is @e not energy-conserving
* @remark The computed contribution is @e added to the value passed in @c colour.
*
* @param[in] finish finish
* @param[in] lightsourceray ray from intersection to light source
* @param[in] eye vector from intersection to observer
* @param[in] layer_normal effective (possibly pertubed) surface normal
* @param[in,out] colour effective surface colour
* @param[in] light_colour effective light colour
* @param[in] layer_pigment_colour nominal pigment colour
*/
void ComputeSpecularColour(const FINISH *finish, const Ray& lightsourceray, const Vector3d& eye, const Vector3d& layer_normal, RGBColour& colour,
const RGBColour& light_colour, const RGBColour& layer_pigment_colour);
/**
* @}
*
***************************************************************************************************************
*/
void ComputeRelativeIOR(const Ray& ray, const Interior* interior, double& ior);
/**
* Compute Reflectivity.
*
* @remark In Fresnel mode, light is presumed to be unpolarized on average, using
* @f$ R = \frac{1}{2} \left( R_s + R_p \right) @f$.
*/
void ComputeReflectivity(double& weight, RGBColour& reflectivity, const RGBColour& reflection_max, const RGBColour& reflection_min,
int reflection_type, double reflection_falloff, double cos_angle, const Ray& ray, const Interior *interior);
void ComputeSky(const Ray& ray, Colour& colour, TraceTicket& ticket);
void ComputeFog(const Ray& ray, const Intersection& isect, Colour& colour);
double ComputeConstantFogColour(const Ray &ray, double depth, double width, const FOG *fog, Colour& colour);
double ComputeGroundFogColour(const Ray& ray, double depth, double width, const FOG *fog, Colour& colour);
void ComputeRainbow(const Ray& ray, const Intersection& isect, Colour& colour);
/**
* Compute media effect on traversing light rays.
*
* @note This computes two things:
* - media and fog attenuation of the shadow ray (optional)
* - entry/exit of interiors
* .
* In other words, you can't skip this whole thing, because the entry/exit is important.
*/
void ComputeShadowMedia(Ray& light_source_ray, Intersection& isect, RGBColour& resultcolour, bool media_attenuation_and_interaction, TraceTicket& ticket);
/**
* Test whether an object is part of (or identical to) a given other object.
*
* @todo The name is misleading, as the object to test against (@c parent) does not necessarily have
* to be a CSG compound object, but can actually be of any type. In that case, the function
* serves to test for identity.
*
* @param[in] object the object to test
* @param[in] parent the object to test against
* @return true if @c object is part of, or identical to, @c parent
*/
bool IsObjectInCSG(const ObjectBase *object, const ObjectBase *parent);
/**
* @}
*
***************************************************************************************************************
*
* @name Subsurface Light Transport
*
* The following methods implement the BSSRDF approximation as outlined by Jensen et al.
*
* @{
*/
double ComputeFt(double phi, double eta);
void ComputeSurfaceTangents(const Vector3d& normal, Vector3d& u, Vector3d& v);
void ComputeSSLTNormal (Intersection& Ray_Intersection);
bool IsSameSSLTObject(const ObjectBase* obj1, const ObjectBase* obj2);
void ComputeDiffuseSampleBase(Vector3d& basePoint, const Intersection& out, const Vector3d& vOut, double avgFreeDist);
void ComputeDiffuseSamplePoint(const Vector3d& basePoint, Intersection& in, double& sampleArea, TraceTicket& ticket);
void ComputeDiffuseContribution(const Intersection& out, const Vector3d& vOut, const Vector3d& pIn, const Vector3d& nIn, const Vector3d& vIn, double& sd, double sigma_prime_s, double sigma_a, double eta);
void ComputeDiffuseContribution1(const LightSource& lightsource, const Intersection& out, const Vector3d& vOut, const Intersection& in, RGBColour& Total_Colour, const DblRGBColour& sigma_prime_s, const DblRGBColour& sigma_a, double eta, double weight, TraceTicket& ticket);
void ComputeDiffuseAmbientContribution1(const Intersection& out, const Vector3d& vOut, const Intersection& in, RGBColour& Total_Colour, const DblRGBColour& sigma_prime_s, const DblRGBColour& sigma_a, double eta, double weight, TraceTicket& ticket);
void ComputeOneSingleScatteringContribution(const LightSource& lightsource, const Intersection& out, double sigma_t_xo, double sigma_s, double s_prime_out, RGBColour& Lo, double eta, const Vector3d& bend_point, double phi_out, double cos_out_prime, TraceTicket& ticket);
void ComputeSingleScatteringContribution(const Intersection& out, double dist, double cos_out, const Vector3d& refractedREye, double sigma_prime_t, double sigma_prime_s, RGBColour& Lo, double eta, TraceTicket& ticket);
void ComputeSubsurfaceScattering (const FINISH *Finish, const RGBColour& layer_pigment_colour, const Intersection& isect, const Ray& Eye, const Vector3d& Layer_Normal, RGBColour& Colour, double Attenuation, TraceTicket& ticket);
bool SSLTComputeRefractedDirection(const Vector3d& v, const Vector3d& n, double eta, Vector3d& refracted);
/**
* @}
*
***************************************************************************************************************
*/
};
}
#endif // POVRAY_BACKEND_TRACE_H
|
