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  * $Revision$ *
46  * $Date$ *
47  * *
48 \*===========================================================================*/
49 
50 
51 
52 
53 //=============================================================================
54 //
55 // CLASS NormalCone
56 //
57 //=============================================================================
58 
59 
60 #ifndef OPENMESH_NORMALCONE_HH
61 #define OPENMESH_NORMALCONE_HH
62 
63 
64 //== INCLUDES =================================================================
65 
66 
67 #include <OpenMesh/Core/Geometry/VectorT.hh>
68 
69 
70 //== NAMESPACES ===============================================================
71 
72 
73 namespace OpenMesh {
74 
75 
76 //== CLASS DEFINITION =========================================================
77 
78 
85 template <typename Scalar>
87 {
88 public:
89 
90  // typedefs
91  typedef VectorT<Scalar, 3> Vec3;
92 
93 
96 
98  NormalConeT(const Vec3& _center_normal, Scalar _angle=0.0);
99 
101  Scalar max_angle(const Vec3&) const;
102 
104  Scalar max_angle(const NormalConeT&) const;
105 
107  void merge(const NormalConeT&);
108 
110  const Vec3& center_normal() const { return center_normal_; }
111 
113  inline Scalar angle() const { return angle_; }
114 
115 private:
116 
117  Vec3 center_normal_;
118  Scalar angle_;
119 };
120 
121 
122 //=============================================================================
123 } // namespace OpenMesh
124 //=============================================================================
125 #if defined(OM_INCLUDE_TEMPLATES) && !defined(OPENMESH_NORMALCONE_C)
126 #define OPENMESH_NORMALCONE_TEMPLATES
127 #include "NormalConeT.cc"
128 #endif
129 //=============================================================================
130 #endif // OPENMESH_NORMALCONE_HH defined
131 //=============================================================================
132 
void merge(const NormalConeT &)
merge _cone; this instance will then enclose both former cones
Definition: NormalConeT.cc:128
NormalConeT()
default constructor (not initialized)
Definition: NormalConeT.hh:95
Scalar angle() const
returns size of cone (radius in radians)
Definition: NormalConeT.hh:113
const Vec3 & center_normal() const
returns center normal
Definition: NormalConeT.hh:110
Scalar max_angle(const Vec3 &) const
return max. distance (radians) unit vector to cone (distant side)
Definition: NormalConeT.cc:97