Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
skramm committed Dec 15, 2023
1 parent 8d92e67 commit 52095ff
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/homog2d_history.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ See [Release page](https://github.com/skramm/homog2d/releases).
- add `Vector` type (defined by dx,dy)

- current master branch
- added building a CPolyline as a Regular Convex Polygon (RCP), either through constructor or through `set()` function
- added building a `CPolyline` as a Regular Convex Polygon (RCP), either through constructor or through `set()` function, [see manual](homog2d_manual.md#set_RCP).
- added helper function `genRandomColors()`
- bufixes, fixed enclosing of Polyline objects (https://github.com/skramm/homog2d/issues/10)
- added `dsize()` member and free function, [see here](homog2d_manual.md#numtype)
Expand Down
8 changes: 6 additions & 2 deletions docs/homog2d_manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -781,7 +781,8 @@ See an [example here](../misc/test_files/bg_test_1.cpp).
This requires the symbol `HOMOG2D_USE_BOOSTGEOM` to be defined.
** Regular Convex Polygon**
**Regular Convex Polygon**
<a name="build_RCP"></a>
It is also possible to build directy a Regular Convex Polygon (RCP) by using a dedicated constructor.
Expand Down Expand Up @@ -1011,7 +1012,10 @@ the distance between two consecutive points as "first", and "second" the radius
![polyline_rcp_1](img/polyline_rcp_1.svg)
[source](../misc/figures_src/src/polyline_rcp_1.cpp)
#### 3.4.11 - Importing from boost::geometry
<a name="boost_geom_1"></a>
If the symbol `HOMOG2D_USE_BOOSTGEOM` is defined (see [build options](#build_options)), you can import a Polyline from a boost Polygon type.
See [demo program](../misc/test_files/bg_test_1.cpp) that demonstrates that feature.
Expand Down Expand Up @@ -1733,7 +1737,7 @@ extended fine-tuning on how things are rendered, the goal is only to quickly see
The user can select between two backends, both can be usable at the same time.
They both are accessed through the templated datatype `Image`, lying in the sub-namespace `img`.
The two concrete types can be used with `Image` are either `img::SvgImage`, to generate a SVG file, or Opencv `cv::Mat` type,
The two concrete types can be used as a type with `Image` are either `img::SvgImage`, to generate a SVG file, or Opencv `cv::Mat` type,
that requires that the symbol `HOMOG2D_USE_OPENCV` is defined and that the library is installed on system.
The difference between these two backends is that with SVG, you may only generate a file;
Expand Down
6 changes: 6 additions & 0 deletions docs/index.csv
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@ Thresholds;thresholds;
Drawing parameters;manual;drawing_params
Lines and Points;manual;basic
Build options;manual;build_options
Regular Convex Polygon;manual;set_RCP
RCP;manual;set_RCP
ttmath library;manual;bignum
Boost Geometry library;manual;boost_geom_1
Opencv;manual;drawing
SVG drawing;manual;drawing
8 changes: 7 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Index
* [Big numbers](homog2d_manual.md#bignum)
* [Boost Geometry library](homog2d_manual.md#boost_geom_1)
* [Build options](homog2d_manual.md#build_options)
* [Circle](homog2d_manual.md#p_circle)
* [Convex Hull](homog2d_manual.md#convex-hull-ff)
Expand All @@ -9,14 +10,19 @@
* [Lines and Points](homog2d_manual.md#basic)
* [Minimum Enclosing Circle](homog2d_manual.md#minenccir)
* [Numerical data types](homog2d_manual.md#numdt)
* [Opencv](homog2d_manual.md#drawing)
* [Parallelogram](homog2d_manual.md#build_parallelo)
* [Polygon Extremum points](homog2d_manual.md#poly_extremum_points)
* [Polygon](homog2d_manual.md#p_polyline)
* [Polygon Rotation/mirroring](homog2d_manual.md#polyline_rotate)
* [RCP](homog2d_manual.md#set_RCP)
* [Rectangle](homog2d_manual.md#p_frect)
* [Regular Convex Polygon](homog2d_manual.md#set_RCP)
* [Segment](homog2d_manual.md#p_segment)
* [Showcase](homog2d_showcase.md#)
* [SVG drawing](homog2d_manual.md#drawing)
* [SVG import](homog2d_manual.md#svg_import)
* [Thresholds](homog2d_thresholds.md#)
* [ttmath library](homog2d_manual.md#bignum)
<hr>
Page generated on 2023-11-17
Page generated on 2023-12-15

0 comments on commit 52095ff

Please sign in to comment.