doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / render / intern / raytrace / rayobject_hint.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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
30 #ifndef RE_RAYTRACE_RAYOBJECT_HINT_H
31 #define RE_RAYTRACE_RAYOBJECT_HINT_H
32
33 #define HINT_RECURSE     1
34 #define HINT_ACCEPT              0
35 #define HINT_DISCARD    -1
36
37 struct HintBB
38 {
39         float bb[6];
40 };
41
42 inline int hint_test_bb(HintBB *obj, float *Nmin, float *Nmax)
43 {
44         if(bb_fits_inside( Nmin, Nmax, obj->bb, obj->bb+3 ) )
45                 return HINT_RECURSE;
46         else
47                 return HINT_ACCEPT;
48 }
49 /*
50 struct HintFrustum
51 {
52         float co[3];
53         float no[4][3];
54 };
55
56 inline int hint_test_bb(HintFrustum &obj, float *Nmin, float *Nmax)
57 {
58         //if frustum inside BB
59         {
60                 return HINT_RECURSE;
61         }
62         //if BB outside frustum
63         {
64                 return HINT_DISCARD;
65         }
66         
67         return HINT_ACCEPT;
68 }
69 */
70
71 #endif
72