-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathannotated.html
207 lines (204 loc) · 17.5 KB
/
annotated.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<link rel="canonical" href="https://doc.cgal.org/latest/Polyhedron/annotated.html"/>
<link rel="icon" type="image/png" href="../Manual/g-196x196-doc.png">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=11">
<meta name="generator" content="Doxygen 1.9.6">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>CGAL 6.1 - 3D Polyhedral Surface: Class and Concept List</title>
<!-- <link href="../Manual/tabs.css" rel="stylesheet" type="text/css"/> -->
<script type="text/javascript" src="../Manual/jquery.js"></script>
<script type="text/javascript" src="../Manual/dynsections.js"></script>
<script src="../Manual/hacks.js" type="text/javascript"></script>
<!-- Manually include treeview and search to avoid bloat and to fix
paths to the directory Manual . -->
<!-- $.treeview -->
<!-- $.search -->
<link href="navtree.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../Manual/resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="../Manual/search/search.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../Manual/search/searchdata.js"></script>
<script type="text/javascript" src="../Manual/search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="../Manual/search/search.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../Manual/search/search.js"></script>
<!-- Manually done below. -->
<link href="../Manual/doxygen.css" rel="stylesheet" type="text/css">
<link href="../Manual/cgal_stylesheet.css" rel="stylesheet" type="text/css">
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
//<![CDATA[
MathJax.Hub.Config(
{
TeX: {
Macros: {
qprel: [ "{\\gtreqless}", 0],
qpx: [ "{\\mathbf{x}}", 0],
qpl: [ "{\\mathbf{l}}", 0],
qpu: [ "{\\mathbf{u}}", 0],
qpc: [ "{\\mathbf{c}}", 0],
qpb: [ "{\\mathbf{b}}", 0],
qpy: [ "{\\mathbf{y}}", 0],
qpw: [ "{\\mathbf{w}}", 0],
qplambda: [ "{\\mathbf{\\lambda}}", 0],
ssWpoint: [ "{\\bf #1}", 1],
ssWeight: [ "{w_{#1}}", 1],
dabs: [ "{\\parallel\\! #1 \\!\\parallel}", 1],
E: [ "{\\mathrm{E}}", 0],
A: [ "{\\mathrm{A}}", 0],
R: [ "{\\mathrm{R}}", 0],
N: [ "{\\mathrm{N}}", 0],
Q: [ "{\\mathrm{Q}}", 0],
Z: [ "{\\mathrm{Z}}", 0],
ccSum: [ "{\\sum_{#1}^{#2}{#3}}", 3],
ccProd: [ "{\\prod_{#1}^{#2}{#3}}", 3],
pyr: [ "{\\operatorname{Pyr}}", 0],
aff: [ "{\\operatorname{aff}}", 0],
Ac: [ "{\\cal A}", 0],
Sc: [ "{\\cal S}", 0],
},
equationNumbers: { autoNumber: "AMS" }
}
}
);
MathJax.Hub.Register.StartupHook("TeX Jax Ready",function () {
var PARSE = MathJax.InputJax.TeX.Parse,
TEXT = PARSE.prototype.InternalText;
PARSE.Augment({
InternalText: function (text,def) {
text = text.replace(/\\/g,"");
return TEXT.call(this,text,def);
}
});
});
//]]>
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<script src="modules.js" type="text/javascript"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="back-nav">
<ul>
<li><a href="https://www.cgal.org/">cgal.org</a></li>
<li><a href="../Manual/index.html">Top</a></li>
<li><a href="../Manual/general_intro.html">Getting Started</a></li>
<li><a href="../Manual/tutorials.html">Tutorials</a></li>
<li><a href="../Manual/packages.html">Package Overview</a></li>
<li><a href="../Manual/how_to_cite_cgal.html">Acknowledging CGAL</a></li>
</ul>
<!-- In a package SEARCHENGINE = false, so we cannot use
insertion. That's why we have to do it manually here. Notice
that we also take pngs from the Manual. -->
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">
</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)">
</span>
<span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../Manual/search/close.svg" alt=""></a>
</span>
</div>
</div>
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">CGAL 6.1 - 3D Polyhedral Surface
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Code below is usually inserted by doxygen when SEARCHENGINE =
true. Notice that the path to the search directory is adjusted to
the top-level.-->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../Manual/search/",'.html');
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync" style="display: none"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">Class and Concept List</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here is the list of all concepts and classes of this package. Classes are inside the namespace CGAL. Concepts are in the global namespace.</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span class="icona"><span class="icon-namespace">N</span></span><b>CGAL</b></td><td class="desc"></td></tr>
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">▼</span><span class="icona"><span class="icon-class">C</span></span><a class="el" href="classCGAL_1_1Polyhedron__3.html" target="_self">Polyhedron_3</a></td><td class="desc">A polyhedral surface <code><a class="el" href="classCGAL_1_1Polyhedron__3.html" title="A polyhedral surface Polyhedron_3 consists of vertices V, edges E, facets F and an incidence relation...">Polyhedron_3</a></code> consists of vertices <code>V</code>, edges <code>E</code>, facets <code>F</code> and an incidence relation on them </td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon-class">C</span></span><a class="el" href="classCGAL_1_1Polyhedron__3_1_1Facet.html" target="_self">Facet</a></td><td class="desc">A facet optionally stores a plane equation, and a reference to an incident halfedge that points to the facet </td></tr>
<tr id="row_0_0_1_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon-class">C</span></span><a class="el" href="classCGAL_1_1Polyhedron__3_1_1Halfedge.html" target="_self">Halfedge</a></td><td class="desc">A halfedge is an oriented edge between two vertices </td></tr>
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon-class">C</span></span><a class="el" href="classCGAL_1_1Polyhedron__3_1_1Vertex.html" target="_self">Vertex</a></td><td class="desc">A vertex optionally stores a point and a reference to an incident halfedge that points to the vertex </td></tr>
<tr id="row_0_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon-class">C</span></span><a class="el" href="classCGAL_1_1Polyhedron__incremental__builder__3.html" target="_self">Polyhedron_incremental_builder_3</a></td><td class="desc">The auxiliary class <code><a class="el" href="classCGAL_1_1Polyhedron__incremental__builder__3.html" title="The auxiliary class Polyhedron_incremental_builder_3 supports the incremental construction of polyhed...">Polyhedron_incremental_builder_3</a></code> supports the incremental construction of polyhedral surfaces, which is for example convenient when constructing polyhedral surfaces from file formats, such as the Object File Format (OFF) <a class="el" href="citelist.html#CITEREF_cgal:p-gmgv16-96">[5]</a>, OpenInventor <a class="el" href="citelist.html#CITEREF_cgal:w-impoo-94">[7]</a> or VRML <a class="el" href="citelist.html#CITEREF_cgal:bpp-vrml-95">[1]</a>, <a class="el" href="citelist.html#CITEREF_cgal:vrmls-97">[6]</a> </td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon-class">C</span></span><a class="el" href="classCGAL_1_1Polyhedron__items__3.html" target="_self">Polyhedron_items_3</a></td><td class="desc">The class <code><a class="el" href="classCGAL_1_1Polyhedron__items__3.html" title="The class Polyhedron_items_3 is a model of the PolyhedronItems_3 concept.">Polyhedron_items_3</a></code> is a model of the <code><a class="el" href="classPolyhedronItems__3.html" title="The PolyhedronItems_3 concept refines the HalfedgeDSItems concept. In addition to the requirements st...">PolyhedronItems_3</a></code> concept </td></tr>
<tr id="row_0_3_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon-class">C</span></span><a class="el" href="classCGAL_1_1Polyhedron__min__items__3.html" target="_self">Polyhedron_min_items_3</a></td><td class="desc">The class <code><a class="el" href="classCGAL_1_1Polyhedron__min__items__3.html" title="The class Polyhedron_min_items_3 is a minimal model of the PolyhedronItems_3 concept.">Polyhedron_min_items_3</a></code> is a minimal model of the <code><a class="el" href="classPolyhedronItems__3.html" title="The PolyhedronItems_3 concept refines the HalfedgeDSItems concept. In addition to the requirements st...">PolyhedronItems_3</a></code> concept </td></tr>
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon-class">C</span></span><a class="el" href="classCGAL_1_1Polyhedron__traits__3.html" target="_self">Polyhedron_traits_3</a></td><td class="desc">The class <code><a class="el" href="classCGAL_1_1Polyhedron__traits__3.html" title="The class Polyhedron_traits_3 is a model of the PolyhedronTraits_3 concept.">Polyhedron_traits_3</a></code> is a model of the <code><a class="el" href="classPolyhedronTraits__3.html" title="Required types and member functions for the PolyhedronTraits_3 concept. This geometric traits concept...">PolyhedronTraits_3</a></code> concept </td></tr>
<tr id="row_0_5_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon-class">C</span></span><a class="el" href="classCGAL_1_1Polyhedron__traits__with__normals__3.html" target="_self">Polyhedron_traits_with_normals_3</a></td><td class="desc">The class <code><a class="el" href="classCGAL_1_1Polyhedron__traits__with__normals__3.html" title="The class Polyhedron_traits_with_normals_3 is a model of the PolyhedronTraits_3 concept.">Polyhedron_traits_with_normals_3</a></code> is a model of the <code><a class="el" href="classPolyhedronTraits__3.html" title="Required types and member functions for the PolyhedronTraits_3 concept. This geometric traits concept...">PolyhedronTraits_3</a></code> concept </td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">▼</span><span class="icona"><span class="icon-concept">C</span></span><a class="el" href="classPolyhedronItems__3.html" target="_self">PolyhedronItems_3</a></td><td class="desc">The <code><a class="el" href="classPolyhedronItems__3.html" title="The PolyhedronItems_3 concept refines the HalfedgeDSItems concept. In addition to the requirements st...">PolyhedronItems_3</a></code> concept refines the <code><a class="elRef" href="../HalfedgeDS/classHalfedgeDSItems.html">HalfedgeDSItems</a></code> concept. In addition to the requirements stated there, a model for this concept must fulfill the following requirements for the local <a class="elRef" href="../HalfedgeDS/classHalfedgeDSItems.html#a3c66b2867f9cf06929aebb2b6342bec9">PolyhedronItems_3::Vertex_wrapper<Refs,Traits>::Vertex</a> type and <a class="elRef" href="../HalfedgeDS/classHalfedgeDSItems.html#afd23fea58360fedcfeaf8017a5e89bf6">PolyhedronItems_3::Face_wrapper<Refs,Traits>::Face</a> type in order to support the point for vertices and the optional plane equation for facets. Note that the items class uses face instead of facet. Only the polyhedral surface renames faces to facets </td></tr>
<tr id="row_1_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon-concept">C</span></span><a class="el" href="classPolyhedronItems__3_1_1Face.html" target="_self">Face</a></td><td class="desc">The <code><a class="el" href="classPolyhedronItems__3_1_1Face.html" title="The PolyhedronItems_3::Face concept refines the HalfedgeDSItems::Face concept. This concept adds the ...">PolyhedronItems_3::Face</a></code> concept refines the <code><a class="elRef" href="../HalfedgeDS/classHalfedgeDSItems.html#afd23fea58360fedcfeaf8017a5e89bf6">HalfedgeDSItems::Face</a></code> concept. This concept adds the requirement for the support of the geometry </td></tr>
<tr id="row_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon-concept">C</span></span><a class="el" href="classPolyhedronItems__3_1_1Vertex.html" target="_self">Vertex</a></td><td class="desc">The <code><a class="el" href="classPolyhedronItems__3_1_1Vertex.html" title="The PolyhedronItems_3::Vertex concept refines the HalfedgeDSItems::Vertex concept....">PolyhedronItems_3::Vertex</a></code> concept refines the <code><a class="elRef" href="../HalfedgeDS/classHalfedgeDSItems.html#a3c66b2867f9cf06929aebb2b6342bec9">HalfedgeDSItems::Vertex</a></code> concept. This concept adds the requirement for the support of the geometry </td></tr>
<tr id="row_2_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon-concept">C</span></span><a class="el" href="classPolyhedronTraits__3.html" target="_self">PolyhedronTraits_3</a></td><td class="desc">Required types and member functions for the <code><a class="el" href="classPolyhedronTraits__3.html" title="Required types and member functions for the PolyhedronTraits_3 concept. This geometric traits concept...">PolyhedronTraits_3</a></code> concept. This geometric traits concept is used in the polyhedral surface data structure <code><a class="el" href="classCGAL_1_1Polyhedron__3.html" title="A polyhedral surface Polyhedron_3 consists of vertices V, edges E, facets F and an incidence relation...">CGAL::Polyhedron_3</a><Traits></code>. Any CGAL kernel is a model of this concept and can be used directly as template argument </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.6-->
<!-- start footer part -->
<!-- The footer div is not part of the default but we require it to
move the footer to the bottom of the page. -->
<div id="footer">
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"></a> 1.9.6 </li>
</ul>
</div>
</div>
</body>
</html>