Skip to content

Commit 1f54870

Browse files
committed
[doc] cleaner doc for drawing functions
1 parent d784446 commit 1f54870

2 files changed

Lines changed: 27 additions & 20 deletions

File tree

doc/manual/manual/visualization/colors.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ For more information, see :ref:`subsec-graphics-colors-optional-arguments`.
208208
fig.draw_box(IntervalVector({{2,5},{2,5}}), StyleProperties(Color().red(), "..", "layer1", "w:0.1", "z:1.5"));
209209
% Red edge, dotted line, line width of 0.1, z-value of 1.5 and on layer1
210210

211+
.. _subsec-graphics-colors-pavingstyle:
211212
Paving style
212213
------------
213214

doc/manual/manual/visualization/functions.rst

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -237,33 +237,39 @@ The vehicles that can be drawn and their arguments are listed below :
237237
Paving
238238
------
239239

240-
All the drawable pavings can take a last optionnal argument to set up their style for the insider, boundary and outside boxes.
241-
For further details, refer to :ref:`subsec-graphics-colors-styleproperties`.
240+
All the drawable pavings can take a last optionnal argument to set up their style for the inside, boundary and outside boxes.
241+
For further details, refer to :ref:`subsec-graphics-colors-pavingstyle`.
242242

243+
The paving that can be drawn and their arguments are listed below :
243244

244-
Miscellaneous
245-
-------------
245+
- draw_paving
246246

247-
.. doxygenfunction:: codac2::Figure2D::draw_text(const std::string&, const Vector&, double, const StyleProperties&)
248-
:project: codac
247+
- PavingOut | PavingInOut : the paving to draw
249248

250-
.. doxygenfunction:: codac2::Figure2D::draw_raster(const std::string&, const IntervalVector&, const StyleProperties&)
251-
:project: codac
249+
- draw_paving
252250

253-
Paving
254-
------
251+
- PavingOut | PavingInOut : the paving to draw
252+
- function(Figure2D,IntervalVector,StyleProperties) : Custom drawing function (for instance, if one wants to draw in polar coordinates)
253+
254+
- draw_subpaving
255+
256+
- Subpaving : the subpaving to draw
257+
258+
Miscellaneous
259+
-------------
260+
261+
Other objects can be drawn and can take a last optionnal argument to set up their stroke color, fill color, line style etc.
262+
For further details, refer to :ref:`subsec-graphics-colors-styleproperties`.
255263

256-
.. doxygenfunction:: codac2::Figure2D::draw_paving(const PavingOut&, const PavingStyle&)
257-
:project: codac
264+
These objects are :
258265

259-
.. doxygenfunction:: codac2::Figure2D::draw_paving(const PavingOut&, const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>&, const PavingStyle&)
260-
:project: codac
266+
- draw_text
261267

262-
.. doxygenfunction:: codac2::Figure2D::draw_paving(const PavingInOut&, const PavingStyle&)
263-
:project: codac
268+
- string : the text to draw
269+
- Vector : the 2D Vector for the position of the top-left corner of the text
270+
- float : the scale of the text (VIBes only)
264271

265-
.. doxygenfunction:: codac2::Figure2D::draw_paving(const PavingInOut&, const std::function<void(Figure2D&,const IntervalVector&,const StyleProperties&)>&, const PavingStyle&)
266-
:project: codac
272+
- draw_raster
267273

268-
.. doxygenfunction:: codac2::Figure2D::draw_subpaving(const Subpaving<P>&, const StyleProperties&)
269-
:project: codac
274+
- string : The name of the file (the path is relative to the VIBes' server folder)
275+
- IntervalVector : The bounding box of the raster

0 commit comments

Comments
 (0)