--- ray/src/rt/raytrace.c	1991/05/29 11:09:23	1.18
+++ ray/src/rt/raytrace.c	2005/04/14 18:04:12	2.47
@@ -1,105 +1,149 @@
-/* Copyright (c) 1991 Regents of the University of California */
-
 #ifndef lint
-static char SCCSid[] = "$SunId$ LBL";
+static const char RCSid[] = "$Id: raytrace.c,v 2.47 2005/04/14 18:04:12 greg Exp $";
 #endif
-
 /*
  *  raytrace.c - routines for tracing and shading rays.
  *
- *     8/7/85
+ *  External symbols declared in ray.h
  */
 
-#include  "ray.h"
+#include "copyright.h"
 
-#include  "octree.h"
-
+#include  "ray.h"
+#include  "source.h"
 #include  "otypes.h"
-
 #include  "otspecial.h"
 
-extern CUBE  thescene;			/* our scene */
-extern int  maxdepth;			/* maximum recursion depth */
-extern double  minweight;		/* minimum ray weight */
-extern int  do_irrad;			/* compute irradiance? */
+#define  MAXCSET	((MAXSET+1)*2-1)	/* maximum check set size */
 
-long  nrays = 0L;			/* number of rays traced */
+unsigned long  raynum = 0;		/* next unique ray number */
+unsigned long  nrays = 0;		/* number of calls to localhit */
 
-static double  Lambfa[5] = {PI, PI, PI, 0.0, 0.0};
+static RREAL  Lambfa[5] = {PI, PI, PI, 0.0, 0.0};
 OBJREC  Lamb = {
 	OVOID, MAT_PLASTIC, "Lambertian",
-	{0, 5, NULL, Lambfa}, NULL, -1,
+	{0, 5, NULL, Lambfa}, NULL,
 };					/* a Lambertian surface */
 
-#define  MAXLOOP	128		/* modifier loop detection */
+OBJREC  Aftplane;			/* aft clipping plane object */
 
 #define  RAYHIT		(-1)		/* return value for intercepted ray */
 
+static int raymove(FVECT  pos, OBJECT  *cxs, int  dirf, RAY  *r, CUBE  *cu);
+static int checkhit(RAY  *r, CUBE  *cu, OBJECT  *cxs);
+static void checkset(OBJECT  *os, OBJECT  *cs);
 
-rayorigin(r, ro, rt, rw)		/* start new ray from old one */
-register RAY  *r, *ro;
-int  rt;
-double  rw;
+
+extern int
+rayorigin(		/* start new ray from old one */
+	register RAY  *r,
+	register RAY  *ro,
+	int  rt,
+	double  rw
+)
 {
+	double	re;
+
 	if ((r->parent = ro) == NULL) {		/* primary ray */
 		r->rlvl = 0;
 		r->rweight = rw;
 		r->crtype = r->rtype = rt;
 		r->rsrc = -1;
 		r->clipset = NULL;
+		r->revf = raytrace;
+		copycolor(r->cext, cextinction);
+		copycolor(r->albedo, salbedo);
+		r->gecc = seccg;
+		r->slights = NULL;
+	} else if (ro->rot >= FHUGE) {		/* illegal continuation */
+		memset(r, 0, sizeof(RAY));
+		return(-1);
 	} else {				/* spawned ray */
 		r->rlvl = ro->rlvl;
 		if (rt & RAYREFL) {
 			r->rlvl++;
 			r->rsrc = -1;
 			r->clipset = ro->clipset;
+			r->rmax = 0.0;
 		} else {
 			r->rsrc = ro->rsrc;
 			r->clipset = ro->newcset;
+			r->rmax = ro->rmax <= FTINY ? 0.0 : ro->rmax - ro->rot;
 		}
-		r->rweight = ro->rweight * rw;
+		r->revf = ro->revf;
+		copycolor(r->cext, ro->cext);
+		copycolor(r->albedo, ro->albedo);
+		r->gecc = ro->gecc;
+		r->slights = ro->slights;
 		r->crtype = ro->crtype | (r->rtype = rt);
 		VCOPY(r->rorg, ro->rop);
+		r->rweight = ro->rweight * rw;
+						/* estimate absorption */
+		re = colval(ro->cext,RED) < colval(ro->cext,GRN) ?
+				colval(ro->cext,RED) : colval(ro->cext,GRN);
+		if (colval(ro->cext,BLU) < re) re = colval(ro->cext,BLU);
+		if (re > 0.)
+			r->rweight *= exp(-re*ro->rot);
 	}
-	r->rno = nrays;
+	rayclear(r);
+	return(r->rlvl <= maxdepth && r->rweight >= minweight ? 0 : -1);
+}
+
+
+extern void
+rayclear(			/* clear a ray for (re)evaluation */
+	register RAY  *r
+)
+{
+	r->rno = raynum++;
 	r->newcset = r->clipset;
+	r->hitf = rayhit;
+	r->robj = OVOID;
 	r->ro = NULL;
-	r->rot = FHUGE;
+	r->rox = NULL;
+	r->rt = r->rot = FHUGE;
 	r->pert[0] = r->pert[1] = r->pert[2] = 0.0;
+	r->uv[0] = r->uv[1] = 0.0;
 	setcolor(r->pcol, 1.0, 1.0, 1.0);
 	setcolor(r->rcol, 0.0, 0.0, 0.0);
-	r->rt = 0.0;
-	return(r->rlvl <= maxdepth && r->rweight >= minweight ? 0 : -1);
 }
 
 
