Tentative Version for CGAL2.0

namespace introduced
This commit is contained in:
Mariette Yvinec 1999-05-18 11:23:44 +00:00
parent 19a4336071
commit d44fc73b93
2 changed files with 138 additions and 138 deletions

View File

@ -24,7 +24,7 @@ in Minneapolis\footnote{\tt http://www.geom.umn.edu/}.
must be \ccc{(echo "started")}. The two commands \ccc{rsh} and \ccc{geomview}
must be in the user's path, otherwise the program will not be able to execute.
\begin{ccClass}{CGAL_Geomview_stream}
\begin{ccClass}{Geomview_stream}
\ccDefinition
An object of the class \ccClassName\ is a stream in which geometric
objects can be inserted and where geometric objects can be extracted
@ -33,13 +33,13 @@ a remote machine.
\ccInclude{CGAL/IO/Geomview_stream.h}
\ccSetThreeColumns{CGAL_Geomview_stream& }{}{\hspace*{10cm}}
\ccSetThreeColumns{Geomview_stream& }{}{\hspace*{10cm}}
\ccThreeToTwo
\ccCreation
\ccCreationVariable{G}
\ccConstructor{CGAL_Geomview_stream(const CGAL_Bbox_3 &bbox
= CGAL_Bbox_3(0,0,0, 1,1,1),
\ccConstructor{Geomview_stream(const Bbox_3 &bbox
= Bbox_3(0,0,0, 1,1,1),
const char *machine = NULL,
const char *login = NULL);}
{Introduces a geomview stream \ccVar\ with a camera that sees the
@ -60,59 +60,59 @@ At the moment not all classes of the \cgal\ kernel have output
operators. 2D objects are embedded in the \ccc{xy}-plane.
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Point_2<R>& p);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Point_2<R>& p);}
{Inserts the point \ccc{p} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Point_3<R>& p);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Point_3<R>& p);}
{Inserts the point \ccc{p} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Segment_2<R>& s);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Segment_2<R>& s);}
{Inserts the segment \ccc{s} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Segment_3<R>& s);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Segment_3<R>& s);}
{Inserts the segment \ccc{s} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Triangle_2<R>& t);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Triangle_2<R>& t);}
{Inserts the triangle \ccc{t} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Triangle_3<R>& t);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Triangle_3<R>& t);}
{Inserts the triangle \ccc{t} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Tetrahedron_3<R>& t);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Tetrahedron_3<R>& t);}
{Inserts the tetrahedron \ccc{t} into the stream \ccVar.}
\ccMethod{CGAL_Geomview_stream&
operator<<(const CGAL_Bbox_2& b);}
\ccMethod{Geomview_stream&
operator<<(const Bbox_2& b);}
{Inserts the bounding box \ccc{b} into the stream \ccVar.}
\ccMethod{CGAL_Geomview_stream&
operator<<(const CGAL_Bbox_3& b);}
\ccMethod{Geomview_stream&
operator<<(const Bbox_3& b);}
{Inserts the bounding box \ccc{b} into the stream \ccVar.}
@ -123,9 +123,9 @@ a point on the {\it pick plane} with the right mouse button. The pick plane
can be moved anywhere with the left mouse button, before a point is entered.
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator>>(CGAL_Geomview_stream& G,
CGAL_Point_3<R>& p);}
Geomview_stream&
operator>>(Geomview_stream& G,
Point_3<R>& p);}
{Extracts the point \ccc{p} from the stream \ccVar. The point is
echoed.}
@ -137,9 +137,9 @@ a point on the {\it pickplane} with the right mouse button. The pickplane
can be moved anywhere with the left mouse button, before a point is entered.
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator>>(CGAL_Geomview_stream& G,
CGAL_Point_3<R>& p);}
Geomview_stream&
operator>>(Geomview_stream& G,
Point_3<R>& p);}
{Extracts the point \ccc{p} from the stream \ccVar. The point is
echoed.}
@ -147,17 +147,17 @@ can be moved anywhere with the left mouse button, before a point is entered.
\ccHeading{Output Operators for CGAL Basic Library Classes}
\ccFunction{template <class Traits, class HDS>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream &G,
const CGAL_Polyhedron_3<Traits,HDS> &P);}
Geomview_stream&
operator<<(Geomview_stream &G,
const Polyhedron_3<Traits,HDS> &P);}
{Inserts the polyhedron \ccc{P} into the stream \ccVar.}
%% There is no tetrahedralization class at the moment
%%
%% \ccFunction{template <class Traits>
%% CGAL_Geomview_stream&
%% operator<<(CGAL_Geomview_stream& G,
%% const CGAL_Tetrahedralization_3<Traits>& T);}
%% Geomview_stream&
%% operator<<(Geomview_stream& G,
%% const Tetrahedralization_3<Traits>& T);}
%% {Inserts the tetrahedralization \ccc{T} into the stream \ccVar.}
%%
%% For geometric structures as a tetrahedalization only one geomview
@ -165,16 +165,16 @@ operator<<(CGAL_Geomview_stream &G,
%% to insert the simplices individually with the following operator.
%%
%% \ccFunction{template <class V>
%% CGAL_Geomview_stream&
%% operator<<(CGAL_Geomview_stream& G,
%% const CGAL_Tetrahedralization_simplex<V>* s);}
%% Geomview_stream&
%% operator<<(Geomview_stream& G,
%% const Tetrahedralization_simplex<V>* s);}
%% {Inserts the tetrahedralization simplex \ccc{s} into the stream \ccVar.}
%%
%%
%% \ccFunction{template < class V >
%% CGAL_Geomview_stream&
%% operator>>(CGAL_Geomview_stream &G,
%% CGAL_Tetrahedralization_simplex<V>*& s);}
%% Geomview_stream&
%% operator>>(Geomview_stream &G,
%% Tetrahedralization_simplex<V>*& s);}
%% {Assigns the pointer to the tetrahedralization simplex the user selected
%% with the right mouse button to variable \ccc{s}.
%% \ccPrecond It is in the responsibility of the user to guarantee that the
@ -182,9 +182,9 @@ operator<<(CGAL_Geomview_stream &G,
%%
%%
%% \ccFunction{template <class P>
%% CGAL_Geomview_stream&
%% operator<<(CGAL_Geomview_stream& G,
%% const CGAL_Tetrahedralization_vertex<P>* v);}
%% Geomview_stream&
%% operator<<(Geomview_stream& G,
%% const Tetrahedralization_vertex<P>* v);}
%% {Inserts the tetrahedralization vertex \ccc{v} into the stream \ccVar.
%% Vertices are drawn as a cube with twice \ccc{G.get_vertex_radius}
%% as side length. This value is 1/100'th of the \ccc{x}-length of the
@ -192,9 +192,9 @@ operator<<(CGAL_Geomview_stream &G,
%%
%%
%% \ccFunction{template < class P>
%% CGAL_Geomview_stream&
%% operator>>(CGAL_Geomview_stream &G,
%% CGAL_Tetrahedralization_vertex<V>*& v);}
%% Geomview_stream&
%% operator>>(Geomview_stream &G,
%% Tetrahedralization_vertex<V>*& v);}
%% {Assigns the pointer to the tetrahedralization vertex the user selected
%% with the right mouse button to variable \ccc{v}.
%% \ccPrecond It is in the responsibility of the user to guarantee that the
@ -207,26 +207,26 @@ operator<<(CGAL_Geomview_stream &G,
geomview distinguishes between edge and face colors. The edge color
is at the same time the color of vertices.
\ccMethod{CGAL_Geomview_stream&
operator<<(const CGAL_Color& c);}
\ccMethod{Geomview_stream&
operator<<(const Color& c);}
{Makes \ccc{c} the color of vertices, edges and faces in subsequent IO
operations.}
\ccMethod{CGAL_Color
set_bg_color(const CGAL_Color& c);}
\ccMethod{Color
set_bg_color(const Color& c);}
{Changes the background color. Returns the old value.}
\ccMethod{CGAL_Color
set_vertex_color(const CGAL_Color& c);}
\ccMethod{Color
set_vertex_color(const Color& c);}
{Changes the vertex color. Returns the old value.}
\ccMethod{CGAL_Color
set_edge_color(const CGAL_Color& c);}
\ccMethod{Color
set_edge_color(const Color& c);}
{Changes the edge color. Returns the old value.}
\ccMethod{CGAL_Color
set_face_color(const CGAL_Color& c);}
\ccMethod{Color
set_face_color(const Color& c);}
{Changes the face color. Returns the old value.}
@ -275,23 +275,23 @@ The following functions are helpful if you develop your own insert
and extract functions. The following functions allow to pass a string
from geomview and to read data sent back by geomview.
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(const char* s);}
{Inserts string \ccc{s} into the stream.}
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator>>(char* s);}
{Extracts a string \ccc{s} from the stream.
\ccPrecond You have to allocate enough memory.}
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(int i);}
{Inserts integer \ccc{i} into the stream. Puts whitespace around if the
stream is in ascii mode.}
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(double d);}
{Inserts double \ccc{d} into the stream. Puts whitespace around if the
stream is in ascii mode.}
@ -308,11 +308,11 @@ stream is in ascii mode.}
For convenience we offer the manipulators \ccc{ascii} and \ccc{binary}
that can be inserted in the stream.
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(ascii);}
{Sets the stream in ascii mode.}
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(binary);}
{Sets the stream in binary mode.}

