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