-rayvalue(r)			/* compute a ray's value */
-RAY  *r;
+extern void
+raytrace(			/* trace a ray and compute its value */
+	RAY  *r
+)
 {
-	extern int  (*trace)();
-
 	if (localhit(r, &thescene))
-		raycont(r);
-	else if (sourcehit(r))
-		rayshade(r, r->ro->omod);
+		raycont(r);		/* hit local surface, evaluate */
+	else if (r->ro == &Aftplane) {
+		r->ro = NULL;		/* hit aft clipping plane */
+		r->rot = FHUGE;
+	} else if (sourcehit(r))
+		rayshade(r, r->ro->omod);	/* distant source */
 
+	rayparticipate(r);		/* for participating medium */
+
 	if (trace != NULL)
 		(*trace)(r);		/* trace execution */
 }
 
 
-raycont(r)			/* check for clipped object and continue */
-register RAY  *r;
+extern void
+raycont(			/* check for clipped object and continue */
+	register RAY  *r
+)
 {
-	if (r->clipset != NULL && inset(r->clipset, r->ro->omod))
+	if ((r->clipset != NULL && inset(r->clipset, r->ro->omod)) ||
+			!rayshade(r, r->ro->omod))
 		raytrans(r);
-	else
-		rayshade(r, r->ro->omod);
 }
 
 
-raytrans(r)			/* transmit ray as is */
-register RAY  *r;
+extern void
+raytrans(			/* transmit ray as is */
+	register RAY  *r
+)
 {
 	RAY  tr;
 
@@ -112,15 +156,15 @@ register RAY  *r;
 }
 
 
