Developer Documentation
NormalConeT.hh
1 /* ========================================================================= *
2  * *
3  * OpenMesh *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openmesh.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenMesh. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39  * *
40  * ========================================================================= */
41 
42 
43 
44 
45 
46 
47 
48 //=============================================================================
49 //
50 // CLASS NormalCone
51 //
52 //=============================================================================
53 
54 
55 #ifndef OPENMESH_NORMALCONE_HH
56 #define OPENMESH_NORMALCONE_HH
57 
58 
59 //== INCLUDES =================================================================
60 
61 
62 #include <OpenMesh/Core/Geometry/VectorT.hh>
63 
64 
65 //== NAMESPACES ===============================================================
66 
67 
68 namespace OpenMesh {
69 
70 
71 //== CLASS DEFINITION =========================================================
72 
73 
80 template <typename Scalar>
82 {
83 public:
84 
85  // typedefs
86  typedef VectorT<Scalar, 3> Vec3;
87 
88 
91 
93  NormalConeT(const Vec3& _center_normal, Scalar _angle=0.0);
94 
96  Scalar max_angle(const Vec3&) const;
97 
99  Scalar max_angle(const NormalConeT&) const;
100 
102  void merge(const NormalConeT&);
103 
105  const Vec3& center_normal() const { return center_normal_; }
106 
108  inline Scalar angle() const { return angle_; }
109 
110 private:
111 
112  Vec3 center_normal_;
113  Scalar angle_;
114 };
115 
116 
117 //=============================================================================
118 } // namespace OpenMesh
119 //=============================================================================
120 #if defined(OM_INCLUDE_TEMPLATES) && !defined(OPENMESH_NORMALCONE_C)
121 #define OPENMESH_NORMALCONE_TEMPLATES
122 #include "NormalConeT_impl.hh"
123 #endif
124 //=============================================================================
125 #endif // OPENMESH_NORMALCONE_HH defined
126 //=============================================================================
127 
const Vec3 & center_normal() const
returns center normal
Definition: NormalConeT.hh:105
Scalar angle() const
returns size of cone (radius in radians)
Definition: NormalConeT.hh:108
NormalConeT()
default constructor (not initialized)
Definition: NormalConeT.hh:90
void merge(const NormalConeT &)
merge _cone; this instance will then enclose both former cones
Scalar max_angle(const Vec3 &) const
return max. distance (radians) unit vector to cone (distant side)