*Changed RayObject_ calls to RE_rayobject to keep consistency on calls
[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 typedef struct RayFace
81 {
82         float v1[4], v2[4], v3[4], v4[3];
83         int quad;
84         void *ob;
85         void *face;
86         
87 } RayFace;
88
89 #define RE_rayface_isQuad(a) ((a)->quad)
90
91 struct RayObject
92 {
93         struct RayObjectAPI *api;
94 };
95
96
97 typedef int  (*RE_rayobject_raycast_callback)(RayObject *, Isect *);
98 typedef void (*RE_rayobject_add_callback)(RayObject *raytree, RayObject *rayobject);
99 typedef void (*RE_rayobject_done_callback)(RayObject *);
100 typedef void (*RE_rayobject_free_callback)(RayObject *);
101 typedef void (*RE_rayobject_merge_bb_callback)(RayObject *, float *min, float *max);
102 typedef float (*RE_rayobject_cost_callback)(RayObject *);
103 typedef void (*RE_rayobject_hint_bb_callback)(RayObject *, RayHint *, float *, float *);
104
105 typedef struct RayObjectAPI
106 {
107         RE_rayobject_raycast_callback   raycast;
108         RE_rayobject_add_callback               add;
109         RE_rayobject_done_callback              done;
110         RE_rayobject_free_callback              free;
111         RE_rayobject_merge_bb_callback  bb;
112         RE_rayobject_cost_callback              cost;
113         RE_rayobject_hint_bb_callback   hint_bb;
114         
115 } RayObjectAPI;
116
117 #define RE_rayobject_align(o)                           ((RayObject*)(((intptr_t)o)&(~3)))
118 #define RE_rayobject_unalignRayFace(o)          ((RayObject*)(((intptr_t)o)|1))
119 #define RE_rayobject_unalignRayAPI(o)           ((RayObject*)(((intptr_t)o)|2))
120
121 #define RE_rayobject_isAligned(o)       ((((intptr_t)o)&3) == 0)
122 #define RE_rayobject_isRayFace(o)       ((((intptr_t)o)&3) == 1)
123 #define RE_rayobject_isRayAPI(o)        ((((intptr_t)o)&3) == 2)
124
125 /*
126  * Loads a VlakRen on a RayFace
127  */
128 void RE_rayface_from_vlak(RayFace *face, ObjectInstanceRen *obi, VlakRen *vlr);
129
130 /*
131  * Extend min/max coords so that the rayobject is inside them
132  */
133 void RE_rayobject_merge_bb(RayObject *ob, float *min, float *max);
134
135 /*
136  * This function differs from RE_rayobject_raycast
137  * RE_rayobject_intersect does NOT perform last-hit optimization
138  * So this is probably a function to call inside raytrace structures
139  */
140 int RE_rayobject_intersect(RayObject *r, Isect *i);
141
142 /*
143  * Returns distance ray must travel to hit the given bounding box
144  * BB should be in format [2][3]
145  */
146 /* float RE_rayobject_bb_intersect(const Isect *i, const float *bb); */
147 int RE_rayobject_bb_intersect_test(const Isect *i, const float *bb); /* same as bb_intersect but doens't calculates distance */
148
149 /*
150  * Returns the expected cost of raycast on this node, primitives have a cost of 1
151  */
152 float RE_rayobject_cost(RayObject *r);
153
154
155 #define ISECT_EPSILON ((float)FLT_EPSILON)
156
157
158
159 #if !defined(_WIN32)
160
161 #include <sys/time.h>
162 #include <time.h>
163 #include <stdio.h>
164
165 #define BENCH(a,name)   \
166         do {                    \
167                 double _t1, _t2;                                \
168                 struct timeval _tstart, _tend;  \
169                 clock_t _clock_init = clock();  \
170                 gettimeofday ( &_tstart, NULL); \
171                 (a);                                                    \
172                 gettimeofday ( &_tend, NULL);   \
173                 _t1 = ( double ) _tstart.tv_sec + ( double ) _tstart.tv_usec/ ( 1000*1000 );    \
174                 _t2 = ( double )   _tend.tv_sec + ( double )   _tend.tv_usec/ ( 1000*1000 );    \
175                 printf("BENCH:%s: %fs (real) %fs (cpu)\n", #name, _t2-_t1, (float)(clock()-_clock_init)/CLOCKS_PER_SEC);\
176         } while(0)
177 #else
178
179 #define BENCH(a)        (a)
180
181 #endif
182
183
184
185 #ifdef __cplusplus
186 }
187 #endif
188
189
190 #endif