svn merge -r 20822:21041 https://svn.blender.org/svnroot/bf-blender/branches/blender2...
[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 #include "RE_raytrace.h"
33 #include <float.h>
34
35 /* RayObject
36         
37         A ray object is everything where we can cast rays like:
38                 * a face/triangle
39                 * an octree
40                 * a bvh tree
41                 * an octree of bvh's
42                 * a bvh of bvh's
43         
44                 
45         All types of RayObjects can be created by implementing the
46         callbacks of the RayObject.
47
48         Due to high computing time evolved with casting on faces
49         there is a special type of RayObject (named RayFace)
50         which won't use callbacks like other generic nodes.
51         
52         In order to allow a mixture of RayFace+RayObjects,
53         all RayObjects must be 4byte aligned, allowing us to use the
54         2 least significant bits (with the mask 0x02) to define the
55         type of RayObject.
56         
57         This leads to 4 possible types of RayObject, but at the moment
58         only 2 are used:
59
60          addr&2  - type of object
61                 0       RayFace
62                 1               RayObject (generic with API callbacks)
63                 2               unused
64                 3               unused
65
66         0 was choosed to RayFace because thats the one where speed will be needed.
67         
68         You actually don't need to care about this if you are only using the API
69         described on RE_raytrace.h
70  */
71  
72 typedef struct RayFace
73 {
74         float *v1, *v2, *v3, *v4;
75         
76         void *ob;
77         void *face;
78         
79 } RayFace;
80
81 struct RayObject
82 {
83         struct RayObjectAPI *api;
84         
85 };
86
87 typedef int  (*RE_rayobject_raycast_callback)(RayObject *, Isect *);
88 typedef void (*RE_rayobject_add_callback)(RayObject *, RayObject *);
89 typedef void (*RE_rayobject_done_callback)(RayObject *);
90 typedef void (*RE_rayobject_free_callback)(RayObject *);
91 typedef void (*RE_rayobject_merge_bb_callback)(RayObject *, float *min, float *max);
92
93 typedef struct RayObjectAPI
94 {
95         RE_rayobject_raycast_callback   raycast;
96         RE_rayobject_add_callback               add;
97         RE_rayobject_done_callback              done;
98         RE_rayobject_free_callback              free;
99         RE_rayobject_merge_bb_callback  bb;
100         
101 } RayObjectAPI;
102
103 //TODO use intptr_t
104 #define RayObject_align(o)              ((RayObject*)(((int)o)&(~3)))
105 #define RayObject_unalign(o)    ((RayObject*)(((int)o)|1))
106 #define RayObject_isFace(o)             ((((int)o)&3) == 0)
107 #define RayObject_isAligned(o)  ((((int)o)&3) == 0)
108
109 /*
110  * Extend min/max coords so that the rayobject is inside them
111  */
112 void RE_rayobject_merge_bb(RayObject *ob, float *min, float *max);
113
114 /*
115  * This function differs from RE_rayobject_raycast
116  * RE_rayobject_intersect does NOT perform last-hit optimization
117  * So this is probably a function to call inside raytrace structures
118  */
119 int RE_rayobject_intersect(RayObject *r, Isect *i);
120
121 #define ISECT_EPSILON ((float)FLT_EPSILON)
122
123 #endif