ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/common/bsdf.h
(Generate patch)

Comparing ray/src/common/bsdf.h (file contents):
Revision 2.4 by greg, Fri Feb 18 00:40:25 2011 UTC vs.
Revision 2.16 by greg, Sun Aug 21 22:38:12 2011 UTC

# Line 9 | Line 9
9   *      in the surface plane pointed to the right as seen from the front.
10   *      This means the Y-axis is "up" and the Z-axis is the surface normal.
11   *
12 < *  BSDF vectors always oriented away from surface, even when "incident."
12 > *  Note that we reverse the identification of "front" and "back" from
13 > *      the conventions used in WINDOW 6.  "Front" in our library points
14 > *      in the +Z direction, towards the interior of the space rather
15 > *      than the exterior.
16   *
17 + *  BSDF incident & exiting vectors are always oriented away from surface.
18 + *
19   *  Created by Greg Ward on 1/10/11.
20   *
21   */
# Line 25 | Line 30
30   extern "C" {
31   #endif
32  
33 + #ifdef _WIN32
34 + #define strcasecmp      stricmp
35 + #endif
36 +
37   #define SDnameLn        128             /* maximum BSDF name length */
38   #define SDmaxCh         3               /* maximum # spectral channels */
39  
40 < /* Component flags for SDsampBSDF() and SDhemiScatter() */
40 > /* Component flags for SDsampBSDF() and SDdirectHemi() */
41   #define SDsampR         0x1             /* include reflection */
42   #define SDsampT         0x2             /* include transmission */
43   #define SDsampS         0x3             /* include scattering (R+T) */
# Line 39 | Line 48 | extern "C" {
48   #define SDsampSpS       0x7             /* include non-diffuse scattering */
49   #define SDsampAll       0xF             /* include everything */
50  
51 < /* Projected solid angle query flags fos SDsizeBSDF() */
52 < #define SDqueryInc      0x1             /* query incoming vector */
53 < #define SDqueryOut      0x2             /* query outgoing vector */
54 < #define SDqueryMin      0x4             /* query minimum proj. solid angle */
46 < #define SDqueryMax      0x8             /* query maximum proj. solid angle */
51 > /* Projected solid angle query flags for SDsizeBSDF() */
52 > #define SDqueryVal      0x0             /* query single value */
53 > #define SDqueryMin      0x1             /* query minimum proj. solid angle */
54 > #define SDqueryMax      0x2             /* query maximum proj. solid angle */
55  
56   /* Error codes: normal return, out of memory, file i/o, file format, bad argument,
57                   bad data, unsupported feature, internal error, unknown error */
# Line 63 | Line 71 | typedef struct {
71   } SDValue;
72  
73   /* Cached, encoded, cumulative distribution for one incident (solid) angle */
74 < #define SD_CDIST_BASE   double          cTotal; \
75 <                        struct SDCDst_s *next
74 > #define SD_CDIST_BASE(styp)     double          cTotal; \
75 >                                struct styp     *next
76   typedef struct SDCDst_s {
77 <        SD_CDIST_BASE;                  /* base fields first */
77 >        SD_CDIST_BASE(SDCDst_s);        /* base fields first */
78          /* ...encoded distribution extends struct */
79   } SDCDst;
80  
# Line 77 | Line 85 | typedef struct SDComp_s        SDComponent;
85   typedef const struct {
86                                          /* return non-diffuse BSDF */
87          int             (*getBSDFs)(float coef[SDmaxCh], const FVECT outVec,
88 <                                    const FVECT inVec, const void *dist);
88 >                                    const FVECT inVec, SDComponent *sdc);
89                                          /* query non-diffuse PSA for vector */
90 <        SDError         (*queryProjSA)(double *psa, const FVECT vec,
91 <                                                int qflags, const void *dist);
90 >        SDError         (*queryProjSA)(double *psa, const FVECT v1,
91 >                                                const RREAL *v2, int qflags,
92 >                                                SDComponent *sdc);
93                                          /* get cumulative distribution */
94          const SDCDst    *(*getCDist)(const FVECT inVec, SDComponent *sdc);
95                                          /* sample cumulative distribution */
96 <        SDError         (*sampCDist)(FVECT outVec, double randX,
96 >        SDError         (*sampCDist)(FVECT ioVec, double randX,
97                                                  const SDCDst *cdp);
98                                          /* free a spectral BSDF component */
99          void            (*freeSC)(void *dist);
# Line 108 | Line 117 | typedef struct {
117  
118   /* Loaded BSDF data */
119   typedef struct {
120 <        char            name[SDnameLn]; /* BSDF name (derived from file) */
120 >        char            name[SDnameLn]; /* BSDF name (usu. derived from file) */
121          char            *mgf;           /* geometric description (if any) */
122          float           dim[3];         /* width, height, thickness (meters) */
123          SDValue         rLambFront;     /* diffuse front reflectance */
# Line 125 | Line 134 | extern struct SDCache_s {
134                          *next;
135   } *SDcacheList;         /* Global BSDF cache */
136  
137 < /* BSDF cache retention preference */
138 < #define SDretainNone    0               /* free unreferenced data (default) */
139 < #define SDretainBSDFs   1               /* keep loaded BSDFs in cache */
137 > /* BSDF cache retention policies */
138 > #define SDretainNone    0               /* free unreferenced BSDF data */
139 > #define SDretainBSDFs   1               /* keep loaded BSDFs in memory */
140   #define SDretainAll     2               /* also keep cumulative cache data */
141  
142 < extern int              SDretainSet;    /* set to SDretainNone by default */
142 > extern int              SDretainSet;    /* =SDretainNone by default */
143  
144   /*****************************************************************
145   * The following routines are less commonly used by applications.
146   */
147  
148 < #define SDisLoaded(sd)  ((sd)->rLambFront.spec.clock != 0)
148 > #define SDisLoaded(sd)  ((sd)->rLambFront.spec.flags != 0)
149  
150   /* Report an error to the indicated stream (in English) */
151   extern SDError          SDreportEnglish(SDError ec, FILE *fp);
# Line 150 | Line 159 | extern SDSpectralDF    *SDnewSpectralDF(int nc);
159   /* Free a spectral distribution function */
160   extern void             SDfreeSpectralDF(SDSpectralDF *df);
161  
162 < /* Initialize an unused BSDF struct (clears to zeroes) */
163 < extern void             SDclearBSDF(SDData *sd);
162 > /* Initialize an unused BSDF struct and assign name (calls SDclipName) */
163 > extern void             SDclearBSDF(SDData *sd, const char *fname);
164  
165   /* Load a BSDF struct from the given file (keeps name unchanged) */
166   extern SDError          SDloadFile(SDData *sd, const char *fname);
# Line 166 | Line 175 | extern SDData          *SDgetCache(const char *bname);
175   extern void             SDfreeCumulativeCache(SDSpectralDF *df);
176  
177   /* Sample an individual BSDF component */
178 < extern SDError          SDsampComponent(SDValue *sv, FVECT outVec,
179 <                                        const FVECT inVec, double randX,
171 <                                        SDComponent *sdc);
178 > extern SDError          SDsampComponent(SDValue *sv, FVECT ioVec,
179 >                                        double randX, SDComponent *sdc);
180  
181   /* Convert 1-dimensional random variable to N-dimensional */
182   extern void             SDmultiSamp(double t[], int n, double randX);
# Line 185 | Line 193 | void                   SDdisk2square(double sq[2], double diskx, doubl
193   */
194  
195   /* Get BSDF from cache (or load and cache it on first call) */
196 < /* Report any problems to stderr and return NULL on failure */
196 > /* Report any problems to stderr (in English), return NULL on failure */
197   extern const SDData     *SDcacheFile(const char *fname);
198  
199 < /* Free a BSDF from our cache (clear all if NULL) */
199 > /* Free a BSDF from our cache (clear all if sd==NULL) */
200   extern void             SDfreeCache(const SDData *sd);
201  
202 < /* Query projected solid angle resolution for non-diffuse BSDF direction */
203 < extern SDError          SDsizeBSDF(double *projSA, const FVECT vec,
204 <                                        int qflags, const SDData *sd);
202 > /* Query projected solid angle resolution for non-diffuse BSDF direction(s) */
203 > extern SDError          SDsizeBSDF(double *projSA, const FVECT v1,
204 >                                        const RREAL *v2, int qflags,
205 >                                        const SDData *sd);
206  
207   /* Return BSDF for the given incident and scattered ray vectors */
208   extern SDError          SDevalBSDF(SDValue *sv, const FVECT outVec,
# Line 204 | Line 213 | extern double          SDdirectHemi(const FVECT inVec,
213                                          int sflags, const SDData *sd);
214  
215   /* Sample BSDF direction based on the given random variable */
216 < extern SDError          SDsampBSDF(SDValue *sv, FVECT outVec,
208 <                                        const FVECT inVec, double randX,
216 > extern SDError          SDsampBSDF(SDValue *sv, FVECT ioVec, double randX,
217                                          int sflags, const SDData *sd);
218  
219   /*****************************************************************
# Line 213 | Line 221 | extern SDError         SDsampBSDF(SDValue *sv, FVECT outVec,
221   * Directions may be passed unnormalized to these routines.
222   */
223  
224 < /* Compute World->BSDF transform from surface normal and up (Y) vector */
224 > /* Compute World->BSDF transform from surface normal and BSDF up vector */
225   extern SDError          SDcompXform(RREAL vMtx[3][3], const FVECT sNrm,
226                                          const FVECT uVec);
227  
# Line 223 | Line 231 | extern SDError         SDinvXform(RREAL iMtx[3][3], RREAL vMt
231   /* Transform and normalize direction (column) vector */
232   extern SDError          SDmapDir(FVECT resVec, RREAL vMtx[3][3],
233                                          const FVECT inpVec);
234 +
235 + /* Application-specific BSDF loading routine (not part of our library) */
236 + extern SDData           *loadBSDF(char *name);
237 +
238 + /* Application-specific BSDF error translator (not part of our library) */
239 + extern char             *transSDError(SDError ec);
240  
241   /*################################################################*/
242   /*######### DEPRECATED DEFINITIONS AWAITING PERMANENT REMOVAL #######*/

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines