[doc] correction on figures

Author: godardma

doc/manual/manual/visualization/figures.rst

@@ -74,9 +74,11 @@ Any Figure2D object can be used as DefaultView with the set method:
 
   .. code-tab:: c++
 
-    Figure2D figure = std::make_shared<Figure2D>("My Figure",GraphicOutput::VIBES|GraphicOutput::IPE);
+    std::shared_ptr<codac2::Figure2D> figure = std::make_shared<Figure2D>("My Figure",GraphicOutput::VIBES|GraphicOutput::IPE);
     DefaultView::set(figure);
 
+Note that in C++ the figure must be a shared pointer in order to be passed to the `set` method.
+
 Equivalently, a Figure2D can be used as DefaultView by setting the flag `set_as_default` to true in the constructor:
 
 .. tabs::

examples/00_graphics/CMakeLists.txt

@@ -0,0 +1,34 @@
+# ==================================================================
+#  codac / basics example - cmake configuration file
+# ==================================================================
+
+  cmake_minimum_required(VERSION 3.0.2)
+  project(codac_example LANGUAGES CXX)
+
+  set(CMAKE_CXX_STANDARD 20)
+  set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# Adding Codac
+
+  # In case you installed Codac in a local directory, you need 
+  # to specify its path with the CMAKE_PREFIX_PATH option.
+  # set(CMAKE_PREFIX_PATH "~/codac/build_install")
+
+  find_package(CODAC REQUIRED)
+  message(STATUS "Found Codac version ${CODAC_VERSION}")
+
+# Initializating Ibex
+  
+  ibex_init_common()
+
+# Compilation
+
+  if(FAST_RELEASE)
+    add_compile_definitions(FAST_RELEASE)
+    message(STATUS "You are running Codac in fast release mode. (option -DCMAKE_BUILD_TYPE=Release is required)")
+  endif()
+
+  add_executable(${PROJECT_NAME} graphic_examples.cpp)
+  target_compile_options(${PROJECT_NAME} PUBLIC ${CODAC_CXX_FLAGS})
+  target_include_directories(${PROJECT_NAME} SYSTEM PUBLIC ${CODAC_INCLUDE_DIRS})
+  target_link_libraries(${PROJECT_NAME} PUBLIC ${CODAC_LIBRARIES})

examples/00_graphics/graphic_examples.cpp

@@ -0,0 +1,41 @@
+#include <codac>
+
+using namespace std;
+using namespace codac2;
+
+int main(){
+
+  // Graphics can be directly called without a Figure2D instanciation, using "DefaultView"
+
+  DefaultView::set_window_properties({600,600},{300,300});
+  DefaultView::draw_box({{2.2,2.5},{2.2,2.5}},{Color::black(),Color::yellow(0.5)});
+  DefaultView::draw_AUV({1,1,3.14/2},1.,{Color::black(),Color::yellow()});
+  DefaultView::draw_tank({2,1,3.14/2},1.,{Color::black(),Color::yellow()});
+  DefaultView::draw_pie({2,2},{1.5,2.5},{(3*3.14/4)-0.5,(3*3.14/4)+0.5},{Color::blue(),Color::cyan()});
+  DefaultView::draw_polyline({{2,-0.5},{4,0.5},{3,1.5},{4,2.5},{3,3}}, Color::red());
+  DefaultView::draw_polygone({{2,4.5},{4,4.5},{4.2,3.5},{3.5,3}}, {Color::none(),Color::green(0.5)});
+  DefaultView::draw_polyline({{-0.8,0},{0,1.5}}, 0.2, {Color::red(),Color::black(0.3)});
+
+  // Last argument corresponds to "StyleProperties" with one or two colors: edge color + (optional) fill color
+  // Predefined Color objects can be configured with a float parameter for opacity (1=opaque, 0=transparent)
+
+  // Custom figures can also be created:
+  std::shared_ptr<codac2::Figure2D> fig1 = std::make_shared<Figure2D>("My Figure 1",GraphicOutput::VIBES|GraphicOutput::IPE);
+
+  // Here, graphics will be rendered by two tools: both VIBES and IPE
+  // For VIBES, it requires the VIBes viewer to be launched prior to the execution
+  // For IPE, it generates a file named "My figure 1.xml" that can be edited with IPE, and converted to PDF
+
+  fig1->set_window_properties({50,50},{500,500}); // position, window size
+  fig1->set_axes(axis(0,{-10,10}), axis(1,{-10,10})); // (axis_id,{range_of_values_on_this_axis})
+  fig1->draw_box({{-1,1},{-1,1}},{Color::green(),Color::red(0.2)}); // drawing a green box with red opacity values inside
+  fig1->draw_circle({1,1},0.5,Color({255,155,5})); // drawing a circle at (1,1) of radius 0.5 with a custom RGB color
+  fig1->draw_ring({1,1},{4,6},Color::red()); // drawing a ring at (1,1) of radius {4,6} with a predefined red color
+
+  std::shared_ptr<codac2::Figure2D> fig2 = std::make_shared<Figure2D>("My Figure 2",GraphicOutput::VIBES|GraphicOutput::IPE);  
+  fig2->set_axes(axis(0,{-1,5}), axis(1,{-1,5}));
+  fig2->set_window_properties({250,250},{500,500});
+
+  // The previously declared figure "fig2" can now be used as a DefaultView
+  DefaultView::set(fig2);
+}