-rayshade(r, mod)		/* shade ray r with material mod */
-register RAY  *r;
-int  mod;
+extern int
+rayshade(		/* shade ray r with material mod */
+	register RAY  *r,
+	int  mod
+)
 {
-	static int  depth = 0;
 	register OBJREC  *m;
-					/* check for infinite loop */
-	if (depth++ >= MAXLOOP)
-		objerror(r->ro, USER, "possible modifier loop");
+
+	r->rt = r->rot;			/* set effective ray length */
 	for ( ; mod != OVOID; mod = m->omod) {
 		m = objptr(mod);
 		/****** unnecessary test since modifier() is always called
@@ -130,100 +174,157 @@ int  mod;
 		}
 		******/
 					/* hack for irradiance calculation */
-		if (do_irrad && !(r->crtype & ~(PRIMARY|TRANS))) {
+		if (do_irrad && !(r->crtype & ~(PRIMARY|TRANS)) &&
+				m->otype != MAT_CLIP &&
+				(ofun[m->otype].flags & (T_M|T_X))) {
 			if (irr_ignore(m->otype)) {
-				depth--;
 				raytrans(r);
-				return;
+				return(1);
 			}
 			if (!islight(m->otype))
 				m = &Lamb;
 		}
-		(*ofun[m->otype].funp)(m, r);	/* execute function */
-		m->lastrno = r->rno;
-		if (ismaterial(m->otype)) {	/* materials call raytexture */
-			depth--;
-			return;		/* we're done */
-		}
+		if ((*ofun[m->otype].funp)(m, r))
+			return(1);	/* materials call raytexture() */
 	}
-	objerror(r->ro, USER, "material not found");
+	return(0);			/* no material! */
 }
 
 
-raytexture(r, mod)			/* get material modifiers */
-RAY  *r;
-int  mod;
+extern void
+rayparticipate(			/* compute ray medium participation */
+	register RAY  *r
+)
 {
-	static int  depth = 0;
+	COLOR	ce, ca;
+	double	re, ge, be;
+
+	if (intens(r->cext) <= 1./FHUGE)
+		return;				/* no medium */
+	re = r->rot*colval(r->cext,RED);
+	ge = r->rot*colval(r->cext,GRN);
+	be = r->rot*colval(r->cext,BLU);
+	if (r->crtype & SHADOW) {		/* no scattering for sources */
+		re *= 1. - colval(r->albedo,RED);
+		ge *= 1. - colval(r->albedo,GRN);
+		be *= 1. - colval(r->albedo,BLU);
+	}
+	setcolor(ce,	re<=0. ? 1. : re>92. ? 0. : exp(-re),
+			ge<=0. ? 1. : ge>92. ? 0. : exp(-ge),
+			be<=0. ? 1. : be>92. ? 0. : exp(-be));
+	multcolor(r->rcol, ce);			/* path absorption */
+	if (r->crtype & SHADOW || intens(r->albedo) <= FTINY)
+		return;				/* no scattering */
+	setcolor(ca,
+		colval(r->albedo,RED)*colval(ambval,RED)*(1.-colval(ce,RED)),
+		colval(r->albedo,GRN)*colval(ambval,GRN)*(1.-colval(ce,GRN)),
+		colval(r->albedo,BLU)*colval(ambval,BLU)*(1.-colval(ce,BLU)));
+	addcolor(r->rcol, ca);			/* ambient in scattering */
+	srcscatter(r);				/* source in scattering */
+}
+
+
+extern void
+raytexture(			/* get material modifiers */
+	RAY  *r,
+	OBJECT  mod
+)
+{
 	register OBJREC  *m;
-					/* check for infinite loop */
-	if (depth++ >= MAXLOOP)
-		objerror(r->ro, USER, "modifier loop");
 					/* execute textures and patterns */
 	for ( ; mod != OVOID; mod = m->omod) {
 		m = objptr(mod);
-		if (!istexture(m->otype)) {
+		/****** unnecessary test since modifier() is always called
+		if (!ismodifier(m->otype)) {
 			sprintf(errmsg, "illegal modifier \"%s\"", m->oname);
 			error(USER, errmsg);
 		}
-		(*ofun[m->otype].funp)(m, r);
-		m->lastrno = r->rno;
+		******/
+		if ((*ofun[m->otype].funp)(m, r)) {
+			sprintf(errmsg, "conflicting material \"%s\"",
+					m->oname);
+			objerror(r->ro, USER, errmsg);
+		}
 	}
-	depth--;			/* end here */
 }
 
 
-raymixture(r, fore, back, coef)		/* mix modifiers */
-register RAY  *r;
-OBJECT  fore, back;
-double  coef;
+extern int
+raymixture(		/* mix modifiers */
+	register RAY  *r,
+	OBJECT  fore,
+	OBJECT  back,
+	double  coef
+)
 {
-	FVECT  curpert, forepert, backpert;
-	COLOR  curpcol, forepcol, backpcol;
+	RAY  fr, br;
+	int  foremat, backmat;
 	register int  i;
-					/* clip coefficient */
+					/* bound coefficient */
 	if (coef > 1.0)
 		coef = 1.0;
 	else if (coef < 0.0)
 		coef = 0.0;
-					/* save current mods */
-	VCOPY(curpert, r->pert);
-	copycolor(curpcol, r->pcol);
-					/* compute new mods */
-						/* foreground */
-	r->pert[0] = r->pert[1] = r->pert[2] = 0.0;
-	setcolor(r->pcol, 1.0, 1.0, 1.0);
-	if (fore != OVOID && coef > FTINY)
-		raytexture(r, fore);
-	VCOPY(forepert, r->pert);
-	copycolor(forepcol, r->pcol);
-						/* background */
-	r->pert[0] = r->pert[1] = r->pert[2] = 0.0;
-	setcolor(r->pcol, 1.0, 1.0, 1.0);
-	if (back != OVOID && coef < 1.0-FTINY)
-		raytexture(r, back);
-	VCOPY(backpert, r->pert);
-	copycolor(backpcol, r->pcol);
-					/* sum perturbations */
+					/* compute foreground and background */
+	foremat = backmat = 0;
+					/* foreground */
+	fr = *r;
+	if (coef > FTINY)
+		foremat = rayshade(&fr, fore);
+					/* background */
+	br = *r;
+	if (coef < 1.0-FTINY)
+		backmat = rayshade(&br, back);
+					/* check for transparency */
+	if (backmat ^ foremat) {
+		if (backmat && coef > FTINY)
+			raytrans(&fr);
+		else if (foremat && coef < 1.0-FTINY)
+			raytrans(&br);
+	}
+					/* mix perturbations */
 	for (i = 0; i < 3; i++)
-		r->pert[i] = curpert[i] + coef*forepert[i] +
-				(1.0-coef)*backpert[i];
-					/* multiply colors */
-	setcolor(r->pcol, coef*colval(forepcol,RED) +
-				(1.0-coef)*colval(backpcol,RED),
-			coef*colval(forepcol,GRN) +
-				(1.0-coef)*colval(backpcol,GRN),
-			coef*colval(forepcol,BLU) +
-				(1.0-coef)*colval(backpcol,BLU));
-	multcolor(r->pcol, curpcol);
+		r->pert[i] = coef*fr.pert[i] + (1.0-coef)*br.pert[i];
+					/* mix pattern colors */
+	scalecolor(fr.pcol, coef);
+	scalecolor(br.pcol, 1.0-coef);
+	copycolor(r->pcol, fr.pcol);
+	addcolor(r->pcol, br.pcol);
+					/* return value tells if material */
+	if (!foremat & !backmat)
+		return(0);
+					/* mix returned ray values */
+	scalecolor(fr.rcol, coef);
+	scalecolor(br.rcol, 1.0-coef);
+	copycolor(r->rcol, fr.rcol);
+	addcolor(r->rcol, br.rcol);
+	r->rt = bright(fr.rcol) > bright(br.rcol) ? fr.rt : br.rt;
+	return(1);
 }
 
 
-double
-raynormal(norm, r)		/* compute perturbed normal for ray */
-FVECT  norm;
-register RAY  *r;
+extern double
+raydist(		/* compute (cumulative) ray distance */
+	register RAY  *r,
+	register int  flags
+)
 {
+	double  sum = 0.0;
+
+	while (r != NULL && r->crtype&flags) {
+		sum += r->rot;
+		r = r->parent;
+	}
+	return(sum);
+}
+
+
+extern double
+raynormal(		/* compute perturbed normal for ray */
+	FVECT  norm,
+	register RAY  *r
+)
+{
 	double  newdot;
 	register int  i;
 
@@ -254,8 +355,10 @@ register RAY  *r;
 }
 
 
-newrayxf(r)			/* get new tranformation matrix for ray */
-RAY  *r;
+extern void
+newrayxf(			/* get new tranformation matrix for ray */
+	RAY  *r
+)
 {
 	static struct xfn {
 		struct xfn  *next;
@@ -273,7 +376,7 @@ RAY  *r;
 		if (rp->rox == &xp->xf) {		/* xp in use */
 			xp = xp->next;			/* move to next */
 			if (xp == xflast) {		/* need new one */
-				xp = (struct xfn *)bmalloc(sizeof(struct xfn));
+				xp = (struct xfn *)malloc(sizeof(struct xfn));
 				if (xp == NULL)
 					error(SYSTEM,
 						"out of memory in newrayxf");
@@ -290,8 +393,10 @@ RAY  *r;
 }
 
 
-flipsurface(r)			/* reverse surface orientation */
-register RAY  *r;
+extern void
+flipsurface(			/* reverse surface orientation */
+	register RAY  *r
+)
 {
 	r->rod = -r->rod;
 	r->ron[0] = -r->ron[0];
@@ -303,27 +408,54 @@ register RAY  *r;
 }
 
 
-localhit(r, scene)		/* check for hit in the octree */
-register RAY  *r;
-register CUBE  *scene;
+extern void
+rayhit(			/* standard ray hit test */
+	OBJECT  *oset,
+	RAY  *r
+)
 {
+	OBJREC  *o;
+	int	i;
+
+	for (i = oset[0]; i > 0; i--) {
+		o = objptr(oset[i]);
+		if ((*ofun[o->otype].funp)(o, r))
+			r->robj = oset[i];
+	}
+}
+
+
+extern int
+localhit(		/* check for hit in the octree */
+	register RAY  *r,
+	register CUBE  *scene
+)
+{
+	OBJECT  cxset[MAXCSET+1];	/* set of checked objects */
 	FVECT  curpos;			/* current cube position */
 	int  sflags;			/* sign flags */
 	double  t, dt;
 	register int  i;
 
 	nrays++;			/* increment trace counter */
-
 	sflags = 0;
 	for (i = 0; i < 3; i++) {
 		curpos[i] = r->rorg[i];
-		if (r->rdir[i] > FTINY)
+		if (r->rdir[i] > 1e-7)
 			sflags |= 1 << i;
-		else if (r->rdir[i] < -FTINY)
+		else if (r->rdir[i] < -1e-7)
 			sflags |= 0x10 << i;
 	}
 	if (sflags == 0)
 		error(CONSISTENCY, "zero ray direction in localhit");
+					/* start off assuming nothing hit */
+	if (r->rmax > FTINY) {		/* except aft plane if one */
+		r->ro = &Aftplane;
+		r->rot = r->rmax;
+		for (i = 0; i < 3; i++)
+			r->rop[i] = r->rorg[i] + r->rot*r->rdir[i];
+	}
+					/* find global cube entrance point */
 	t = 0.0;
 	if (!incube(scene, curpos)) {
 					/* find distance to entry */
@@ -341,6 +473,8 @@ register CUBE  *scene;
 				t = dt;	/* farthest face is the one */
 		}
 		t += FTINY;		/* fudge to get inside cube */
+		if (t >= r->rot)	/* clipped already */
+			return(0);
 					/* advance position */
 		for (i = 0; i < 3; i++)
 			curpos[i] += r->rdir[i]*t;
@@ -348,16 +482,20 @@ register CUBE  *scene;
 		if (!incube(scene, curpos))	/* non-intersecting ray */
 			return(0);
 	}
-	return(raymove(curpos, sflags, r, scene) == RAYHIT);
+	cxset[0] = 0;
+	raymove(curpos, cxset, sflags, r, scene);
+	return((r->ro != NULL) & (r->ro != &Aftplane));
 }
 
 
 static int
-raymove(pos, dirf, r, cu)		/* check for hit as we move */
-FVECT  pos;			/* modified */
-int  dirf;			/* direction indicators to speed tests */
-register RAY  *r;
-register CUBE  *cu;
+raymove(		/* check for hit as we move */
+	FVECT  pos,			/* current position, modified herein */
+	OBJECT  *cxs,			/* checked objects, modified by checkhit */
+	int  dirf,			/* direction indicators to speed tests */
+	register RAY  *r,
+	register CUBE  *cu
+)
 {
 	int  ax;
 	double  dt, t;
@@ -383,7 +521,7 @@ register CUBE  *cu;
 		}
 		for ( ; ; ) {
 			cukid.cutree = octkid(cu->cutree, br);
-			if ((ax = raymove(pos,dirf,r,&cukid)) == RAYHIT)
+			if ((ax = raymove(pos,cxs,dirf,r,&cukid)) == RAYHIT)
 				return(RAYHIT);
 			sgn = 1 << ax;
 			if (sgn & dirf)			/* positive axis? */
@@ -402,7 +540,10 @@ register CUBE  *cu;
 		}
 		/*NOTREACHED*/
 	}
-	if (isfull(cu->cutree) && checkhit(r, cu))
+	if (isfull(cu->cutree)) {
+		if (checkhit(r, cu, cxs))
+			return(RAYHIT);
+	} else if (r->ro == &Aftplane && incube(cu, r->rop))
 		return(RAYHIT);
 					/* advance to next cube */
 	if (dirf&0x11) {
@@ -434,25 +575,55 @@ register CUBE  *cu;
 }
 
 
-static
-checkhit(r, cu)			/* check for hit in full cube */
-register RAY  *r;
-CUBE  *cu;
+static int
+checkhit(		/* check for hit in full cube */
+	register RAY  *r,
+	CUBE  *cu,
+	OBJECT  *cxs
+)
 {
 	OBJECT  oset[MAXSET+1];
-	register OBJREC  *o;
-	register int  i;
 
 	objset(oset, cu->cutree);
-	for (i = oset[0]; i > 0; i--) {
-		o = objptr(oset[i]);
-		if (o->lastrno == r->rno)		/* checked already? */
-			continue;
-		(*ofun[o->otype].funp)(o, r);
-		o->lastrno = r->rno;
-	}
-	if (r->ro == NULL)
+	checkset(oset, cxs);			/* avoid double-checking */
+
+	(*r->hitf)(oset, r);			/* test for hit in set */
+
+	if (r->robj == OVOID)
 		return(0);			/* no scores yet */
 
 	return(incube(cu, r->rop));		/* hit OK if in current cube */
+}
+
+
+static void
+checkset(		/* modify checked set and set to check */
+	register OBJECT  *os,			/* os' = os - cs */
+	register OBJECT  *cs			/* cs' = cs + os */
+)
+{
+	OBJECT  cset[MAXCSET+MAXSET+1];
+	register int  i, j;
+	int  k;
+					/* copy os in place, cset <- cs */
+	cset[0] = 0;
+	k = 0;
+	for (i = j = 1; i <= os[0]; i++) {
+		while (j <= cs[0] && cs[j] < os[i])
+			cset[++cset[0]] = cs[j++];
+		if (j > cs[0] || os[i] != cs[j]) {	/* object to check */
+			os[++k] = os[i];
+			cset[++cset[0]] = os[i];
+		}
+	}
+	if (!(os[0] = k))		/* new "to check" set size */
+		return;			/* special case */
+	while (j <= cs[0])		/* get the rest of cs */
+		cset[++cset[0]] = cs[j++];
+	if (cset[0] > MAXCSET)		/* truncate "checked" set if nec. */
+		cset[0] = MAXCSET;
+	/* setcopy(cs, cset); */	/* copy cset back to cs */
+	os = cset;
+	for (i = os[0]; i-- >= 0; )
+		*cs++ = *os++;
 }