Initial revision
[blender.git] / intern / moto / include / MT_Vector3.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /*
33
34  * Copyright (c) 2000 Gino van den Bergen <gino@acm.org>
35  *
36  * Permission to use, copy, modify, distribute and sell this software
37  * and its documentation for any purpose is hereby granted without fee,
38  * provided that the above copyright notice appear in all copies and
39  * that both that copyright notice and this permission notice appear
40  * in supporting documentation.  Gino van den Bergen makes no
41  * representations about the suitability of this software for any
42  * purpose.  It is provided "as is" without express or implied warranty.
43  *
44  */
45
46 #ifndef MT_VECTOR3_H
47 #define MT_VECTOR3_H
48
49 #include <MT_assert.h>
50 #include "MT_Tuple3.h"
51
52 class MT_Vector3 : public MT_Tuple3 {
53 public:
54     MT_Vector3() {}
55     MT_Vector3(const float *v) : MT_Tuple3(v) {}
56     MT_Vector3(const double *v) : MT_Tuple3(v) {}
57     MT_Vector3(MT_Scalar x, MT_Scalar y, MT_Scalar z) : MT_Tuple3(x, y, z) {}
58   
59     MT_Vector3& operator+=(const MT_Vector3& v);
60     MT_Vector3& operator-=(const MT_Vector3& v);
61     MT_Vector3& operator*=(MT_Scalar s);
62     MT_Vector3& operator/=(MT_Scalar s);
63   
64     MT_Scalar   dot(const MT_Vector3& v) const; 
65
66     MT_Scalar   length2() const;
67     MT_Scalar   length() const;
68
69     MT_Vector3  absolute() const;
70
71     void        noiseGate(MT_Scalar threshold);
72
73     void        normalize();
74     MT_Vector3  normalized() const;
75         MT_Vector3  safe_normalized() const;
76         
77
78     void        scale(MT_Scalar x, MT_Scalar y, MT_Scalar z); 
79     MT_Vector3  scaled(MT_Scalar x, MT_Scalar y, MT_Scalar z) const; 
80     
81     bool        fuzzyZero() const; 
82
83     MT_Scalar   angle(const MT_Vector3& v) const;
84     MT_Vector3  cross(const MT_Vector3& v) const;
85     MT_Scalar   triple(const MT_Vector3& v1, const MT_Vector3& v2) const;
86
87     int         closestAxis() const;
88
89     static MT_Vector3 random();
90 };
91
92 MT_Vector3 operator+(const MT_Vector3& v1, const MT_Vector3& v2);
93 MT_Vector3 operator-(const MT_Vector3& v1, const MT_Vector3& v2);
94 MT_Vector3 operator-(const MT_Vector3& v);
95 MT_Vector3 operator*(const MT_Vector3& v, MT_Scalar s);
96 MT_Vector3 operator*(MT_Scalar s, const MT_Vector3& v);
97 MT_Vector3 operator/(const MT_Vector3& v, MT_Scalar s);
98
99 MT_Vector3 operator*(const MT_Vector3& v1, const MT_Vector3& v2);
100
101 MT_Scalar  MT_dot(const MT_Vector3& v1, const MT_Vector3& v2);
102
103 MT_Scalar  MT_length2(const MT_Vector3& v);
104 MT_Scalar  MT_length(const MT_Vector3& v);
105
106 bool       MT_fuzzyZero(const MT_Vector3& v);
107 bool       MT_fuzzyEqual(const MT_Vector3& v1, const MT_Vector3& v2);
108
109 MT_Scalar  MT_angle(const MT_Vector3& v1, const MT_Vector3& v2);
110 MT_Vector3 MT_cross(const MT_Vector3& v1, const MT_Vector3& v2);
111 MT_Scalar  MT_triple(const MT_Vector3& v1, const MT_Vector3& v2, 
112                      const MT_Vector3& v3);
113
114 #ifdef GEN_INLINED
115 #include "MT_Vector3.inl"
116 #endif
117
118 #endif