doxygen: bge scenegraph and videotexture
[blender.git] / source / gameengine / SceneGraph / SG_BBox.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) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file SG_BBox.h
31  *  \ingroup bgesg
32  *  \brief Bounding Box
33  */
34  
35 #ifndef __SG_BBOX_H__
36 #define __SG_BBOX_H__
37  
38 #include "MT_Scalar.h"
39 #include "MT_Point3.h"
40 #include "MT_Vector3.h"
41 #include "MT_Transform.h"
42
43 #include <vector> 
44
45 #ifdef WITH_CXX_GUARDEDALLOC
46 #include "MEM_guardedalloc.h"
47 #endif
48
49 class SG_Node;
50
51 /**
52  * Bounding box class.
53  * Holds the minimum and maximum axis aligned points of a node's bounding box,
54  * in world coordinates.
55  */
56 class SG_BBox
57 {
58         MT_Point3 m_min;
59         MT_Point3 m_max;
60 public:
61         typedef enum { INSIDE, INTERSECT, OUTSIDE } intersect;
62         SG_BBox();
63         SG_BBox(const MT_Point3 &min, const MT_Point3 &max);
64         SG_BBox(const SG_BBox &other, const MT_Transform &world);
65         SG_BBox(const SG_BBox &other);
66         ~SG_BBox();
67
68         /**
69          * Enlarges the bounding box to contain the specified point.
70          */
71         SG_BBox& operator +=(const MT_Point3 &point);
72         /**
73          * Enlarges the bounding box to contain the specified bound box.
74          */
75         SG_BBox& operator +=(const SG_BBox &bbox);
76         
77         SG_BBox operator + (const SG_BBox &bbox2) const;
78 #if 0
79         /**
80          * Translates the bounding box.
81          */
82         void translate(const MT_Vector3 &dx);
83         /**
84          * Scales the bounding box about the optional point.
85          */
86         void scale(const MT_Vector3 &size, const MT_Point3 &point = MT_Point3(0., 0., 0.));
87 #endif
88         SG_BBox transform(const MT_Transform &world) const;
89         /**
90          * Computes the volume of the bounding box.
91          */
92         MT_Scalar volume() const;
93         
94         /**
95          * Test if the given point is inside this bounding box.
96          */
97         bool inside(const MT_Point3 &point) const;
98         
99         /**
100          * Test if the given bounding box is inside this bounding box.
101          */
102         bool inside(const SG_BBox &other) const;
103
104         /**
105          * Test if the given bounding box is outside this bounding box.
106          */
107         bool outside(const SG_BBox &other) const;
108         
109         /**
110          * Test if the given bounding box intersects this bounding box.
111          */
112         bool intersects(const SG_BBox &other) const;
113         
114         /**
115          * Test the given bounding box with this bounding box.
116          */
117         intersect test(const SG_BBox &other) const;
118         
119         /**
120          * Get the eight points that define this bounding box.
121          *
122          * @param world a world transform to apply to the produced points bounding box.
123          */
124         void get(MT_Point3 *box, const MT_Transform &world) const;
125         /**
126          * Get the eight points that define this axis aligned bounding box.
127          * This differs from SG_BBox::get() in that the produced box will be world axis aligned.
128          * The maximum & minimum local points will be transformed *before* splitting to 8 points.
129          * @param world a world transform to be applied.
130          */
131         void getaa(MT_Point3 *box, const MT_Transform &world) const;
132         
133         void getmm(MT_Point3 *box, const MT_Transform &world) const;
134
135         void split(SG_BBox &left, SG_BBox &right) const;
136         
137         friend class SG_Tree;
138
139
140 #ifdef WITH_CXX_GUARDEDALLOC
141 public:
142         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:SG_BBox"); }
143         void operator delete( void *mem ) { MEM_freeN(mem); }
144 #endif
145 };
146
147 #endif /* __SG_BBOX_H__ */