Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Geometry / Hyperplane.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra. Eigen itself is part of the KDE project.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <g.gael@free.fr>
5 // Copyright (C) 2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6 //
7 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25
26 #ifndef EIGEN_HYPERPLANE_H
27 #define EIGEN_HYPERPLANE_H
28
29 /** \geometry_module \ingroup Geometry_Module
30   *
31   * \class Hyperplane
32   *
33   * \brief A hyperplane
34   *
35   * A hyperplane is an affine subspace of dimension n-1 in a space of dimension n.
36   * For example, a hyperplane in a plane is a line; a hyperplane in 3-space is a plane.
37   *
38   * \param _Scalar the scalar type, i.e., the type of the coefficients
39   * \param _AmbientDim the dimension of the ambient space, can be a compile time value or Dynamic.
40   *             Notice that the dimension of the hyperplane is _AmbientDim-1.
41   *
42   * This class represents an hyperplane as the zero set of the implicit equation
43   * \f$ n \cdot x + d = 0 \f$ where \f$ n \f$ is a unit normal vector of the plane (linear part)
44   * and \f$ d \f$ is the distance (offset) to the origin.
45   */
46 template <typename _Scalar, int _AmbientDim>
47 class Hyperplane
48 {
49 public:
50   EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF_VECTORIZABLE_FIXED_SIZE(_Scalar,_AmbientDim==Dynamic ? Dynamic : _AmbientDim+1)
51   enum { AmbientDimAtCompileTime = _AmbientDim };
52   typedef _Scalar Scalar;
53   typedef typename NumTraits<Scalar>::Real RealScalar;
54   typedef Matrix<Scalar,AmbientDimAtCompileTime,1> VectorType;
55   typedef Matrix<Scalar,AmbientDimAtCompileTime==Dynamic
56                         ? Dynamic
57                         : AmbientDimAtCompileTime+1,1> Coefficients;
58   typedef Block<Coefficients,AmbientDimAtCompileTime,1> NormalReturnType;
59
60   /** Default constructor without initialization */
61   inline explicit Hyperplane() {}
62
63   /** Constructs a dynamic-size hyperplane with \a _dim the dimension
64     * of the ambient space */
65   inline explicit Hyperplane(int _dim) : m_coeffs(_dim+1) {}
66
67   /** Construct a plane from its normal \a n and a point \a e onto the plane.
68     * \warning the vector normal is assumed to be normalized.
69     */
70   inline Hyperplane(const VectorType& n, const VectorType& e)
71     : m_coeffs(n.size()+1)
72   {
73     normal() = n;
74     offset() = -e.dot(n);
75   }
76
77   /** Constructs a plane from its normal \a n and distance to the origin \a d
78     * such that the algebraic equation of the plane is \f$ n \cdot x + d = 0 \f$.
79     * \warning the vector normal is assumed to be normalized.
80     */
81   inline Hyperplane(const VectorType& n, Scalar d)
82     : m_coeffs(n.size()+1)
83   {
84     normal() = n;
85     offset() = d;
86   }
87
88   /** Constructs a hyperplane passing through the two points. If the dimension of the ambient space
89     * is greater than 2, then there isn't uniqueness, so an arbitrary choice is made.
90     */
91   static inline Hyperplane Through(const VectorType& p0, const VectorType& p1)
92   {
93     Hyperplane result(p0.size());
94     result.normal() = (p1 - p0).unitOrthogonal();
95     result.offset() = -result.normal().dot(p0);
96     return result;
97   }
98
99   /** Constructs a hyperplane passing through the three points. The dimension of the ambient space
100     * is required to be exactly 3.
101     */
102   static inline Hyperplane Through(const VectorType& p0, const VectorType& p1, const VectorType& p2)
103   {
104     EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(VectorType, 3)
105     Hyperplane result(p0.size());
106     result.normal() = (p2 - p0).cross(p1 - p0).normalized();
107     result.offset() = -result.normal().dot(p0);
108     return result;
109   }
110
111   /** Constructs a hyperplane passing through the parametrized line \a parametrized.
112     * If the dimension of the ambient space is greater than 2, then there isn't uniqueness,
113     * so an arbitrary choice is made.
114     */
115   // FIXME to be consitent with the rest this could be implemented as a static Through function ??
116   explicit Hyperplane(const ParametrizedLine<Scalar, AmbientDimAtCompileTime>& parametrized)
117   {
118     normal() = parametrized.direction().unitOrthogonal();
119     offset() = -normal().dot(parametrized.origin());
120   }
121
122   ~Hyperplane() {}
123
124   /** \returns the dimension in which the plane holds */
125   inline int dim() const { return AmbientDimAtCompileTime==Dynamic ? m_coeffs.size()-1 : AmbientDimAtCompileTime; }
126
127   /** normalizes \c *this */
128   void normalize(void)
129   {
130     m_coeffs /= normal().norm();
131   }
132
133   /** \returns the signed distance between the plane \c *this and a point \a p.
134     * \sa absDistance()
135     */
136   inline Scalar signedDistance(const VectorType& p) const { return p.dot(normal()) + offset(); }
137
138   /** \returns the absolute distance between the plane \c *this and a point \a p.
139     * \sa signedDistance()
140     */
141   inline Scalar absDistance(const VectorType& p) const { return ei_abs(signedDistance(p)); }
142
143   /** \returns the projection of a point \a p onto the plane \c *this.
144     */
145   inline VectorType projection(const VectorType& p) const { return p - signedDistance(p) * normal(); }
146
147   /** \returns a constant reference to the unit normal vector of the plane, which corresponds
148     * to the linear part of the implicit equation.
149     */
150   inline const NormalReturnType normal() const { return NormalReturnType(m_coeffs,0,0,dim(),1); }
151
152   /** \returns a non-constant reference to the unit normal vector of the plane, which corresponds
153     * to the linear part of the implicit equation.
154     */
155   inline NormalReturnType normal() { return NormalReturnType(m_coeffs,0,0,dim(),1); }
156
157   /** \returns the distance to the origin, which is also the "constant term" of the implicit equation
158     * \warning the vector normal is assumed to be normalized.
159     */
160   inline const Scalar& offset() const { return m_coeffs.coeff(dim()); }
161
162   /** \returns a non-constant reference to the distance to the origin, which is also the constant part
163     * of the implicit equation */
164   inline Scalar& offset() { return m_coeffs(dim()); }
165
166   /** \returns a constant reference to the coefficients c_i of the plane equation:
167     * \f$ c_0*x_0 + ... + c_{d-1}*x_{d-1} + c_d = 0 \f$
168     */
169   inline const Coefficients& coeffs() const { return m_coeffs; }
170
171   /** \returns a non-constant reference to the coefficients c_i of the plane equation:
172     * \f$ c_0*x_0 + ... + c_{d-1}*x_{d-1} + c_d = 0 \f$
173     */
174   inline Coefficients& coeffs() { return m_coeffs; }
175
176   /** \returns the intersection of *this with \a other.
177     *
178     * \warning The ambient space must be a plane, i.e. have dimension 2, so that \c *this and \a other are lines.
179     *
180     * \note If \a other is approximately parallel to *this, this method will return any point on *this.
181     */
182   VectorType intersection(const Hyperplane& other)
183   {
184     EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(VectorType, 2)
185     Scalar det = coeffs().coeff(0) * other.coeffs().coeff(1) - coeffs().coeff(1) * other.coeffs().coeff(0);
186     // since the line equations ax+by=c are normalized with a^2+b^2=1, the following tests
187     // whether the two lines are approximately parallel.
188     if(ei_isMuchSmallerThan(det, Scalar(1)))
189     {   // special case where the two lines are approximately parallel. Pick any point on the first line.
190         if(ei_abs(coeffs().coeff(1))>ei_abs(coeffs().coeff(0)))
191             return VectorType(coeffs().coeff(1), -coeffs().coeff(2)/coeffs().coeff(1)-coeffs().coeff(0));
192         else
193             return VectorType(-coeffs().coeff(2)/coeffs().coeff(0)-coeffs().coeff(1), coeffs().coeff(0));
194     }
195     else
196     {   // general case
197         Scalar invdet = Scalar(1) / det;
198         return VectorType(invdet*(coeffs().coeff(1)*other.coeffs().coeff(2)-other.coeffs().coeff(1)*coeffs().coeff(2)),
199                           invdet*(other.coeffs().coeff(0)*coeffs().coeff(2)-coeffs().coeff(0)*other.coeffs().coeff(2)));
200     }
201   }
202
203   /** Applies the transformation matrix \a mat to \c *this and returns a reference to \c *this.
204     *
205     * \param mat the Dim x Dim transformation matrix
206     * \param traits specifies whether the matrix \a mat represents an Isometry
207     *               or a more generic Affine transformation. The default is Affine.
208     */
209   template<typename XprType>
210   inline Hyperplane& transform(const MatrixBase<XprType>& mat, TransformTraits traits = Affine)
211   {
212     if (traits==Affine)
213       normal() = mat.inverse().transpose() * normal();
214     else if (traits==Isometry)
215       normal() = mat * normal();
216     else
217     {
218       ei_assert("invalid traits value in Hyperplane::transform()");
219     }
220     return *this;
221   }
222
223   /** Applies the transformation \a t to \c *this and returns a reference to \c *this.
224     *
225     * \param t the transformation of dimension Dim
226     * \param traits specifies whether the transformation \a t represents an Isometry
227     *               or a more generic Affine transformation. The default is Affine.
228     *               Other kind of transformations are not supported.
229     */
230   inline Hyperplane& transform(const Transform<Scalar,AmbientDimAtCompileTime>& t,
231                                 TransformTraits traits = Affine)
232   {
233     transform(t.linear(), traits);
234     offset() -= t.translation().dot(normal());
235     return *this;
236   }
237
238   /** \returns \c *this with scalar type casted to \a NewScalarType
239     *
240     * Note that if \a NewScalarType is equal to the current scalar type of \c *this
241     * then this function smartly returns a const reference to \c *this.
242     */
243   template<typename NewScalarType>
244   inline typename ei_cast_return_type<Hyperplane,
245            Hyperplane<NewScalarType,AmbientDimAtCompileTime> >::type cast() const
246   {
247     return typename ei_cast_return_type<Hyperplane,
248                     Hyperplane<NewScalarType,AmbientDimAtCompileTime> >::type(*this);
249   }
250
251   /** Copy constructor with scalar type conversion */
252   template<typename OtherScalarType>
253   inline explicit Hyperplane(const Hyperplane<OtherScalarType,AmbientDimAtCompileTime>& other)
254   { m_coeffs = other.coeffs().template cast<Scalar>(); }
255
256   /** \returns \c true if \c *this is approximately equal to \a other, within the precision
257     * determined by \a prec.
258     *
259     * \sa MatrixBase::isApprox() */
260   bool isApprox(const Hyperplane& other, typename NumTraits<Scalar>::Real prec = precision<Scalar>()) const
261   { return m_coeffs.isApprox(other.m_coeffs, prec); }
262
263 protected:
264
265   Coefficients m_coeffs;
266 };
267
268 #endif // EIGEN_HYPERPLANE_H