ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/ray.h
Revision: 2.49
Committed: Mon Feb 6 22:40:21 2023 UTC (15 months, 1 week ago) by greg
Content type: text/plain
Branch: MAIN
Changes since 2.48: +3 -3 lines
Log Message:
refactor: Changed some char* args to const char* to avoid warnings

File Contents

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