ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/ray.h
Revision: 2.20
Committed: Mon Jul 14 22:24:00 2003 UTC (20 years, 9 months ago) by schorsch
Content type: text/plain
Branch: MAIN
Changes since 2.19: +5 -7 lines
Log Message:
Instrumented headers against multiple inclusion and for use from C++.
Moved includes in headers out of "C" scope.

File Contents

# User Rev Content
1 schorsch 2.20 /* RCSid $Id: ray.h,v 2.19 2003/06/27 06:53:22 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 1.1
13 schorsch 2.20 #ifdef __cplusplus
14     extern "C" {
15     #endif
16 greg 1.1
17 greg 2.6 #define MAXDIM 32 /* maximum number of dimensions */
18    
19 greg 1.1 /* ray type flags */
20     #define PRIMARY 01 /* original ray */
21     #define SHADOW 02 /* ray to light source */
22     #define REFLECTED 04 /* reflected ray */
23     #define REFRACTED 010 /* refracted (bent) ray */
24     #define TRANS 020 /* transmitted/transferred ray */
25     #define AMBIENT 040 /* ray scattered for interreflection */
26 greg 2.2 #define SPECULAR 0100 /* ray scattered for specular */
27 greg 1.1
28     /* reflected ray types */
29 greg 2.2 #define RAYREFL (SHADOW|REFLECTED|AMBIENT|SPECULAR)
30 greg 1.1
31     typedef struct ray {
32 greg 2.3 unsigned long rno; /* unique ray number */
33 greg 2.12 int rlvl; /* number of reflections for this ray */
34     float rweight; /* cumulative weight of this ray */
35     short rtype; /* ray type */
36     short crtype; /* cumulative ray type */
37 greg 1.1 struct ray *parent; /* ray this originated from */
38 greg 2.12 FVECT rorg; /* origin of ray */
39     FVECT rdir; /* normalized direction of ray */
40     double rmax; /* maximum distance (aft clipping plane) */
41     int rsrc; /* source we're aiming for */
42     OBJECT *clipset; /* set of objects currently clipped */
43     OBJECT *newcset; /* next clipset, used for transmission */
44     void (*revf)(); /* evaluation function for this ray */
45 greg 2.14 void (*hitf)(); /* custom hit test for this traversal */
46 greg 2.11 OBJECT robj; /* intersected object number */
47 greg 2.12 OBJREC *ro; /* intersected object (one with material) */
48     double rot; /* distance to object */
49     FVECT rop; /* intersection point */
50     FVECT ron; /* intersection surface normal */
51     double rod; /* -DOT(rdir, ron) */
52     FULLXF *rox; /* object transformation */
53 schorsch 2.18 RREAL uv[2]; /* local coordinates */
54 greg 2.12 FVECT pert; /* surface normal perturbation */
55     COLOR pcol; /* pattern color */
56     COLOR rcol; /* returned ray value */
57     double rt; /* returned effective ray length */
58     COLOR cext; /* medium extinction coefficient */
59     COLOR albedo; /* medium scattering albedo */
60     float gecc; /* scattering eccentricity coefficient */
61     int *slights; /* list of lights to test for scattering */
62 greg 1.1 } RAY;
63    
64 greg 2.12 #define rayvalue(r) (*(r)->revf)(r)
65    
66     extern char VersionID[]; /* Radiance version ID string */
67 greg 1.6
68 greg 2.12 extern CUBE thescene; /* our scene */
69     extern OBJECT nsceneobjs; /* number of objects in our scene */
70 greg 2.5
71 greg 2.12 extern unsigned long raynum; /* next ray ID */
72     extern unsigned long nrays; /* total rays traced so far */
73 greg 1.5
74 greg 2.12 extern OBJREC Lamb; /* a Lambertian surface */
75     extern OBJREC Aftplane; /* aft clipping object */
76    
77     extern void (*trace)(); /* global trace reporting callback */
78    
79     extern int dimlist[]; /* dimension list for distribution */
80     extern int ndims; /* number of dimensions so far */
81     extern int samplendx; /* index for this sample */
82    
83     extern int ray_savesiz; /* size of parameter save buffer */
84    
85     extern int do_irrad; /* compute irradiance? */
86    
87     extern double dstrsrc; /* square source distribution */
88     extern double shadthresh; /* shadow threshold */
89     extern double shadcert; /* shadow testing certainty */
90     extern int directrelay; /* number of source relays */
91     extern int vspretest; /* virtual source pretest density */
92     extern int directvis; /* light sources visible to eye? */
93     extern double srcsizerat; /* maximum source size/dist. ratio */
94    
95     extern double specthresh; /* specular sampling threshold */
96     extern double specjitter; /* specular sampling jitter */
97    
98     extern COLOR cextinction; /* global extinction coefficient */
99     extern COLOR salbedo; /* global scattering albedo */
100     extern double seccg; /* global scattering eccentricity */
101     extern double ssampdist; /* scatter sampling distance */
102    
103     extern int backvis; /* back face visibility */
104    
105     extern int maxdepth; /* maximum recursion depth */
106     extern double minweight; /* minimum ray weight */
107    
108     extern char *ambfile; /* ambient file name */
109     extern COLOR ambval; /* ambient value */
110     extern int ambvwt; /* initial weight for ambient value */
111     extern double ambacc; /* ambient accuracy */
112     extern int ambres; /* ambient resolution */
113     extern int ambdiv; /* ambient divisions */
114     extern int ambssamp; /* ambient super-samples */
115     extern int ambounce; /* ambient bounces */
116     extern char *amblist[]; /* ambient include/exclude list */
117     extern int ambincl; /* include == 1, exclude == 0 */
118    
119     extern int ray_pnprocs; /* number of child processes */
120     extern int ray_pnidle; /* number of idle processes */
121    
122     #define AMBLLEN 128 /* max. ambient list length */
123     #define AMBWORD 8 /* average word length */
124    
125     typedef struct { /* rendering parameter holder */
126     int do_irrad;
127     double dstrsrc;
128     double shadthresh;
129     double shadcert;
130     int directrelay;
131     int vspretest;
132     int directvis;
133     double srcsizerat;
134     COLOR cextinction;
135     COLOR salbedo;
136     double seccg;
137     double ssampdist;
138     double specthresh;
139     double specjitter;
140     int backvis;
141     int maxdepth;
142     double minweight;
143     char ambfile[512];
144     COLOR ambval;
145     int ambvwt;
146     double ambacc;
147     int ambres;
148     int ambdiv;
149     int ambssamp;
150     int ambounce;
151     int ambincl;
152     short amblndx[AMBLLEN+1];
153     char amblval[AMBLLEN*AMBWORD];
154     } RAYPARAMS;
155    
156     #define rpambmod(p,i) ( (i)>=AMBLLEN||(p)->amblndx[i]<0 ? \
157     (char *)NULL : (p)->amblval+(p)->amblndx[i] )
158    
159     /* defined in duphead.c */
160     extern void headclean(void);
161     extern void openheader(void);
162     extern void dupheader(void);
163     extern void pfdetach(void);
164     extern void pfclean(void);
165     extern void pflock(int lf);
166     extern void pfhold(void);
167     extern void io_process(void);
168     /* defined in freeobjmem.c */
169     extern int free_objs(OBJECT on, OBJECT no);
170     extern void free_objmem(void);
171     /* defined in preload.c */
172     extern int load_os(OBJREC *op);
173     extern void preload_objs(void);
174     /* defined in raycalls.c */
175     extern void ray_init(char *otnm);
176     extern void ray_trace(RAY *r);
177     extern void ray_done(int freall);
178     extern void ray_save(RAYPARAMS *rp);
179     extern void ray_restore(RAYPARAMS *rp);
180     extern void ray_defaults(RAYPARAMS *rp);
181     /* defined in raypcalls.c */
182     extern void ray_pinit(char *otnm, int nproc);
183     extern void ray_psend(RAY *r);
184     extern int ray_pqueue(RAY *r);
185     extern int ray_presult(RAY *r, int poll);
186     extern void ray_pdone(int freall);
187     extern void ray_popen(int nadd);
188     extern void ray_pclose(int nsub);
189     /* defined in raytrace.c */
190     extern int rayorigin(RAY *r, RAY *ro, int rt, double rw);
191     extern void rayclear(RAY *r);
192     extern void raytrace(RAY *r);
193 greg 2.14 extern void rayhit(OBJECT *oset, RAY *r);
194 greg 2.12 extern void raycont(RAY *r);
195     extern void raytrans(RAY *r);
196     extern int rayshade(RAY *r, int mod);
197     extern void rayparticipate(RAY *r);
198 greg 2.16 extern void raytexture(RAY *r, OBJECT mod);
199 greg 2.12 extern int raymixture(RAY *r, OBJECT fore, OBJECT back, double coef);
200     extern double raydist(RAY *r, int flags);
201     extern double raynormal(FVECT norm, RAY *r);
202     extern void newrayxf(RAY *r);
203     extern void flipsurface(RAY *r);
204     extern int localhit(RAY *r, CUBE *scene);
205     /* defined in renderopts.c */
206     extern int getrenderopt(int ac, char *av[]);
207     extern void print_rdefaults(void);
208     /* defined in srcdraw.c */
209     extern void drawsources(COLOR *pic[], float *zbf[],
210     int x0, int xsiz, int y0, int ysiz);
211     /* module main procedures */
212     extern void rtrace(char *fname);
213     extern void rview(void);
214     extern void rpict(int seq, char *pout, char *zout, char *prvr);
215 greg 1.6
216 schorsch 2.17
217     #ifdef __cplusplus
218     }
219 greg 2.12 #endif
220 schorsch 2.17 #endif /* _RAD_RAY_H_ */
221