Added some test_break during the build process.
[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 0x03) to define the
61         type of RayObject.
62         
63         This leads to 4 possible types of RayObject:
64
65          addr&3  - type of object
66                 0               Self (reserved for each structure)
67                 1       RayFace (tri/quad primitive)
68                 2               RayObject (generic with API callbacks)
69                 3               VlakPrimitive
70                                 (vlak primitive - to be used when we have a vlak describing the data
71                                  eg.: on render code)
72
73         0 means it's reserved and has it own meaning inside each ray acceleration structure
74         (this way each structure can use the allign offset to determine if a node represents a
75          RayObject primitive, which can be used to save memory)
76
77         You actually don't need to care about this if you are only using the API
78         described on RE_raytrace.h
79  */
80
81 /* used to align a given ray object */
82 #define RE_rayobject_align(o)                           ((RayObject*)(((intptr_t)o)&(~3)))
83
84 /* used to unalign a given ray object */
85 #define RE_rayobject_unalignRayFace(o)          ((RayObject*)(((intptr_t)o)|1))
86 #define RE_rayobject_unalignRayAPI(o)           ((RayObject*)(((intptr_t)o)|2))
87 #define RE_rayobject_unalignVlakPrimitive(o)    ((RayObject*)(((intptr_t)o)|3))
88
89 /* used to test the type of ray object */
90 #define RE_rayobject_isAligned(o)       ((((intptr_t)o)&3) == 0)
91 #define RE_rayobject_isRayFace(o)       ((((intptr_t)o)&3) == 1)
92 #define RE_rayobject_isRayAPI(o)        ((((intptr_t)o)&3) == 2)
93 #define RE_rayobject_isVlakPrimitive(o) ((((intptr_t)o)&3) == 3)
94
95
96
97 /*
98  * This class is intended as a place holder for control, configuration of the rayobject like:
99  *      - stop building (TODO maybe when porting build to threads this could be implemented with some thread_cancel function)
100  *  - max number of threads and threads callback to use during build
101  *      ...
102  */     
103 typedef int  (*RE_rayobjectcontrol_test_break_callback)(void *data);
104 typedef struct RayObjectControl RayObjectControl;
105 struct RayObjectControl
106 {
107         void *data;
108         RE_rayobjectcontrol_test_break_callback test_break;     
109 };
110
111 /*
112  * This rayobject represents a generic object. With it's own callbacks for raytrace operations.
113  * It's suitable to implement things like LOD.
114  */
115 struct RayObject
116 {
117         struct RayObjectAPI *api;
118
119         struct RayObjectControl control;
120 };
121
122
123
124
125 typedef int  (*RE_rayobject_raycast_callback)(RayObject *, Isect *);
126 typedef void (*RE_rayobject_add_callback)(RayObject *raytree, RayObject *rayobject);
127 typedef void (*RE_rayobject_done_callback)(RayObject *);
128 typedef void (*RE_rayobject_free_callback)(RayObject *);
129 typedef void (*RE_rayobject_merge_bb_callback)(RayObject *, float *min, float *max);
130 typedef float (*RE_rayobject_cost_callback)(RayObject *);
131 typedef void (*RE_rayobject_hint_bb_callback)(RayObject *, RayHint *, float *, float *);
132
133 typedef struct RayObjectAPI
134 {
135         RE_rayobject_raycast_callback   raycast;
136         RE_rayobject_add_callback               add;
137         RE_rayobject_done_callback              done;
138         RE_rayobject_free_callback              free;
139         RE_rayobject_merge_bb_callback  bb;
140         RE_rayobject_cost_callback              cost;
141         RE_rayobject_hint_bb_callback   hint_bb;
142         
143 } RayObjectAPI;
144
145
146 /*
147  * This function differs from RE_rayobject_raycast
148  * RE_rayobject_intersect does NOT perform last-hit optimization
149  * So this is probably a function to call inside raytrace structures
150  */
151 int RE_rayobject_intersect(RayObject *r, Isect *i);
152
153 /*
154  * Returns distance ray must travel to hit the given bounding box
155  * BB should be in format [2][3]
156  */
157 /* float RE_rayobject_bb_intersect(const Isect *i, const float *bb); */
158 int RE_rayobject_bb_intersect_test(const Isect *i, const float *bb); /* same as bb_intersect but doens't calculates distance */
159
160 /*
161  * Returns the expected cost of raycast on this node, primitives have a cost of 1
162  */
163 float RE_rayobject_cost(RayObject *r);
164
165
166 /*
167  * Returns true if for some reason a heavy processing function should stop
168  * (eg.: user asked to stop during a tree a build)
169  */
170 int RE_rayobjectcontrol_test_break(RayObjectControl *c);
171
172
173 #define ISECT_EPSILON ((float)FLT_EPSILON)
174
175
176
177 #if !defined(_WIN32)
178
179 #include <sys/time.h>
180 #include <time.h>
181 #include <stdio.h>
182
183 #define BENCH(a,name)   \
184         do {                    \
185                 double _t1, _t2;                                \
186                 struct timeval _tstart, _tend;  \
187                 clock_t _clock_init = clock();  \
188                 gettimeofday ( &_tstart, NULL); \
189                 (a);                                                    \
190                 gettimeofday ( &_tend, NULL);   \
191                 _t1 = ( double ) _tstart.tv_sec + ( double ) _tstart.tv_usec/ ( 1000*1000 );    \
192                 _t2 = ( double )   _tend.tv_sec + ( double )   _tend.tv_usec/ ( 1000*1000 );    \
193                 printf("BENCH:%s: %fs (real) %fs (cpu)\n", #name, _t2-_t1, (float)(clock()-_clock_init)/CLOCKS_PER_SEC);\
194         } while(0)
195 #else
196
197 #define BENCH(a)        (a)
198
199 #endif
200
201
202
203 #ifdef __cplusplus
204 }
205 #endif
206
207
208 #endif