View File

@ -24,7 +24,7 @@ in Minneapolis\footnote{\tt http://www.geom.umn.edu/}.
must be \ccc{(echo "started")}. The two commands \ccc{rsh} and \ccc{geomview}
must be in the user's path, otherwise the program will not be able to execute.
\begin{ccClass}{CGAL_Geomview_stream}
\begin{ccClass}{Geomview_stream}
\ccDefinition
An object of the class \ccClassName\ is a stream in which geometric
objects can be inserted and where geometric objects can be extracted
@ -33,13 +33,13 @@ a remote machine.
\ccInclude{CGAL/IO/Geomview_stream.h}
\ccSetThreeColumns{CGAL_Geomview_stream& }{}{\hspace*{10cm}}
\ccSetThreeColumns{Geomview_stream& }{}{\hspace*{10cm}}
\ccThreeToTwo
\ccCreation
\ccCreationVariable{G}
\ccConstructor{CGAL_Geomview_stream(const CGAL_Bbox_3 &bbox
= CGAL_Bbox_3(0,0,0, 1,1,1),
\ccConstructor{Geomview_stream(const Bbox_3 &bbox
= Bbox_3(0,0,0, 1,1,1),
const char *machine = NULL,
const char *login = NULL);}
{Introduces a geomview stream \ccVar\ with a camera that sees the
@ -60,59 +60,59 @@ At the moment not all classes of the \cgal\ kernel have output
operators. 2D objects are embedded in the \ccc{xy}-plane.
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Point_2<R>& p);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Point_2<R>& p);}
{Inserts the point \ccc{p} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Point_3<R>& p);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Point_3<R>& p);}
{Inserts the point \ccc{p} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Segment_2<R>& s);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Segment_2<R>& s);}
{Inserts the segment \ccc{s} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Segment_3<R>& s);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Segment_3<R>& s);}
{Inserts the segment \ccc{s} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Triangle_2<R>& t);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Triangle_2<R>& t);}
{Inserts the triangle \ccc{t} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Triangle_3<R>& t);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Triangle_3<R>& t);}
{Inserts the triangle \ccc{t} into the stream \ccVar.}
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream& G,
const CGAL_Tetrahedron_3<R>& t);}
Geomview_stream&
operator<<(Geomview_stream& G,
const Tetrahedron_3<R>& t);}
{Inserts the tetrahedron \ccc{t} into the stream \ccVar.}
\ccMethod{CGAL_Geomview_stream&
operator<<(const CGAL_Bbox_2& b);}
\ccMethod{Geomview_stream&
operator<<(const Bbox_2& b);}
{Inserts the bounding box \ccc{b} into the stream \ccVar.}
\ccMethod{CGAL_Geomview_stream&
operator<<(const CGAL_Bbox_3& b);}
\ccMethod{Geomview_stream&
operator<<(const Bbox_3& b);}
{Inserts the bounding box \ccc{b} into the stream \ccVar.}
@ -123,9 +123,9 @@ a point on the {\it pick plane} with the right mouse button. The pick plane
can be moved anywhere with the left mouse button, before a point is entered.
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator>>(CGAL_Geomview_stream& G,
CGAL_Point_3<R>& p);}
Geomview_stream&
operator>>(Geomview_stream& G,
Point_3<R>& p);}
{Extracts the point \ccc{p} from the stream \ccVar. The point is
echoed.}
@ -137,9 +137,9 @@ a point on the {\it pickplane} with the right mouse button. The pickplane
can be moved anywhere with the left mouse button, before a point is entered.
\ccFunction{template <class R>
CGAL_Geomview_stream&
operator>>(CGAL_Geomview_stream& G,
CGAL_Point_3<R>& p);}
Geomview_stream&
operator>>(Geomview_stream& G,
Point_3<R>& p);}
{Extracts the point \ccc{p} from the stream \ccVar. The point is
echoed.}
@ -147,17 +147,17 @@ can be moved anywhere with the left mouse button, before a point is entered.
\ccHeading{Output Operators for CGAL Basic Library Classes}
\ccFunction{template <class Traits, class HDS>
CGAL_Geomview_stream&
operator<<(CGAL_Geomview_stream &G,
const CGAL_Polyhedron_3<Traits,HDS> &P);}
Geomview_stream&
operator<<(Geomview_stream &G,
const Polyhedron_3<Traits,HDS> &P);}
{Inserts the polyhedron \ccc{P} into the stream \ccVar.}
%% There is no tetrahedralization class at the moment
%%
%% \ccFunction{template <class Traits>
%% CGAL_Geomview_stream&
%% operator<<(CGAL_Geomview_stream& G,
%% const CGAL_Tetrahedralization_3<Traits>& T);}
%% Geomview_stream&
%% operator<<(Geomview_stream& G,
%% const Tetrahedralization_3<Traits>& T);}
%% {Inserts the tetrahedralization \ccc{T} into the stream \ccVar.}
%%
%% For geometric structures as a tetrahedalization only one geomview
@ -165,16 +165,16 @@ operator<<(CGAL_Geomview_stream &G,
%% to insert the simplices individually with the following operator.
%%
%% \ccFunction{template <class V>
%% CGAL_Geomview_stream&
%% operator<<(CGAL_Geomview_stream& G,
%% const CGAL_Tetrahedralization_simplex<V>* s);}
%% Geomview_stream&
%% operator<<(Geomview_stream& G,
%% const Tetrahedralization_simplex<V>* s);}
%% {Inserts the tetrahedralization simplex \ccc{s} into the stream \ccVar.}
%%
%%
%% \ccFunction{template < class V >
%% CGAL_Geomview_stream&
%% operator>>(CGAL_Geomview_stream &G,
%% CGAL_Tetrahedralization_simplex<V>*& s);}
%% Geomview_stream&
%% operator>>(Geomview_stream &G,
%% Tetrahedralization_simplex<V>*& s);}
%% {Assigns the pointer to the tetrahedralization simplex the user selected
%% with the right mouse button to variable \ccc{s}.
%% \ccPrecond It is in the responsibility of the user to guarantee that the
@ -182,9 +182,9 @@ operator<<(CGAL_Geomview_stream &G,
%%
%%
%% \ccFunction{template <class P>
%% CGAL_Geomview_stream&
%% operator<<(CGAL_Geomview_stream& G,
%% const CGAL_Tetrahedralization_vertex<P>* v);}
%% Geomview_stream&
%% operator<<(Geomview_stream& G,
%% const Tetrahedralization_vertex<P>* v);}
%% {Inserts the tetrahedralization vertex \ccc{v} into the stream \ccVar.
%% Vertices are drawn as a cube with twice \ccc{G.get_vertex_radius}
%% as side length. This value is 1/100'th of the \ccc{x}-length of the
@ -192,9 +192,9 @@ operator<<(CGAL_Geomview_stream &G,
%%
%%
%% \ccFunction{template < class P>
%% CGAL_Geomview_stream&
%% operator>>(CGAL_Geomview_stream &G,
%% CGAL_Tetrahedralization_vertex<V>*& v);}
%% Geomview_stream&
%% operator>>(Geomview_stream &G,
%% Tetrahedralization_vertex<V>*& v);}
%% {Assigns the pointer to the tetrahedralization vertex the user selected
%% with the right mouse button to variable \ccc{v}.
%% \ccPrecond It is in the responsibility of the user to guarantee that the
@ -207,26 +207,26 @@ operator<<(CGAL_Geomview_stream &G,
geomview distinguishes between edge and face colors. The edge color
is at the same time the color of vertices.
\ccMethod{CGAL_Geomview_stream&
operator<<(const CGAL_Color& c);}
\ccMethod{Geomview_stream&
operator<<(const Color& c);}
{Makes \ccc{c} the color of vertices, edges and faces in subsequent IO
operations.}
\ccMethod{CGAL_Color
set_bg_color(const CGAL_Color& c);}
\ccMethod{Color
set_bg_color(const Color& c);}
{Changes the background color. Returns the old value.}
\ccMethod{CGAL_Color
set_vertex_color(const CGAL_Color& c);}
\ccMethod{Color
set_vertex_color(const Color& c);}
{Changes the vertex color. Returns the old value.}
\ccMethod{CGAL_Color
set_edge_color(const CGAL_Color& c);}
\ccMethod{Color
set_edge_color(const Color& c);}
{Changes the edge color. Returns the old value.}
\ccMethod{CGAL_Color
set_face_color(const CGAL_Color& c);}
\ccMethod{Color
set_face_color(const Color& c);}
{Changes the face color. Returns the old value.}
@ -275,23 +275,23 @@ The following functions are helpful if you develop your own insert
and extract functions. The following functions allow to pass a string
from geomview and to read data sent back by geomview.
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(const char* s);}
{Inserts string \ccc{s} into the stream.}
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator>>(char* s);}
{Extracts a string \ccc{s} from the stream.
\ccPrecond You have to allocate enough memory.}
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(int i);}
{Inserts integer \ccc{i} into the stream. Puts whitespace around if the
stream is in ascii mode.}
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(double d);}
{Inserts double \ccc{d} into the stream. Puts whitespace around if the
stream is in ascii mode.}
@ -308,11 +308,11 @@ stream is in ascii mode.}
For convenience we offer the manipulators \ccc{ascii} and \ccc{binary}
that can be inserted in the stream.
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(ascii);}
{Sets the stream in ascii mode.}
\ccMethod{CGAL_Geomview_stream&
\ccMethod{Geomview_stream&
operator<<(binary);}
{Sets the stream in binary mode.}