no need to calculate the exact nearest distance if we are not using any heuristic...
[blender-staging.git] / source / blender / render / intern / include / rayobject.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): AndrĂ© Pinto.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef RE_RAYOBJECT_H
30 #define RE_RAYOBJECT_H
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 #include "RE_raytrace.h"
37 #include "render_types.h"
38 #include <float.h>
39
40
41 /* RayObject
42         
43         A ray object is everything where we can cast rays like:
44                 * a face/triangle
45                 * an octree
46                 * a bvh tree
47                 * an octree of bvh's
48                 * a bvh of bvh's
49         
50                 
51         All types of RayObjects can be created by implementing the
52         callbacks of the RayObject.
53
54         Due to high computing time evolved with casting on faces
55         there is a special type of RayObject (named RayFace)
56         which won't use callbacks like other generic nodes.
57         
58         In order to allow a mixture of RayFace+RayObjects,
59         all RayObjects must be 4byte aligned, allowing us to use the
60         2 least significant bits (with the mask 0x02) to define the
61         type of RayObject.
62         
63         This leads to 4 possible types of RayObject, but at the moment
64         only 2 are used:
65
66          addr&2  - type of object
67                 0               Self (reserved for each structure)
68                 1       RayFace
69                 2               RayObject (generic with API callbacks)
70                 3               unused
71
72         0 means it's reserved and has it own meaning inside each ray acceleration structure
73         (this way each structure can use the allign offset to determine if a node represents a
74          RayObject primitive, which can be used to save memory)
75
76         You actually don't need to care about this if you are only using the API
77         described on RE_raytrace.h
78  */
79
80 /* defines where coordinates of rayface primitives are stored */
81 //#define RE_RAYFACE_COORDS_LOCAL
82 //#define RE_RAYFACE_COORDS_POINTER
83 #define RE_RAYFACE_COORDS_VLAKREN
84  
85 typedef struct RayFace
86 {
87 #ifdef RE_RAYFACE_COORDS_LOCAL
88         float v1[4], v2[4], v3[4], v4[3];
89         int quad;
90         void *ob;
91         void *face;
92 #elif defined(RE_RAYFACE_COORDS_POINTER)
93         float *v1, *v2, *v3, *v4;
94         void *ob;
95         void *face;
96 #elif defined(RE_RAYFACE_COORDS_VLAKREN)
97         void *ob;
98         void *face;
99 #endif
100         
101 } RayFace;
102
103 #ifdef RE_RAYFACE_COORDS_LOCAL
104 #       define RE_rayface_isQuad(a) ((a)->quad)
105 #elif defined(RE_RAYFACE_COORDS_POINTER)
106 #       define RE_rayface_isQuad(a) ((a)->v4)
107 #elif defined(RE_RAYFACE_COORDS_VLAKREN)
108 #       define RE_rayface_isQuad(a) ((((VlakRen*)((a)->face))->v4) != NULL)
109 #endif
110
111
112 struct RayObject
113 {
114         struct RayObjectAPI *api;
115 };
116
117
118 typedef int  (*RE_rayobject_raycast_callback)(RayObject *, Isect *);
119 typedef void (*RE_rayobject_add_callback)(RayObject *raytree, RayObject *rayobject);
120 typedef void (*RE_rayobject_done_callback)(RayObject *);
121 typedef void (*RE_rayobject_free_callback)(RayObject *);
122 typedef void (*RE_rayobject_merge_bb_callback)(RayObject *, float *min, float *max);
123 typedef float (*RE_rayobject_cost_callback)(RayObject *);
124 typedef void (*RE_rayobject_hint_bb_callback)(RayObject *, RayHint *, float *, float *);
125
126 typedef struct RayObjectAPI
127 {
128         RE_rayobject_raycast_callback   raycast;
129         RE_rayobject_add_callback               add;
130         RE_rayobject_done_callback              done;
131         RE_rayobject_free_callback              free;
132         RE_rayobject_merge_bb_callback  bb;
133         RE_rayobject_cost_callback              cost;
134         RE_rayobject_hint_bb_callback   hint_bb;
135         
136 } RayObjectAPI;
137
138 #define RayObject_align(o)                              ((RayObject*)(((intptr_t)o)&(~3)))
139 #define RayObject_unalignRayFace(o)             ((RayObject*)(((intptr_t)o)|1))
140 #define RayObject_unalignRayAPI(o)              ((RayObject*)(((intptr_t)o)|2))
141
142 #define RayObject_isAligned(o)  ((((intptr_t)o)&3) == 0)
143 #define RayObject_isRayFace(o)  ((((intptr_t)o)&3) == 1)
144 #define RayObject_isRayAPI(o)   ((((intptr_t)o)&3) == 2)
145
146 /*
147  * Loads a VlakRen on a RayFace
148  */
149 void RE_rayface_from_vlak(RayFace *face, ObjectInstanceRen *obi, VlakRen *vlr);
150
151 /*
152  * Extend min/max coords so that the rayobject is inside them
153  */
154 void RE_rayobject_merge_bb(RayObject *ob, float *min, float *max);
155
156 /*
157  * This function differs from RE_rayobject_raycast
158  * RE_rayobject_intersect does NOT perform last-hit optimization
159  * So this is probably a function to call inside raytrace structures
160  */
161 int RE_rayobject_intersect(RayObject *r, Isect *i);
162
163 /*
164  * Returns distance ray must travel to hit the given bounding box
165  * BB should be in format [2][3]
166  */
167 /* float RE_rayobject_bb_intersect(const Isect *i, const float *bb); */
168 int RE_rayobject_bb_intersect_test(const Isect *i, const float *bb); /* same as bb_intersect but doens't calculates distance */
169
170 /*
171  * Returns the expected cost of raycast on this node, primitives have a cost of 1
172  */
173 float RE_rayobject_cost(RayObject *r);
174
175
176 #define ISECT_EPSILON ((float)FLT_EPSILON)
177
178
179
180 #if !defined(_WIN32)
181
182 #include <sys/time.h>
183 #include <time.h>
184 #include <stdio.h>
185
186 #define BENCH(a,name)   \
187         do {                    \
188                 double _t1, _t2;                                \
189                 struct timeval _tstart, _tend;  \
190                 clock_t _clock_init = clock();  \
191                 gettimeofday ( &_tstart, NULL); \
192                 (a);                                                    \
193                 gettimeofday ( &_tend, NULL);   \
194                 _t1 = ( double ) _tstart.tv_sec + ( double ) _tstart.tv_usec/ ( 1000*1000 );    \
195                 _t2 = ( double )   _tend.tv_sec + ( double )   _tend.tv_usec/ ( 1000*1000 );    \
196                 printf("BENCH:%s: %fs (real) %fs (cpu)\n", #name, _t2-_t1, (float)(clock()-_clock_init)/CLOCKS_PER_SEC);\
197         } while(0)
198 #else
199
200 #define BENCH(a)        (a)
201
202 #endif
203
204
205
206 #ifdef __cplusplus
207 }
208 #endif
209
210
211 #endif