mirror of https://github.com/CGAL/cgal
small improvements of the reference manual pages
This commit is contained in:
parent
f2431c2d74
commit
806dcfd607
|
|
@ -4,7 +4,7 @@
|
|||
\ccDefinition
|
||||
An object of type \ccRefName\ converts 2D \cgal\ kernel objects to their equivalent
|
||||
objects in \qt, and the other way round. Note that some objects have no equivalent.
|
||||
For exmaple the \ccc{CGAL::Circle_2<K>} cannot be converted to something in Qt,
|
||||
For example the \ccc{CGAL::Circle_2<K>} cannot be converted to something in Qt,
|
||||
and the unbounded objects \ccc{CGAL::Ray_2<K>} and \ccc{CGAL::Line_2<K>} are clipped.
|
||||
|
||||
\ccInclude{CGAL/Qt/Converter.h}
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@
|
|||
An object of type \ccRefName\ creates a circle, defined by either
|
||||
center and radius, or two or three points on the circle. A new
|
||||
vertex is inserted every time the left mouse button is pressed.
|
||||
The \ccc{Escape} key removes the last entered point.
|
||||
The \ccc{Del} key removes the last entered point. The \ccc{Esc}
|
||||
key removes all entered points.
|
||||
|
||||
|
||||
\ccInclude{CGAL/Qt/GraphicsViewCircleInput.h}
|
||||
|
|
@ -24,7 +25,7 @@ The template parameter of \ccRefName\ must be a \cgal\ \ccc{Kernel}.
|
|||
\ccSetTwoColumns{GraphicsViewCircleInput}{}
|
||||
|
||||
\ccConstructor{GraphicsViewCircleInput<T>(QGraphicsScene* s, int pointsOnCircle = 1);}
|
||||
{\ccc{s} is the scene where we want to draw the circle. \ccc{pointsOnCircle} is the
|
||||
{\ccc{s} is the scene where we want to enter the circle. \ccc{pointsOnCircle} is the
|
||||
number of points on the circle to generate.}
|
||||
|
||||
\ccMethod{void generate(Object o);}{The object \ccc{o} contains a \ccc{std::pair<K::Point_2, K::FT>}
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ An object of type \ccRefName\ can be added as event filter to a \ccc{Qt::QGraphi
|
|||
|
||||
Dragging the left mouse button while holding the 'Ctrl' key defines a zoom rectangle.
|
||||
Dragging the right mouse button while holding the 'Ctrl' key translates the scene.
|
||||
'Ctrl-Shift' and a click of the right mouse button puts what is under the mouse in the center.
|
||||
|
||||
\ccInclude{CGAL/Qt/GraphicsViewNavigation.h}
|
||||
|
||||
|
|
@ -14,7 +15,7 @@ Dragging the right mouse button while holding the 'Ctrl' key translates the scen
|
|||
|
||||
\ccOperations
|
||||
|
||||
\ccMethod{bool eventFilter(QObject *obj, QEvent *event);}{.}
|
||||
\ccMethod{bool eventFilter(QObject *obj, QEvent *event);}{The event filter.}
|
||||
|
||||
\ccHeading{Signals}
|
||||
|
||||
|
|
|
|||
|
|
@ -5,8 +5,9 @@
|
|||
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.
|
||||
points specified in the constructor is reached. You can use the 'Del'
|
||||
or 'Backspace' key if you want to remove your last entered point in the polygon,
|
||||
and the 'Esc' key if you want to remove all points.
|
||||
|
||||
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
|
||||
|
|
|
|||
|
|
@ -33,9 +33,9 @@ This is typically the visible area of the widget where the unbounded object is d
|
|||
|
||||
\ccMethod{PainterOstream<K> operator<<(Bbox_2);}{Draws an iso rectangle.}
|
||||
|
||||
\ccMethod{PainterOstream<K> operator<<(QPen);}{Sets the pen which is used in the next paint operation.}
|
||||
\ccMethod{PainterOstream<K> operator<<(QPen);}{Sets the pen which is used in the next paint operations.}
|
||||
|
||||
\ccMethod{PainterOstream<K> operator<<(QBrush);}{Sets the brush which is used in the next paint operation.}
|
||||
\ccMethod{PainterOstream<K> operator<<(QBrush);}{Sets the brush which is used in the next paint operations.}
|
||||
|
||||
\end{ccRefClass}
|
||||
|
||||
|
|
|
|||
|
|
@ -29,11 +29,11 @@ The template parameter of \ccRefName\ must be a
|
|||
\ccMethod{QPen edgesPen()() const;}{Get the pen that is used to draw edges.}
|
||||
\ccMethod{void setEdgesPen()(const QPen& p);}{Set the pen that is used to draw edges.}
|
||||
|
||||
\ccMethod{bool drawVertices();}{.}
|
||||
\ccMethod{bool setDrawVertices(bool b);}{.}
|
||||
\ccMethod{bool drawVertices();}{Property to switch drawing of vertices on or off.}
|
||||
\ccMethod{bool setDrawVertices(bool b);}{Set the property.}
|
||||
|
||||
\ccMethod{bool drawEdges();}{.}
|
||||
\ccMethod{bool setDrawEdges(bool b);}{.}
|
||||
\ccMethod{bool drawEdges();}{Property to switch drawing of edges on or off.}
|
||||
\ccMethod{bool setDrawEdges(bool b);}{Set the property.}
|
||||
\end{ccRefClass}
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -26,8 +26,8 @@ Delaunay triangulation \ccc{dt}.}
|
|||
\ccMethod{QPen edgesPen()() const;}{Get the pen that is used to draw edges.}
|
||||
\ccMethod{void setEdgesPen()(const QPen& p);}{Set the pen that is used to draw edges.}
|
||||
|
||||
\ccMethod{bool drawEdges();}{.}
|
||||
\ccMethod{bool setDrawEdges(bool b);}{.}
|
||||
\ccMethod{bool drawEdges();}{Property to switch drawing of edges on or off.}
|
||||
\ccMethod{bool setDrawEdges(bool b);}{Set the property.}
|
||||
\end{ccRefClass}
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue