ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/ray.h
Revision: 2.57
Committed: Fri Nov 15 20:47:42 2024 UTC (5 months, 2 weeks ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 2.56: +5 -2 lines
Log Message:
feat(rpict): Experimental source skipping option with -DSSKIPOPT compile flag

File Contents

# Content
1 /* RCSid $Id: ray.h,v 2.56 2024/08/21 20:42:20 greg Exp $ */
2 /*
3 * ray.h - header file for routines using rays.
4 */
5 #ifndef _RAD_RAY_H_
6 #define _RAD_RAY_H_
7
8 #include "standard.h"
9 #include "octree.h"
10 #include "object.h"
11 #include "color.h"
12 #include "pmapparm.h"
13
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17
18 #ifndef RNUMBER
19 #define RNUMBER size_t /* ray counter (>= sizeof pointer) */
20 #endif
21
22 #define MAXDIM 32 /* maximum number of sampling dimensions */
23
24 /* ray type flags */
25 #define PRIMARY 01 /* original ray */
26 #define RSHADOW 02 /* reflected ray to light source */
27 #define REFLECTED 04 /* reflected ray */
28 #define REFRACTED 010 /* refracted (bent) ray */
29 #define TRANS 020 /* transmitted/transferred ray */
30 #define RAMBIENT 040 /* reflected diffuse interreflection */
31 #define RSPECULAR 0100 /* reflected specular */
32 #define TSHADOW 0200 /* transmitted shadow */
33 #define TAMBIENT 0400 /* transmitted ambient */
34 #define TSPECULAR 01000 /* transmitted specular */
35 #define SHADOW (RSHADOW|TSHADOW)
36 #define AMBIENT (RAMBIENT|TAMBIENT)
37 #define SPECULAR (RSPECULAR|TSPECULAR)
38
39 /* reflected ray types */
40 #define RAYREFL (RSHADOW|REFLECTED|RAMBIENT|RSPECULAR)
41
42 /* Arrange so double's come first for optimal alignment */
43 /* Pointers and long's come second for 64-bit mode */
44 /* Int's next (unknown length), then floats, followed by short's & char's */
45 typedef struct ray {
46 FVECT rorg; /* origin of ray */
47 FVECT rdir; /* normalized direction of ray */
48 RREAL rmax; /* maximum distance (aft clipping plane) */
49 RREAL rot; /* distance to object */
50 FVECT rop; /* intersection point */
51 FVECT ron; /* intersection surface normal */
52 RREAL rod; /* -DOT(rdir, ron) */
53 RREAL uv[2]; /* local coordinates */
54 FVECT pert; /* surface normal perturbation */
55 RREAL rmt; /* returned mirrored ray length */
56 RREAL rxt; /* returned unmirrored ray length */
57 const struct ray *parent; /* ray this originated from */
58 OBJECT *clipset; /* set of objects currently clipped */
59 OBJECT *newcset; /* next clipset, used for transmission */
60 void (*revf)(struct ray *); /* ray evaluation function */
61 void (*hitf)(OBJECT *, struct ray *); /* custom hit test */
62 OBJREC *ro; /* intersected object (one with material) */
63 FULLXF *rox; /* object transformation */
64 int *slights; /* list of lights to test for scattering */
65 RNUMBER rno; /* unique ray number */
66 OBJECT robj; /* intersected object number */
67 int rsrc; /* source we're aiming for (or ones to skip) */
68 #ifdef SSKIPOPT
69 float scorr; /* correction factor for included sources */
70 #endif
71 float rweight; /* cumulative weight (for termination) */
72 float gecc; /* scattering eccentricity coefficient */
73 SCOLOR rcoef; /* contribution coefficient w.r.t. parent */
74 SCOLOR pcol; /* pattern color */
75 SCOLOR mcol; /* mirrored color contribution */
76 SCOLOR rcol; /* returned radiance value */
77 COLOR cext; /* medium extinction coefficient */
78 COLOR albedo; /* medium scattering albedo */
79 short rflips; /* surface orientation has been reversed */
80 short rlvl; /* number of reflections for this ray */
81 short rtype; /* ray type */
82 short crtype; /* cumulative ray type */
83 } RAY;
84
85 #define rayvalue(r) (*(r)->revf)(r)
86
87 #define thrudir(r,v) ((r)->rod > 0 ^ DOT((r)->ron,v) > 0)
88
89 #define raydistance(r) (pbright((r)->mcol) > 0.5*pbright((r)->rcol) ? \
90 (r)->rmt : (r)->rxt)
91
92 #define rayreorient(r) if ((r)->rflips & 1) flipsurface(r); else
93
94 extern char VersionID[]; /* Radiance version ID string */
95 extern char RFeatureList[]; /* newline-separated feature list */
96
97 extern CUBE thescene; /* our scene */
98 extern OBJECT nsceneobjs; /* number of objects in our scene */
99
100 extern RNUMBER raynum; /* next ray ID */
101 extern RNUMBER nrays; /* total rays traced so far */
102
103 extern OBJREC Lamb; /* a Lambertian surface */
104 extern OBJREC Aftplane; /* aft clipping object */
105
106 extern void (*trace)(RAY*); /* global trace reporting callback */
107
108 extern int dimlist[]; /* dimension list for distribution */
109 extern int ndims; /* number of dimensions so far */
110 extern int samplendx; /* index for this sample */
111
112 extern int do_irrad; /* compute irradiance? */
113
114 extern int rand_samp; /* pure Monte Carlo sampling? */
115
116 extern double dstrsrc; /* square source distribution */
117 extern double shadthresh; /* shadow threshold */
118 extern double shadcert; /* shadow testing certainty */
119 extern int directrelay; /* number of source relays */
120 extern int vspretest; /* virtual source pretest density */
121 extern int directvis; /* light sources visible to eye? */
122 extern double srcsizerat; /* maximum source size/dist. ratio */
123
124 extern double specthresh; /* specular sampling threshold */
125 extern double specjitter; /* specular sampling jitter */
126
127 extern COLOR cextinction; /* global extinction coefficient */
128 extern COLOR salbedo; /* global scattering albedo */
129 extern double seccg; /* global scattering eccentricity */
130 extern double ssampdist; /* scatter sampling distance */
131
132 extern int backvis; /* back face visibility */
133
134 extern int maxdepth; /* maximum recursion depth */
135 extern double minweight; /* minimum ray weight */
136
137 extern char *ambfile; /* ambient file name */
138 extern COLOR ambval; /* ambient value */
139 extern int ambvwt; /* initial weight for ambient value */
140 extern double ambacc; /* ambient accuracy */
141 extern int ambres; /* ambient resolution */
142 extern int ambdiv; /* ambient divisions */
143 extern int ambssamp; /* ambient super-samples */
144 extern int ambounce; /* ambient bounces */
145 extern char *amblist[]; /* ambient include/exclude list */
146 extern int ambincl; /* include == 1, exclude == 0 */
147
148 extern int ray_pnprocs; /* number of child processes */
149 extern int ray_pnidle; /* number of idle processes */
150
151 #ifndef AMBLLEN
152 #define AMBLLEN 512 /* max. ambient list length */
153 #endif
154 #define AMBWORD 12 /* average word length */
155
156 typedef struct { /* rendering parameter holder */
157 int do_irrad;
158 int rand_samp;
159 double dstrsrc;
160 double shadthresh;
161 double shadcert;
162 int directrelay;
163 int vspretest;
164 int directvis;
165 double srcsizerat;
166 COLOR cextinction;
167 COLOR salbedo;
168 double seccg;
169 double ssampdist;
170 double specthresh;
171 double specjitter;
172 int backvis;
173 int maxdepth;
174 double minweight;
175 char ambfile[512];
176 COLOR ambval;
177 int ambvwt;
178 double ambacc;
179 int ambres;
180 int ambdiv;
181 int ambssamp;
182 int ambounce;
183 int ambincl;
184 short amblndx[AMBLLEN+1];
185 char amblval[AMBLLEN*AMBWORD];
186
187 /* PMAP: photon mapping parameters */
188 PhotonMapParams pmapParams [NUM_PMAP_TYPES];
189 } RAYPARAMS;
190
191 #define rpambmod(p,i) ( (i)>=AMBLLEN||(p)->amblndx[i]<0 ? \
192 (char *)NULL : (p)->amblval+(p)->amblndx[i] )
193
194 /* defined in duphead.c */
195 extern void headclean(void);
196 extern void openheader(void);
197 extern void dupheader(void);
198 /* defined in persist.c */
199 extern void persistfile(char *pfn);
200 extern void pfdetach(void);
201 extern void pfclean(void);
202 extern void pflock(int lf);
203 extern void pfhold(void);
204 extern void io_process(void);
205 /* defined in freeobjmem.c */
206 extern int free_objs(OBJECT on, OBJECT no);
207 extern void free_objmem(void);
208 /* defined in preload.c */
209 extern int load_os(OBJREC *op);
210 extern void preload_objs(void);
211 extern char *shm_boundary;
212 extern void cow_memshare(void);
213 extern void cow_doneshare(void);
214 /* defined in raycalls.c */
215 extern void ray_init(char *otnm);
216 extern void ray_trace(RAY *r);
217 extern void ray_done(int freall);
218 extern void ray_save(RAYPARAMS *rp);
219 extern void ray_restore(RAYPARAMS *rp);
220 extern void ray_defaults(RAYPARAMS *rp);
221 /* defined in raypcalls.c */
222 extern void ray_pinit(char *otnm, int nproc);
223 extern int ray_psend(RAY *r);
224 extern int ray_pqueue(RAY *r);
225 extern int ray_presult(RAY *r, int poll);
226 extern void ray_pdone(int freall);
227 extern void ray_popen(int nadd);
228 extern void ray_pclose(int nsub);
229 /* defined in ray_fifo.c */
230 extern int (*ray_fifo_out)(RAY *r);
231 extern int ray_fifo_in(RAY *r);
232 extern int ray_fifo_flush(void);
233 /* defined in raytrace.c */
234 extern int rayorigin(RAY *r, int rt, const RAY *ro, const SCOLOR rc);
235 extern void rayclear(RAY *r);
236 extern void raytrace(RAY *r);
237 extern int rayreject(OBJREC *o, RAY *r, double t, double rod);
238 extern void rayhit(OBJECT *oset, RAY *r);
239 extern void raycont(RAY *r);
240 extern void raytrans(RAY *r);
241 extern int raytirrad(OBJREC *m, RAY *r);
242 extern int rayshade(RAY *r, int mod);
243 extern void rayparticipate(RAY *r);
244 extern void raytexture(RAY *r, OBJECT mod);
245 extern int raymixture(RAY *r, OBJECT fore, OBJECT back, double coef);
246 extern void raycontrib(SCOLOR rc, const RAY *r, int flags);
247 extern double raydist(const RAY *r, int flags);
248 extern double raynormal(FVECT norm, RAY *r);
249 extern void newrayxf(RAY *r);
250 extern void flipsurface(RAY *r);
251 extern int localhit(RAY *r, CUBE *scene);
252 /* defined in renderopts.c */
253 extern int feature_status(int ac, char *av[]);
254 extern int getrenderopt(int ac, char *av[]);
255 extern void print_rdefaults(void);
256 /* defined in srcdraw.c */
257 extern void init_drawsources(int rad);
258 extern void drawsources(COLORV *pic[], RGBPRIMP primp, float *zbf[],
259 int x0, int xsiz, int y0, int ysiz);
260 /* defined in rt/initotypes.c */
261 extern void initotypes(void);
262 /* module main procedures */
263 extern void rtrace(char *fname, int nproc);
264 extern const char *formstr(int f);
265 extern void rview(void);
266 extern void rpict(int seq, char *pout, char *zout, char *prvr);
267
268 #ifdef __FAST_MATH__
269 #define checknorm(vn) (void)normalize(vn)
270 #else
271 #define checknorm(vn)
272 #endif
273
274 #ifdef __cplusplus
275 }
276 #endif
277 #endif /* _RAD_RAY_H_ */
278