Another set of UI messages fixes and tweaks! No functional changes.
[blender.git] / extern / Eigen3 / Eigen / src / Geometry / ParametrizedLine.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.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_PARAMETRIZEDLINE_H
27 #define EIGEN_PARAMETRIZEDLINE_H
28
29 /** \geometry_module \ingroup Geometry_Module
30   *
31   * \class ParametrizedLine
32   *
33   * \brief A parametrized line
34   *
35   * A parametrized line is defined by an origin point \f$ \mathbf{o} \f$ and a unit
36   * direction vector \f$ \mathbf{d} \f$ such that the line corresponds to
37   * the set \f$ l(t) = \mathbf{o} + t \mathbf{d} \f$, \f$ t \in \mathbf{R} \f$.
38   *
39   * \param _Scalar the scalar type, i.e., the type of the coefficients
40   * \param _AmbientDim the dimension of the ambient space, can be a compile time value or Dynamic.
41   */
42 template <typename _Scalar, int _AmbientDim, int _Options>
43 class ParametrizedLine
44 {
45 public:
46   EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF_VECTORIZABLE_FIXED_SIZE(_Scalar,_AmbientDim)
47   enum {
48     AmbientDimAtCompileTime = _AmbientDim,
49     Options = _Options
50   };
51   typedef _Scalar Scalar;
52   typedef typename NumTraits<Scalar>::Real RealScalar;
53   typedef DenseIndex Index;
54   typedef Matrix<Scalar,AmbientDimAtCompileTime,1,Options> VectorType;
55
56   /** Default constructor without initialization */
57   inline explicit ParametrizedLine() {}
58   
59   template<int OtherOptions>
60   ParametrizedLine(const ParametrizedLine<Scalar,AmbientDimAtCompileTime,OtherOptions>& other)
61    : m_origin(other.origin()), m_direction(other.direction())
62   {}
63
64   /** Constructs a dynamic-size line with \a _dim the dimension
65     * of the ambient space */
66   inline explicit ParametrizedLine(Index _dim) : m_origin(_dim), m_direction(_dim) {}
67
68   /** Initializes a parametrized line of direction \a direction and origin \a origin.
69     * \warning the vector direction is assumed to be normalized.
70     */
71   ParametrizedLine(const VectorType& origin, const VectorType& direction)
72     : m_origin(origin), m_direction(direction) {}
73
74   template <int OtherOptions>
75   explicit ParametrizedLine(const Hyperplane<_Scalar, _AmbientDim, OtherOptions>& hyperplane);
76
77   /** Constructs a parametrized line going from \a p0 to \a p1. */
78   static inline ParametrizedLine Through(const VectorType& p0, const VectorType& p1)
79   { return ParametrizedLine(p0, (p1-p0).normalized()); }
80
81   ~ParametrizedLine() {}
82
83   /** \returns the dimension in which the line holds */
84   inline Index dim() const { return m_direction.size(); }
85
86   const VectorType& origin() const { return m_origin; }
87   VectorType& origin() { return m_origin; }
88
89   const VectorType& direction() const { return m_direction; }
90   VectorType& direction() { return m_direction; }
91
92   /** \returns the squared distance of a point \a p to its projection onto the line \c *this.
93     * \sa distance()
94     */
95   RealScalar squaredDistance(const VectorType& p) const
96   {
97     VectorType diff = p - origin();
98     return (diff - direction().dot(diff) * direction()).squaredNorm();
99   }
100   /** \returns the distance of a point \a p to its projection onto the line \c *this.
101     * \sa squaredDistance()
102     */
103   RealScalar distance(const VectorType& p) const { return internal::sqrt(squaredDistance(p)); }
104
105   /** \returns the projection of a point \a p onto the line \c *this. */
106   VectorType projection(const VectorType& p) const
107   { return origin() + direction().dot(p-origin()) * direction(); }
108
109   template <int OtherOptions>
110   Scalar intersection(const Hyperplane<_Scalar, _AmbientDim, OtherOptions>& hyperplane) const;
111
112   /** \returns \c *this with scalar type casted to \a NewScalarType
113     *
114     * Note that if \a NewScalarType is equal to the current scalar type of \c *this
115     * then this function smartly returns a const reference to \c *this.
116     */
117   template<typename NewScalarType>
118   inline typename internal::cast_return_type<ParametrizedLine,
119            ParametrizedLine<NewScalarType,AmbientDimAtCompileTime,Options> >::type cast() const
120   {
121     return typename internal::cast_return_type<ParametrizedLine,
122                     ParametrizedLine<NewScalarType,AmbientDimAtCompileTime,Options> >::type(*this);
123   }
124
125   /** Copy constructor with scalar type conversion */
126   template<typename OtherScalarType,int OtherOptions>
127   inline explicit ParametrizedLine(const ParametrizedLine<OtherScalarType,AmbientDimAtCompileTime,OtherOptions>& other)
128   {
129     m_origin = other.origin().template cast<Scalar>();
130     m_direction = other.direction().template cast<Scalar>();
131   }
132
133   /** \returns \c true if \c *this is approximately equal to \a other, within the precision
134     * determined by \a prec.
135     *
136     * \sa MatrixBase::isApprox() */
137   bool isApprox(const ParametrizedLine& other, typename NumTraits<Scalar>::Real prec = NumTraits<Scalar>::dummy_precision()) const
138   { return m_origin.isApprox(other.m_origin, prec) && m_direction.isApprox(other.m_direction, prec); }
139
140 protected:
141
142   VectorType m_origin, m_direction;
143 };
144
145 /** Constructs a parametrized line from a 2D hyperplane
146   *
147   * \warning the ambient space must have dimension 2 such that the hyperplane actually describes a line
148   */
149 template <typename _Scalar, int _AmbientDim, int _Options>
150 template <int OtherOptions>
151 inline ParametrizedLine<_Scalar, _AmbientDim,_Options>::ParametrizedLine(const Hyperplane<_Scalar, _AmbientDim,OtherOptions>& hyperplane)
152 {
153   EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(VectorType, 2)
154   direction() = hyperplane.normal().unitOrthogonal();
155   origin() = -hyperplane.normal()*hyperplane.offset();
156 }
157
158 /** \returns the parameter value of the intersection between \c *this and the given hyperplane
159   */
160 template <typename _Scalar, int _AmbientDim, int _Options>
161 template <int OtherOptions>
162 inline _Scalar ParametrizedLine<_Scalar, _AmbientDim,_Options>::intersection(const Hyperplane<_Scalar, _AmbientDim, OtherOptions>& hyperplane) const
163 {
164   return -(hyperplane.offset()+hyperplane.normal().dot(origin()))
165           / hyperplane.normal().dot(direction());
166 }
167
168 #endif // EIGEN_PARAMETRIZEDLINE_H