cgal/GraphicsView/doc_tex/GraphicsView_ref/GraphicsViewPolylineInput.tex

48 lines
1.4 KiB
TeX

\ccDefGlobalScope{CGAL::}
\begin{ccRefClass}[Qt::]{GraphicsViewPolylineInput<K>}
\ccDefinition
An object of type \ccRefName\ creates a list of points. A new
vertex is inserted every time the left mouse button is pressed.
The list of points is emitted on a right click or when the number of
points specified in the constructor is reached. You can use the \ccc{Escape}
key if you want to remove your last entered point in the polygon.
The tool can serve at the same time for entering a single point,
a polyline with a given number of points, and for open and closed
polylines.
\ccInclude{CGAL/Qt/GraphicsViewPolylineInput.h}
\ccParameters
The template parameter of \ccc{GraphicsViewPolylineInput<K>} must be a \cgal\ \ccc{Kernel}.
\ccInheritsFrom
\ccc{Qt::GraphicsViewInput}
\ccGlue
\ccCreation
\ccCreationVariable{in}
\ccSetTwoColumns{GraphicsViewPolylineInput}{}
\ccConstructor{GraphicsViewPolylineInput<T>(QGraphicsScene* s, int n = 0,
bool closed = true);}
{\ccc{s} is the scene where we want to draw the polyline. \ccc{n} is the
number of points of the polyline to generate. If \ccc{c} is equal to 0,
the default value, the number of points of the polyline is not
limited. When \ccc{closed} is \ccc{true} the function displays a
polygon.}
\ccMethod{void generate(CGAL::Object o);}{The object \ccc{o} contains a \ccc{std:list<K::Point_2>}.}
\end{ccRefClass}