doxygen: intern/boolop tagged
[blender.git] / intern / boolop / intern / BOP_MathUtils.h
1 /*
2  *
3  * $Id$
4  *
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): Marc Freixas, Ken Hughes
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30
31 /** \file boolop/intern/BOP_MathUtils.h
32  *  \ingroup boolopintern
33  */
34
35  
36 #ifndef BOP_MATHUTILS_H
37 #define BOP_MATHUTILS_H
38
39 #include <math.h>
40 #include <float.h>
41 #include "MT_Point3.h"
42 #include "MT_Plane3.h"
43
44 /* define this to give better precision comparisons */
45 #define VAR_EPSILON
46
47 #ifndef VAR_EPSILON
48 const MT_Scalar BOP_EPSILON(1.0e-5);
49 #else
50 const MT_Scalar BOP_EPSILON(9.3132257461547852e-10);    /* ~= 2**-30 */
51 #endif
52
53 inline int BOP_sign(MT_Scalar x) {
54     return x < 0.0 ? -1 : x > 0.0 ? 1 : 0;
55 }
56 inline MT_Scalar BOP_abs(MT_Scalar x) { return fabs(x); }
57 int BOP_comp(const MT_Scalar A, const MT_Scalar B);
58 int BOP_comp(const MT_Tuple3& A, const MT_Tuple3& B);
59 int BOP_comp0(const MT_Scalar A);
60 inline bool BOP_fuzzyZero(MT_Scalar x) { return BOP_comp0(x) == 0; }
61 int BOP_exactComp(const MT_Scalar A, const MT_Scalar B);
62 int BOP_exactComp(const MT_Tuple3& A, const MT_Tuple3& B);
63 bool BOP_between(const MT_Point3& p1, const MT_Point3& p2, const MT_Point3& p3);
64 bool BOP_collinear(const MT_Point3& p1, const MT_Point3& p2, const MT_Point3& p3);
65 bool BOP_convex(const MT_Point3& p1, const MT_Point3& p2, const MT_Point3& p3, 
66                                 const MT_Point3& p4);
67 int BOP_concave(const MT_Point3& p1, const MT_Point3& p2, const MT_Point3& p3, const MT_Point3& p4);
68 bool BOP_intersect(const MT_Vector3& vL1, const MT_Point3& pL1, const MT_Vector3& vL2, 
69                                    const MT_Point3& pL2, MT_Point3& intersection);
70 bool BOP_getCircleCenter(const MT_Point3& p1, const MT_Point3& p2, const MT_Point3& p3, 
71                                                  const MT_Point3& center);
72 bool BOP_isInsideCircle(const MT_Point3& p1, const MT_Point3& p2, const MT_Point3& p3, 
73                                                 const MT_Point3& p4, const MT_Point3& p5);
74 bool BOP_isInsideCircle(const MT_Point3& p1, const MT_Point3& p2, const MT_Point3& p3, 
75                                                 const MT_Point3& q);
76 MT_Scalar BOP_orientation(const MT_Plane3& p1, const MT_Plane3& p2);
77 int BOP_classify(const MT_Point3& p, const MT_Plane3& plane);
78 MT_Point3 BOP_intersectPlane(const MT_Plane3& plane, const MT_Point3& p1, const MT_Point3& p2);
79 bool BOP_containsPoint(const MT_Plane3& plane, const MT_Point3& point);
80 MT_Point3 BOP_4PointIntersect(const MT_Point3& p0, const MT_Point3& p1, const MT_Point3& p2, 
81                                                           const MT_Point3& q);
82 MT_Scalar BOP_EpsilonDistance(const MT_Point3& p0, const MT_Point3& p1, const MT_Point3& q);
83
84 #endif