mirror of https://github.com/CGAL/cgal
User Manual automatic update
This commit is contained in:
parent
f98b56c594
commit
a3b10f1ec3
|
|
@ -23,7 +23,7 @@
|
|||
/// @heading Has Models:
|
||||
/// - Orientable_normal_3<Geom_traits>
|
||||
|
||||
class OrientableNormal_3
|
||||
class OrientableNormal_3
|
||||
: public Kernel::Vector_3,
|
||||
public DefaultConstructible, public CopyConstructible, public Assignable, public EqualityComparable
|
||||
{
|
||||
|
|
@ -43,9 +43,9 @@ public:
|
|||
OrientableNormal_3(Null_vector = NULL_VECTOR);
|
||||
OrientableNormal_3(const Vector& vector, bool oriented = true);
|
||||
OrientableNormal_3(FT x, FT y, FT z, bool oriented = true);
|
||||
Orientable_normal_3(RT hx, RT hy, RT hz, RT hw, bool oriented = true)
|
||||
OrientableNormal_3(RT hx, RT hy, RT hz, RT hw, bool oriented = true);
|
||||
|
||||
/// Get (a copy of) the actual vector.
|
||||
/// Get (a copy of) the actual vector.
|
||||
Vector get_vector() const;
|
||||
|
||||
/// Get normal orientation.
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@ Model of \ccc{PointWithNormal_3} concept.
|
|||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
Model of \ccc{Kernel::Vector_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vector}
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ Model of \ccc{PointWithNormal_3}.
|
|||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
Model of \ccc{Kernel::Vector_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
% | Reference manual page: ImplicitFctDelaunayTriangulation_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 22.02.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSImplicitFctDelaunayTriangulationRev}{$Id$}
|
||||
\RCSdefDate{\RCSImplicitFctDelaunayTriangulationDate}{$Date$}
|
||||
|
|
@ -27,13 +27,13 @@ The \ccc{ImplicitFctDelaunayTriangulation_3} concept defines the interface of a
|
|||
CAUTION: \ccc{invalidate_bounding_box}() must be called after modifying the points.
|
||||
|
||||
%END-AUTO(\ccDefinition)
|
||||
|
||||
|
||||
\ccRefines
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccRefines)
|
||||
|
||||
\ccc{DelaunayTriangulation_3}, DefaultConstructible, CopyConstructible, and Assignable
|
||||
\ccc{DelaunayTriangulation_3}, and DefaultConstructible
|
||||
|
||||
%END-AUTO(\ccRefines)
|
||||
|
||||
|
|
@ -71,7 +71,7 @@ Model of \ccc{PointWithNormal_3}.
|
|||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
Model of \ccc{Kernel::Vector_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Normal_iterator}
|
||||
|
|
@ -186,12 +186,12 @@ Update barycenter, bounding box, bounding sphere and standard deviation. Owner i
|
|||
\ccGlue
|
||||
\ccMethod{Vertex_handle insert(const Point& p, unsigned char type = INPUT, Cell_handle start = Cell_handle());}
|
||||
{
|
||||
Insert point to the triangulation.
|
||||
Insert point in the triangulation.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{int insert(InputIterator first, InputIterator beyond, unsigned char type = INPUT);}
|
||||
{
|
||||
Insert points to the triangulation using a spatial sort.
|
||||
Insert points in the triangulation using a spatial sort.
|
||||
Precondition: the value type of InputIterator must \ccc{Point}.
|
||||
}
|
||||
\ccGlue
|
||||
|
|
|
|||
|
|
@ -110,7 +110,7 @@ Model of \ccc{PointWithNormal_3}.
|
|||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
Model of \ccc{Kernel::Vector_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Normal_iterator}
|
||||
|
|
@ -236,12 +236,12 @@ Update barycenter, bounding box, bounding sphere and standard deviation. Owner i
|
|||
\ccGlue
|
||||
\ccMethod{Vertex_handle insert(const Point& p, unsigned char type = INPUT, Cell_handle start = Cell_handle());}
|
||||
{
|
||||
Insert point to the triangulation.
|
||||
Insert point in the triangulation. Default type is INPUT.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{int insert(InputIterator first, InputIterator beyond, unsigned char type = INPUT);}
|
||||
{
|
||||
Insert points to the triangulation using a spatial sort.
|
||||
Insert points in the triangulation using a spatial sort. Default type is INPUT.
|
||||
Precondition: the value type of InputIterator must \ccc{Point}.
|
||||
}
|
||||
\ccGlue
|
||||
|
|
@ -253,6 +253,11 @@ Precondition: the value type of InputIterator must \ccc{Point}.
|
|||
\begin{description}
|
||||
\item[Returns:]the number of inserted points. \end{description}
|
||||
\ccGlue
|
||||
\ccMethod{Vertex_handle insert_in_hole(const Point& p, CellIt cell_begin, CellIt cell_end, Cell_handle begin, int i, unsigned char type = STEINER);}
|
||||
{
|
||||
Delaunay refinement callback: insert STEINER point in the triangulation.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{unsigned int index_vertices();}
|
||||
{
|
||||
Index all (finite) vertices following the order of \ccc{Finite_vertices_iterator}.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
% | Reference manual page: Implicit_fct_delaunay_triangulation_cell_base_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 05.03.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSImplicitfctdelaunaytriangulationcellbaseRev}{$Id$}
|
||||
\RCSdefDate{\RCSImplicitfctdelaunaytriangulationcellbaseDate}{$Date$}
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
% | Reference manual page: Implicit_fct_delaunay_triangulation_vertex_base_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 05.03.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSImplicitfctdelaunaytriangulationvertexbaseRev}{$Id$}
|
||||
\RCSdefDate{\RCSImplicitfctdelaunaytriangulationvertexbaseDate}{$Date$}
|
||||
|
|
@ -90,7 +90,7 @@ Model of \ccc{PointWithNormal_3}.
|
|||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
Model of \ccc{Kernel::Vector_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,254 @@
|
|||
% +------------------------------------------------------------------------+
|
||||
% | Reference manual page: Lightweight_vector_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 30.09.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSLightweightvectorRev}{$Id$}
|
||||
\RCSdefDate{\RCSLightweightvectorDate}{$Date$}
|
||||
% |
|
||||
\ccRefPageBegin
|
||||
%%RefPage: end of header, begin of main body
|
||||
% +------------------------------------------------------------------------+
|
||||
|
||||
|
||||
\begin{ccRefClass}{Lightweight_vector_3<Geom_traits>}
|
||||
|
||||
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
||||
%% \ccHtmlIndexC[class]{} %% add further index entries
|
||||
|
||||
\ccDefinition
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccDefinition)
|
||||
|
||||
The \ccc{Lightweight_vector_3} class represents a 3D vector (oriented). The purpose of this class is to save memory as the actual vector is allocated only when needed.
|
||||
|
||||
%END-AUTO(\ccDefinition)
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccInclude)
|
||||
|
||||
\ccInclude{CGAL/Lightweight_vector_3.h}
|
||||
|
||||
%END-AUTO(\ccInclude)
|
||||
|
||||
\ccParameters
|
||||
|
||||
The full template declaration is:
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccParameters)
|
||||
|
||||
template$<$ \\
|
||||
class Gt$>$ \\
|
||||
class \ccc{Lightweight_vector_3};
|
||||
|
||||
\begin{description}
|
||||
\item[Parameters:]
|
||||
\begin{description}
|
||||
\item[Gt]Kernel's geometric traits. \end{description}
|
||||
\end{description}
|
||||
|
||||
%END-AUTO(\ccParameters)
|
||||
|
||||
\ccIsModel
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccIsModel)
|
||||
|
||||
Model of the \ccc{Kernel::Vector_3} concept.
|
||||
|
||||
%END-AUTO(\ccIsModel)
|
||||
|
||||
\ccTypes
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccTypes)
|
||||
|
||||
\ccNestedType{Geom_traits}
|
||||
{
|
||||
Kernel's geometric traits.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{FT}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{RT}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vector}
|
||||
{
|
||||
Kernel's \ccc{Vector_3} class.
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccTypes)
|
||||
|
||||
\ccCreation
|
||||
\ccCreationVariable{v} %% variable name for \ccMethod calls below
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccCreation)
|
||||
|
||||
\ccConstructor{Lightweight_vector_3(Null_vector = NULL_VECTOR);}
|
||||
{
|
||||
Vector is (0,0,0) by default.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Lightweight_vector_3(const Vector& vector);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Lightweight_vector_3(FT x, FT y, FT z);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Lightweight_vector_3(RT hx, RT hy, RT hz, RT hw);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Lightweight_vector_3(const Lightweight_vector_3<Gt>& that);}
|
||||
{
|
||||
Copy constructor.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Lightweight_vector_3(const Lightweight_vector_3<K>& that);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccCreation)
|
||||
|
||||
\ccOperations
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccOperations)
|
||||
|
||||
\ccMethod{Lightweight_vector_3& operator=(const Lightweight_vector_3<Gt>& that);}
|
||||
{
|
||||
Operator =().
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{bool operator==(const Lightweight_vector_3<Gt>& that);}
|
||||
{
|
||||
Compare vectors.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{bool operator!=(const Lightweight_vector_3<Gt>& that);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{operator Vector() const;}
|
||||
{
|
||||
Get (a copy of) the actual vector.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Vector get_vector() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{FT x() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{FT y() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{FT z() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{RT hx() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{RT hy() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{RT hz() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{RT hw() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{FT cartesian(int i) const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{FT operator[](int i) const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{RT homogeneous(int i) const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{int dimension() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Vector operator+(const Vector& that) const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Vector operator-(const Vector& that) const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{FT operator*(const Vector& that) const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Vector operator-() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Vector operator/(RT c) const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Vector operator*(FT c) const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{FT squared_length() const;}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccOperations)
|
||||
|
||||
\ccHeading{Friends And Related Functions}
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccHeading{Friends And Related Functions})
|
||||
|
||||
\ccFunction{Vector operator*(FT c, const Lightweight_vector_3<Gt>& vector);}
|
||||
{
|
||||
[friend] \\
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccHeading{Friends And Related Functions})
|
||||
|
||||
\ccSeeAlso
|
||||
|
||||
\ccc{Vector_3<Geom_traits>} \\
|
||||
\ccc{Orientable_normal_3<Geom_traits>} \\
|
||||
\ccc{Point_with_normal_3<Geom_traits, Normal_3>}
|
||||
|
||||
\end{ccRefClass}
|
||||
|
||||
% +------------------------------------------------------------------------+
|
||||
%%RefPage: end of main body, begin of footer
|
||||
\ccRefPageEnd
|
||||
% EOF
|
||||
% +------------------------------------------------------------------------+
|
||||
|
||||
|
|
@ -1,18 +1,18 @@
|
|||
% +------------------------------------------------------------------------+
|
||||
% | Reference manual page: OrientedNormal_3.tex
|
||||
% | Reference manual page: OrientableNormal_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 05.03.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSOrientedNormalRev}{$Id$}
|
||||
\RCSdefDate{\RCSOrientedNormalDate}{$Date$}
|
||||
\RCSdef{\RCSOrientableNormalRev}{$Id$}
|
||||
\RCSdefDate{\RCSOrientableNormalDate}{$Date$}
|
||||
% |
|
||||
\ccRefPageBegin
|
||||
%%RefPage: end of header, begin of main body
|
||||
% +------------------------------------------------------------------------+
|
||||
|
||||
|
||||
\begin{ccRefConcept}{OrientedNormal_3}
|
||||
\begin{ccRefConcept}{OrientableNormal_3}
|
||||
|
||||
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
||||
%% \ccHtmlIndexC[concept]{} %% add further index entries
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccDefinition)
|
||||
|
||||
The \ccc{OrientedNormal_3} concept represents a normal vector (oriented or not).
|
||||
The \ccc{OrientableNormal_3} concept represents a normal vector (oriented or not).
|
||||
|
||||
%END-AUTO(\ccDefinition)
|
||||
|
||||
|
|
@ -31,24 +31,31 @@ The \ccc{OrientedNormal_3} concept represents a normal vector (oriented or not).
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccRefines)
|
||||
|
||||
DefaultConstructible, CopyConstructible, and Assignable
|
||||
\ccc{Kernel::Vector_3}, DefaultConstructible, CopyConstructible, Assignable, and EqualityComparable
|
||||
|
||||
%END-AUTO(\ccRefines)
|
||||
|
||||
\ccGeneralizes
|
||||
|
||||
\ccTypes
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccTypes)
|
||||
|
||||
\ccNestedType{Vector}
|
||||
\ccNestedType{Geom_traits}
|
||||
{
|
||||
Kernel's geometric traits.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{FT}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{RT}
|
||||
{
|
||||
Model of \ccc{Kernel::Vector_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vector}
|
||||
{
|
||||
Kernel's \ccc{Vector_3} class.
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
|
|
@ -60,12 +67,20 @@ Model of \ccc{Kernel::Vector_3} concept.
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccCreation)
|
||||
|
||||
\ccConstructor{OrientedNormal_3(Null_vector = NULL_VECTOR);}
|
||||
\ccConstructor{OrientableNormal_3(Null_vector = NULL_VECTOR);}
|
||||
{
|
||||
Normal vector is (0,0,0) by default. Normal is oriented by default.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{OrientedNormal_3(const Vector& vector, bool oriented = true);}
|
||||
\ccConstructor{OrientableNormal_3(const Vector& vector, bool oriented = true);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{OrientableNormal_3(FT x, FT y, FT z, bool oriented = true);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{OrientableNormal_3(RT hx, RT hy, RT hz, RT hw, bool oriented = true);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
|
@ -79,7 +94,7 @@ Normal vector is (0,0,0) by default. Normal is oriented by default.
|
|||
|
||||
\ccMethod{Vector get_vector() const;}
|
||||
{
|
||||
Get normal vector.
|
||||
Get (a copy of) the actual vector.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{bool is_oriented() const;}
|
||||
|
|
@ -87,11 +102,6 @@ Get normal vector.
|
|||
Get normal orientation.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{void set(const Vector& vector, bool oriented = true);}
|
||||
{
|
||||
Set normal (vector + orientation).
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccOperations)
|
||||
|
||||
|
|
@ -100,7 +110,7 @@ Set normal (vector + orientation).
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccHasModels)
|
||||
|
||||
\ccc{Oriented_normal_3<Geom_traits>}
|
||||
\ccc{Orientable_normal_3<Geom_traits>}
|
||||
|
||||
%END-AUTO(\ccHasModels)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,18 +1,18 @@
|
|||
% +------------------------------------------------------------------------+
|
||||
% | Reference manual page: Oriented_normal_3.tex
|
||||
% | Reference manual page: Orientable_normal_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 05.03.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSOrientednormalRev}{$Id$}
|
||||
\RCSdefDate{\RCSOrientednormalDate}{$Date$}
|
||||
\RCSdef{\RCSOrientable_normalRev}{$Id$}
|
||||
\RCSdefDate{\RCSOrientable_normalDate}{$Date$}
|
||||
% |
|
||||
\ccRefPageBegin
|
||||
%%RefPage: end of header, begin of main body
|
||||
% +------------------------------------------------------------------------+
|
||||
|
||||
|
||||
\begin{ccRefClass}{Oriented_normal_3} %% add template arg's if necessary
|
||||
\begin{ccRefClass}{Orientable_normal_3<Geom_traits>}
|
||||
|
||||
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
||||
%% \ccHtmlIndexC[class]{} %% add further index entries
|
||||
|
|
@ -22,25 +22,27 @@
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccInclude)
|
||||
|
||||
\ccInclude{CGAL/Oriented_normal_3.h}
|
||||
\ccInclude{CGAL/Orientable_normal_3.h}
|
||||
|
||||
%END-AUTO(\ccInclude)
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccDefinition)
|
||||
|
||||
The \ccc{Oriented_normal_3} class represents a normal vector (oriented or not). The normal vector is allocated only when needed.
|
||||
The \ccc{Orientable_normal_3} class represents a normal vector (oriented or not).
|
||||
|
||||
%END-AUTO(\ccDefinition)
|
||||
|
||||
\ccParameters
|
||||
|
||||
The full template declaration is:
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccParameters)
|
||||
|
||||
template$<$ \\
|
||||
class Gt$>$ \\
|
||||
class \ccc{Oriented_normal_3};
|
||||
class \ccc{Orientable_normal_3};
|
||||
|
||||
\begin{description}
|
||||
\item[Parameters:]
|
||||
|
|
@ -50,12 +52,21 @@ class \ccc{Oriented_normal_3};
|
|||
|
||||
%END-AUTO(\ccParameters)
|
||||
|
||||
\ccInheritsFrom
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccInheritsFrom)
|
||||
|
||||
\ccc{Gt::Vector_3}
|
||||
|
||||
%END-AUTO(\ccInheritsFrom)
|
||||
|
||||
\ccIsModel
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccIsModel)
|
||||
|
||||
Model of the \ccc{OrientedNormal_3} concept.
|
||||
Model of the \ccc{OrientableNormal_3} concept.
|
||||
|
||||
%END-AUTO(\ccIsModel)
|
||||
|
||||
|
|
@ -69,33 +80,54 @@ Model of the \ccc{OrientedNormal_3} concept.
|
|||
Kernel's geometric traits.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{FT}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{RT}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vector}
|
||||
{
|
||||
Kernel's \ccc{Vector_3} class.
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccTypes)
|
||||
|
||||
\ccCreation
|
||||
\ccCreationVariable{n} %% choose variable name
|
||||
\ccCreationVariable{n} %% variable name for \ccMethod calls below
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccCreation)
|
||||
|
||||
\ccConstructor{Oriented_normal_3(Null_vector = NULL_VECTOR, bool oriented = true);}
|
||||
\ccConstructor{Orientable_normal_3(Null_vector = NULL_VECTOR, bool oriented = true);}
|
||||
{
|
||||
Normal vector is (0,0,0) by default. Normal is oriented by default.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Oriented_normal_3(const Vector& vector, bool oriented = true);}
|
||||
\ccConstructor{Orientable_normal_3(const Vector& vector, bool oriented = true);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Oriented_normal_3(const Oriented_normal_3<Gt>& that);}
|
||||
\ccConstructor{Orientable_normal_3(FT x, FT y, FT z, bool oriented = true);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Orientable_normal_3(RT hx, RT hy, RT hz, RT hw, bool oriented = true);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Orientable_normal_3(const Orientable_normal_3<Gt>& that);}
|
||||
{
|
||||
Copy constructor.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Orientable_normal_3(const Orientable_normal_3<K>& that);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccCreation)
|
||||
|
||||
|
|
@ -104,14 +136,14 @@ Copy constructor.
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccOperations)
|
||||
|
||||
\ccMethod{Oriented_normal_3& operator=(const Oriented_normal_3<Gt>& that);}
|
||||
\ccMethod{Orientable_normal_3& operator=(const Orientable_normal_3<Gt>& that);}
|
||||
{
|
||||
Operator =().
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Vector get_vector() const;}
|
||||
\ccMethod{const Vector& get_vector() const;}
|
||||
{
|
||||
Get normal vector.
|
||||
Get (a copy of) the actual vector.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{bool is_oriented() const;}
|
||||
|
|
@ -119,38 +151,15 @@ Get normal vector.
|
|||
Get normal orientation.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{void set(Null_vector, bool oriented = true);}
|
||||
{
|
||||
Set normal (vector + orientation).
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{void set(const Vector& vector, bool oriented = true);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccOperations)
|
||||
|
||||
\ccSeeAlso
|
||||
|
||||
\ccc{Vector_3<Geom_traits>} \\
|
||||
\ccc{Lightweight_vector_3<Geom_traits>} \\
|
||||
\ccc{Point_with_normal_3<Geom_traits, Normal_3>}
|
||||
|
||||
\ccExample
|
||||
|
||||
A short example program.
|
||||
Instead of a short program fragment, a full running program can be
|
||||
included using the
|
||||
\verb|\ccIncludeExampleCode{Package/Oriented_normal_3.C}|
|
||||
macro. The program example would be part of the source code distribution and
|
||||
also part of the automatic test suite.
|
||||
|
||||
\begin{ccExampleCode}
|
||||
void your_example_code() {
|
||||
}
|
||||
\end{ccExampleCode}
|
||||
|
||||
%% \ccIncludeExampleCode{Package/Oriented_normal_3.C}
|
||||
|
||||
\end{ccRefClass}
|
||||
|
||||
% +------------------------------------------------------------------------+
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
% | Reference manual page: PointWithNormal_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 19.02.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSPointWithNormalRev}{$Id$}
|
||||
\RCSdefDate{\RCSPointWithNormalDate}{$Date$}
|
||||
|
|
@ -23,7 +23,7 @@
|
|||
%START-AUTO(\ccDefinition)
|
||||
|
||||
A \ccc{PointWithNormal_3} concept represents a 3D point with:\begin{itemize}
|
||||
\item a position\item a normal (oriented or not).\end{itemize}
|
||||
\item a position\item a normal (oriented).\end{itemize}
|
||||
|
||||
%END-AUTO(\ccDefinition)
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ A \ccc{PointWithNormal_3} concept represents a 3D point with:\begin{itemize}
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccRefines)
|
||||
|
||||
\ccc{Kernel::Point_3}, DefaultConstructible, CopyConstructible, and Assignable
|
||||
\ccc{Kernel::Point_3}, DefaultConstructible, CopyConstructible, Assignable, and EqualityComparable
|
||||
|
||||
%END-AUTO(\ccRefines)
|
||||
|
||||
|
|
@ -50,6 +50,10 @@ Kernel's geometric traits.
|
|||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{RT}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Point}
|
||||
{
|
||||
Kernel's \ccc{Point_3} class.
|
||||
|
|
@ -57,7 +61,7 @@ Kernel's \ccc{Point_3} class.
|
|||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
Model of \ccc{Kernel::Vector_3} or of \ccc{OrientableNormal_3}.
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
|
|
@ -71,17 +75,21 @@ Model of \ccc{OrientedNormal_3} concept.
|
|||
|
||||
\ccConstructor{PointWithNormal_3(const Origin& o = ORIGIN);}
|
||||
{
|
||||
Point is (0,0,0) by default. Normal is (0,0,0) by default. Normal is oriented by default.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{PointWithNormal_3(FT x, FT y, FT z);}
|
||||
{
|
||||
Point is (0,0,0) by default. Normal is (0,0,0) by default.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{PointWithNormal_3(const Point& point, const Normal& normal = NULL_VECTOR);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{PointWithNormal_3(FT x, FT y, FT z, const Normal& normal = NULL_VECTOR);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{PointWithNormal_3(RT hx, RT hy, RT hz, RT hw, const Normal& normal = NULL_VECTOR);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccCreation)
|
||||
|
||||
|
|
@ -90,22 +98,14 @@ Point is (0,0,0) by default. Normal is (0,0,0) by default. Normal is oriented by
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccOperations)
|
||||
|
||||
\ccMethod{bool operator==(const PointWithNormal_3& that);}
|
||||
{
|
||||
Compare positions.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{bool operator!=(const PointWithNormal_3& that);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{void set_position(const Point& point);}
|
||||
{
|
||||
Set position.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{const Normal& normal() const;}
|
||||
{
|
||||
Get/set normal (vector + orientation).
|
||||
Get/set normal.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Normal& normal();}
|
||||
|
|
@ -120,8 +120,7 @@ Get/set normal (vector + orientation).
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccHasModels)
|
||||
|
||||
\ccc{Point_with_normal_3<Geom_traits, Normal_3>} \\
|
||||
\ccc{Gyroviz_point_3<Geom_traits>}
|
||||
\ccc{Point_with_normal_3<Geom_traits, Normal_3>}
|
||||
|
||||
%END-AUTO(\ccHasModels)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,18 +1,18 @@
|
|||
% +------------------------------------------------------------------------+
|
||||
% | Reference manual page: PointWithNormal_3.tex
|
||||
% | Reference manual page: PointWithOrientableNormal_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 19.02.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSPointWithNormalRev}{$Id$}
|
||||
\RCSdefDate{\RCSPointWithNormalDate}{$Date$}
|
||||
\RCSdef{\RCSPointWithOrientableNormalRev}{$Id$}
|
||||
\RCSdefDate{\RCSPointWithOrientableNormalDate}{$Date$}
|
||||
% |
|
||||
\ccRefPageBegin
|
||||
%%RefPage: end of header, begin of main body
|
||||
% +------------------------------------------------------------------------+
|
||||
|
||||
|
||||
\begin{ccRefConcept}{PointWithNormal_3}
|
||||
\begin{ccRefConcept}{PointWithOrientableNormal_3}
|
||||
|
||||
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
|
||||
%% \ccHtmlIndexC[concept]{} %% add further index entries
|
||||
|
|
@ -22,9 +22,12 @@
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccDefinition)
|
||||
|
||||
A \ccc{PointWithNormal_3} concept represents a 3D point with:\begin{itemize}
|
||||
A \ccc{PointWithOrientableNormal_3} concept represents a 3D point with:\begin{itemize}
|
||||
\item a position\item a normal (oriented or not).\end{itemize}
|
||||
|
||||
|
||||
It is strictly identical to \ccc{PointWithNormal_3} concept, except that its normal type is a model of \ccc{OrientableNormal_3}.
|
||||
|
||||
%END-AUTO(\ccDefinition)
|
||||
|
||||
\ccRefines
|
||||
|
|
@ -32,7 +35,7 @@ A \ccc{PointWithNormal_3} concept represents a 3D point with:\begin{itemize}
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccRefines)
|
||||
|
||||
\ccc{Kernel::Point_3}, DefaultConstructible, CopyConstructible, and Assignable
|
||||
\ccc{PointWithNormal_3}, DefaultConstructible, CopyConstructible, Assignable, and EqualityComparable
|
||||
|
||||
%END-AUTO(\ccRefines)
|
||||
|
||||
|
|
@ -41,87 +44,20 @@ A \ccc{PointWithNormal_3} concept represents a 3D point with:\begin{itemize}
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccTypes)
|
||||
|
||||
\ccNestedType{Geom_traits}
|
||||
{
|
||||
Kernel's geometric traits.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{FT}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Point}
|
||||
{
|
||||
Kernel's \ccc{Point_3} class.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
Model of \ccc{OrientableNormal_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccTypes)
|
||||
|
||||
\ccCreation
|
||||
\ccCreationVariable{pwn} %% variable name for \ccMethod below
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccCreation)
|
||||
|
||||
\ccConstructor{PointWithNormal_3(const Origin& o = ORIGIN);}
|
||||
{
|
||||
Point is (0,0,0) by default. Normal is (0,0,0) by default. Normal is oriented by default.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{PointWithNormal_3(FT x, FT y, FT z);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{PointWithNormal_3(const Point& point, const Normal& normal = NULL_VECTOR);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccCreation)
|
||||
|
||||
\ccOperations
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccOperations)
|
||||
|
||||
\ccMethod{bool operator==(const PointWithNormal_3& that);}
|
||||
{
|
||||
Compare positions.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{bool operator!=(const PointWithNormal_3& that);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{void set_position(const Point& point);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{const Normal& normal() const;}
|
||||
{
|
||||
Get/set normal (vector + orientation).
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Normal& normal();}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccOperations)
|
||||
|
||||
\ccHasModels
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccHasModels)
|
||||
|
||||
\ccc{Point_with_normal_3<Geom_traits, Normal_3>} \\
|
||||
\ccc{Gyroviz_point_3<Geom_traits>}
|
||||
\ccc{Point_with_normal_3<Geom_traits, Normal_3>} if \ccc{Normal_3} is a model of \ccc{OrientableNormal_3}.
|
||||
|
||||
%END-AUTO(\ccHasModels)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
% | Reference manual page: Point_with_normal_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 19.02.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSPointwithnormalRev}{$Id$}
|
||||
\RCSdefDate{\RCSPointwithnormalDate}{$Date$}
|
||||
|
|
@ -23,7 +23,7 @@
|
|||
%START-AUTO(\ccDefinition)
|
||||
|
||||
The \ccc{Point_with_normal_3} class represents a 3D point with:\begin{itemize}
|
||||
\item a position,\item a normal (oriented or not). The normal vector is allocated only when needed.\end{itemize}
|
||||
\item a position,\item a normal (orientable or always oriented).\end{itemize}
|
||||
|
||||
%END-AUTO(\ccDefinition)
|
||||
|
||||
|
|
@ -42,13 +42,14 @@ The full template declaration is:
|
|||
%START-AUTO(\ccParameters)
|
||||
|
||||
template$<$ \\
|
||||
class Gt$>$ \\
|
||||
class Gt, \\
|
||||
class \ccc{Normal_3} = typename \ccc{Gt::Vector_3}$>$ \\
|
||||
class \ccc{Point_with_normal_3};
|
||||
|
||||
\begin{description}
|
||||
\item[Parameters:]
|
||||
\begin{description}
|
||||
\item[Gt]Kernel's geometric traits. \end{description}
|
||||
\item[Gt]Kernel's geometric traits. \item[\ccc{Normal_3}]Model of \ccc{Kernel::Vector_3} or of \ccc{OrientableNormal_3}. \end{description}
|
||||
\end{description}
|
||||
|
||||
%END-AUTO(\ccParameters)
|
||||
|
|
@ -67,7 +68,8 @@ class \ccc{Point_with_normal_3};
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccIsModel)
|
||||
|
||||
Model of the \ccc{PointWithNormal_3} concept.
|
||||
\begin{itemize}
|
||||
\item Model of the \ccc{PointWithNormal_3} concept.\item Model of the \ccc{PointWithOrientableNormal_3} if \ccc{Normal_3} is a model of \ccc{OrientableNormal_3} concept.\end{itemize}
|
||||
|
||||
%END-AUTO(\ccIsModel)
|
||||
|
||||
|
|
@ -85,6 +87,10 @@ Kernel's geometric traits.
|
|||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{RT}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Point}
|
||||
{
|
||||
Kernel's \ccc{Point_3} class.
|
||||
|
|
@ -92,7 +98,7 @@ Kernel's \ccc{Point_3} class.
|
|||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
Model of \ccc{Kernel::Vector_3} or of \ccc{OrientableNormal_3}.
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
|
|
@ -109,7 +115,11 @@ Model of \ccc{OrientedNormal_3} concept.
|
|||
Point is (0,0,0) by default. Normal is (0,0,0) by default. Normal is oriented by default.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Point_with_normal_3(FT x, FT y, FT z);}
|
||||
\ccConstructor{Point_with_normal_3(FT x, FT y, FT z, const Normal& normal = NULL_VECTOR);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Point_with_normal_3(RT hx, RT hy, RT hz, RT hw, const Normal& normal = NULL_VECTOR);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
|
@ -117,6 +127,15 @@ Point is (0,0,0) by default. Normal is (0,0,0) by default. Normal is oriented by
|
|||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Point_with_normal_3(const Point_with_normal_3<Gt, Normal_3>& pwn);}
|
||||
{
|
||||
Copy constructor.
|
||||
}
|
||||
\ccGlue
|
||||
\ccConstructor{Point_with_normal_3(const Point_with_normal_3<K, N>& pwn);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
%END-AUTO(\ccCreation)
|
||||
|
||||
|
|
@ -125,22 +144,19 @@ Point is (0,0,0) by default. Normal is (0,0,0) by default. Normal is oriented by
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccOperations)
|
||||
|
||||
\ccMethod{bool operator==(const Point_with_normal_3<Gt>& that);}
|
||||
{
|
||||
Compare positions.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{bool operator!=(const Point_with_normal_3<Gt>& that);}
|
||||
\ccMethod{Point_with_normal_3& operator=(const Point_with_normal_3<Gt, Normal_3>& pwn);}
|
||||
{
|
||||
Operator =().
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{void set_position(const Point& point);}
|
||||
{
|
||||
Set position.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{const Normal& normal() const;}
|
||||
{
|
||||
Get/set normal (vector + orientation).
|
||||
Get/set normal.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{Normal& normal();}
|
||||
|
|
|
|||
|
|
@ -93,6 +93,10 @@ Kernel's geometric traits.
|
|||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vector}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Iso_cuboid}
|
||||
{
|
||||
}
|
||||
|
|
@ -108,11 +112,7 @@ Model of \ccc{PointWithNormal_3}.
|
|||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vector}
|
||||
{
|
||||
Model of \ccc{Kernel::Vector_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
|
||||
|
|
@ -210,12 +210,18 @@ Compute the Poisson indicator function f() at each vertex of the triangulation.
|
|||
{
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{unsigned int delaunay_refinement(const FT threshold, unsigned int maximum, const FT enlarge_ratio, unsigned int restart_each);}
|
||||
\ccMethod{unsigned int delaunay_refinement(FT radius_edge_ratio_bound, FT cell_radius_bound, unsigned int max_vertices, FT enlarge_ratio);}
|
||||
{
|
||||
Delaunay refinement (break bad tetrahedra, where bad means badly shaped or too big). The normal of Steiner points is set to zero. Return the number of vertices inserted.
|
||||
}
|
||||
\ccGlue
|
||||
\ccMethod{unsigned int delaunay_refinement_shell(FT size_shell, FT sizing, unsigned int maximum);}
|
||||
\begin{description}
|
||||
\item[Parameters: ]
|
||||
\begin{description}
|
||||
\item[\ccc{radius_edge_ratio_bound}]radius edge ratio bound (ignored if zero) \item[\ccc{cell_radius_bound}]cell radius bound (ignored if zero) \item[\ccc{max_vertices}]number of vertices bound \item[\ccc{enlarge_ratio}]bounding box enlarge ratio \end{description}
|
||||
\end{description}
|
||||
\ccGlue
|
||||
\ccMethod{unsigned int delaunay_refinement_shell(FT size_shell, FT sizing, unsigned int max_vertices);}
|
||||
{
|
||||
}
|
||||
\ccGlue
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ Model of \ccc{PointWithNormal_3}.
|
|||
\ccGlue
|
||||
\ccNestedType{Normal}
|
||||
{
|
||||
Model of \ccc{OrientedNormal_3} concept.
|
||||
Model of \ccc{Kernel::Vector_3} concept.
|
||||
}
|
||||
\ccGlue
|
||||
\ccNestedType{Vector}
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
% | Reference manual page: estimate_normals_jet_fitting_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 19.02.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSestimatenormalsjetfittingRev}{$Id$}
|
||||
\RCSdefDate{\RCSestimatenormalsjetfittingDate}{$Date$}
|
||||
|
|
@ -18,7 +18,7 @@
|
|||
%% \ccHtmlIndexC[function]{} %% add further index entries
|
||||
|
||||
\ccDefinition
|
||||
|
||||
|
||||
\ccInclude{CGAL/estimate_normals_jet_fitting_3.h}
|
||||
|
||||
% The section below is automatically generated. Do not edit!
|
||||
|
|
@ -91,8 +91,8 @@ OutputIterator \\
|
|||
|
||||
TODO: add short example program.
|
||||
Instead of a short program fragment, a full running program can be
|
||||
included using the
|
||||
\verb|\ccIncludeExampleCode{Package/estimate_normals_jet_fitting_3.C}|
|
||||
included using the
|
||||
\verb|\ccIncludeExampleCode{Package/estimate_normals_jet_fitting_3.C}|
|
||||
macro. The program example would be part of the source code distribution and
|
||||
also part of the automatic test suite.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
% | Reference manual page: estimate_normals_pca_3.tex
|
||||
% +------------------------------------------------------------------------+
|
||||
% | 14.02.2008 Laurent Saboret, Pierre Alliez
|
||||
% | Package: Package
|
||||
% | Package: Surface_reconstruction_3
|
||||
% |
|
||||
\RCSdef{\RCSestimatenormalspcaRev}{$Id$}
|
||||
\RCSdefDate{\RCSestimatenormalspcaDate}{$Date$}
|
||||
|
|
|
|||
|
|
@ -17,12 +17,14 @@
|
|||
\input{Surface_reconstruction_3_ref/ImplicitFctDelaunayTriangulationCellBase_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/Implicit_fct_delaunay_triangulation_vertex_base_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/ImplicitFctDelaunayTriangulationVertexBase_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/Lightweight_vector_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/merge_epsilon_nearest_points_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/Oriented_normal_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/OrientedNormal_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/Orientable_normal_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/OrientableNormal_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/orient_normals_minimum_spanning_tree_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/Point_with_normal_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/PointWithNormal_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/PointWithOrientableNormal_3.tex}
|
||||
\input{Surface_reconstruction_3_ref/Poisson_implicit_function.tex}
|
||||
\input{Surface_reconstruction_3_ref/ReconstructionImplicitFunction.tex}
|
||||
\input{Surface_reconstruction_3_ref/remove_outliers_wrt_avg_knn_sq_distance_3.tex}
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ Precondition: epsilon $>$ 0.
|
|||
\ccFunction{ForwardIterator merge_epsilon_nearest_points_3(ForwardIterator first, ForwardIterator beyond, double epsilon, const Kernel &);}
|
||||
{
|
||||
Merge points which belong to the same cell of a grid of cell size = epsilon. This function is mutating the input point set. This variant requires the kernel.
|
||||
Precondition: epsilon $>$ 0.
|
||||
Warning: This method modifies the order of points, thus Precondition: epsilon $>$ 0.
|
||||
}
|
||||
\ccGlue
|
||||
\begin{description}
|
||||
|
|
@ -82,7 +82,7 @@ Precondition: epsilon $>$ 0.
|
|||
\ccFunction{ForwardIterator merge_epsilon_nearest_points_3(ForwardIterator first, ForwardIterator beyond, double epsilon);}
|
||||
{
|
||||
Merge points which belong to the same cell of a grid of cell size = epsilon. This function is mutating the input point set. This variant deduces the kernel from iterator types.
|
||||
Precondition: epsilon $>$ 0.
|
||||
Warning: This method modifies the order of points, thus Precondition: epsilon $>$ 0.
|
||||
}
|
||||
\ccGlue
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ Precondition: KNN $>$= 2.
|
|||
{
|
||||
Remove outliers:\begin{itemize}
|
||||
\item compute average squared distance to the K nearest neighbors,\item percentage of points to remove. This function is mutating the input point set. This variant requires the kernel.\end{itemize}
|
||||
Precondition: KNN $>$= 2.
|
||||
Warning: This method modifies the order of points, thus Precondition: KNN $>$= 2.
|
||||
}
|
||||
\ccGlue
|
||||
\begin{description}
|
||||
|
|
@ -86,7 +86,7 @@ Precondition: KNN $>$= 2.
|
|||
{
|
||||
Remove outliers:\begin{itemize}
|
||||
\item compute average squared distance to the K nearest neighbors,\item percentage of points to remove. This function is mutating the input point set. This variant deduces the kernel from iterator types.\end{itemize}
|
||||
Precondition: KNN $>$= 2.
|
||||
Warning: This method modifies the order of points, thus Precondition: KNN $>$= 2.
|
||||
}
|
||||
\ccGlue
|
||||
\begin{description}
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
% The section below is automatically generated. Do not edit!
|
||||
%START-AUTO(\ccDefinition)
|
||||
|
||||
\ccFunction{Point smooth_jet_fitting_3(const typename Kernel::Point_3& query, Tree& tree, const unsigned int KNN, const unsigned int degre_fitting, const unsigned int degree_monge);}
|
||||
\ccFunction{Kernel::Point_3 smooth_jet_fitting_3(const typename Kernel::Point_3& query, Tree& tree, const unsigned int KNN, const unsigned int degre_fitting, const unsigned int degree_monge);}
|
||||
{
|
||||
Smooth one point position using jet fitting on the KNN nearest neighbors and reprojection onto the jet.
|
||||
Precondition: KNN $>$= 2.
|
||||
|
|
@ -31,7 +31,7 @@ Precondition: KNN $>$= 2.
|
|||
\begin{description}
|
||||
\item[Template Parameters:]
|
||||
\begin{description}
|
||||
\item[Kernel]Geometric traits class. \item[Tree]KD-tree. \item[Point]Type of return value.\end{description}
|
||||
\item[Kernel]Geometric traits class. \item[Tree]KD-tree.\end{description}
|
||||
\end{description}
|
||||
\begin{description}
|
||||
\item[Returns:]computed point \end{description}
|
||||
|
|
@ -50,7 +50,7 @@ Precondition: KNN $>$= 2.
|
|||
\begin{description}
|
||||
\item[Template Parameters:]
|
||||
\begin{description}
|
||||
\item[InputIterator]\ccc{value_type} is \ccc{Point_3}. \item[OutputIterator]\ccc{value_type} is \ccc{Point_3}. \item[Kernel]Geometric traits class.\end{description}
|
||||
\item[InputIterator]\ccc{value_type} convertible to \ccc{Point_3}. \item[OutputIterator]\ccc{value_type} convertible to \ccc{Point_3}. \item[Kernel]Geometric traits class.\end{description}
|
||||
\end{description}
|
||||
\begin{description}
|
||||
\item[Returns:]past-the-end output iterator. \end{description}
|
||||
|
|
@ -63,13 +63,13 @@ Precondition: KNN $>$= 2.
|
|||
\ccFunction{void smooth_jet_fitting_3(ForwardIterator first, ForwardIterator beyond, unsigned int KNN, const Kernel &, const unsigned int degre_fitting = 2, const unsigned int degree_monge = 2);}
|
||||
{
|
||||
Smooth a point set using jet fitting on the KNN nearest neighbors and reprojection onto the jet. This function is mutating the input point set. This variant requires the kernel.
|
||||
Precondition: KNN $>$= 2.
|
||||
Warning: This method moves the points, thus Precondition: KNN $>$= 2.
|
||||
}
|
||||
\ccGlue
|
||||
\begin{description}
|
||||
\item[Template Parameters:]
|
||||
\begin{description}
|
||||
\item[ForwardIterator]\ccc{value_type} is \ccc{Point_3}. \item[Kernel]Geometric traits class. \end{description}
|
||||
\item[ForwardIterator]\ccc{value_type} convertible to \ccc{Point_3}. \item[Kernel]Geometric traits class. \end{description}
|
||||
\end{description}
|
||||
\begin{description}
|
||||
\item[Parameters: ]
|
||||
|
|
@ -94,13 +94,13 @@ Precondition: KNN $>$= 2.
|
|||
\ccFunction{void smooth_jet_fitting_3(ForwardIterator first, ForwardIterator beyond, unsigned int KNN, const unsigned int degre_fitting = 2, const unsigned int degree_monge = 2);}
|
||||
{
|
||||
Smooth a point set using jet fitting on the KNN nearest neighbors and reprojection onto the jet. This function is mutating the input point set. This variant deduces the kernel from iterator types.
|
||||
Precondition: KNN $>$= 2.
|
||||
Warning: This method moves the points, thus Precondition: KNN $>$= 2.
|
||||
}
|
||||
\ccGlue
|
||||
\begin{description}
|
||||
\item[Template Parameters:]
|
||||
\begin{description}
|
||||
\item[ForwardIterator]\ccc{value_type} is \ccc{Point_3}. \end{description}
|
||||
\item[ForwardIterator]\ccc{value_type} convertible to \ccc{Point_3}. \end{description}
|
||||
\end{description}
|
||||
\begin{description}
|
||||
\item[Parameters: ]
|
||||
|
|
@ -122,9 +122,8 @@ The full template declarations are:
|
|||
|
||||
template$<$ \\
|
||||
typename Kernel, \\
|
||||
typename Tree, \\
|
||||
typename Point$>$ \\
|
||||
Point \\
|
||||
typename Tree$>$ \\
|
||||
\ccc{Kernel::Point_3} \\
|
||||
\ccc{smooth_jet_fitting_3} (const typename \ccc{Kernel::Point_3} \&query, Tree \&tree, const unsigned int KNN, const unsigned int \ccc{degre_fitting}, const unsigned int \ccc{degree_monge}); \\
|
||||
\\
|
||||
template$<$ \\
|
||||
|
|
|
|||
|
|
@ -30,9 +30,9 @@ CGAL_BEGIN_NAMESPACE
|
|||
/// - a position,
|
||||
/// - a normal (orientable or always oriented).
|
||||
///
|
||||
/// @heading Is Model for the Concepts:
|
||||
/// Model of the PointWithNormal_3 concept.
|
||||
/// Model of the PointWithOrientableNormal_3 if Normal_3 is a model of OrientableNormal_3 concept.
|
||||
/// @heading Is Model for the Concepts:
|
||||
/// - Model of the PointWithNormal_3 concept.
|
||||
/// - Model of the PointWithOrientableNormal_3 if Normal_3 is a model of OrientableNormal_3 concept.
|
||||
///
|
||||
/// @heading Parameters:
|
||||
/// @param Gt Kernel's geometric traits.
|
||||
|
|
@ -67,13 +67,13 @@ public:
|
|||
}
|
||||
Point_with_normal_3(FT x, FT y, FT z,
|
||||
const Normal& normal = NULL_VECTOR)
|
||||
: Base(x,y,z),
|
||||
: Base(x,y,z),
|
||||
m_normal(normal)
|
||||
{
|
||||
}
|
||||
Point_with_normal_3(RT hx, RT hy, RT hz, RT hw,
|
||||
const Normal& normal = NULL_VECTOR)
|
||||
: Base(hx,hy,hz,hw),
|
||||
: Base(hx,hy,hz,hw),
|
||||
m_normal(normal)
|
||||
{
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue