Merge pull request #1508 from fspindle/feat_cmake_and_doc

Feat cmake and doc
lagadic · Nov 26, 2024 · e56dece · e56dece
2 parents 98270b9 + fe71a7e
commit e56dece
Show file tree

Hide file tree

Showing 114 changed files with 233 additions and 138 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -78,7 +78,7 @@ if(NOT CMAKE_BUILD_TYPE)
   set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel." FORCE)
 endif()
 
-cmake_minimum_required(VERSION 3.5) # needs to be before project() for policy CMP0025
+cmake_minimum_required(VERSION 3.10) # needs to be before project() for policy CMP0025
 
 # Detect if the toolchain is for Aldebaran naoqi
 if(CMAKE_TOOLCHAIN_FILE AND I_AM_A_ROBOT)

diff --git a/apps/CMakeLists.txt b/apps/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(ViSP-apps)
 

diff --git a/apps/calibration/CMakeLists.txt b/apps/calibration/CMakeLists.txt
@@ -1,6 +1,6 @@
 project(apps-calibration)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_vision visp_io OPTIONAL_COMPONENTS visp_gui visp_robot visp_sensor)
 

diff --git a/cmake/VISPGenerateConfigScript.cmake b/cmake/VISPGenerateConfigScript.cmake
@@ -256,7 +256,7 @@ set(TARGET_LOCATION_${item} \"${item}${VISP_VERSION_MAJOR}${VISP_VERSION_MINOR}$
 # =============================================================================
 else() # DEFINED CMAKE_HELPER_SCRIPT
 
-  cmake_minimum_required(VERSION 3.5)
+  cmake_minimum_required(VERSION 3.10)
   include("${CMAKE_HELPER_SCRIPT}")
   include("${VISP_SOURCE_DIR}/cmake/VISPUtils.cmake")
 

diff --git a/demo/CMakeLists.txt b/demo/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(ViSP-demo)
 

diff --git a/demo/wireframe-simulator/CMakeLists.txt b/demo/wireframe-simulator/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(demo-wireframe-simulator)
 

diff --git a/doc/tutorial/bridge/matlab/tutorial-visp-matlab.dox b/doc/tutorial/bridge/matlab/tutorial-visp-matlab.dox
@@ -29,7 +29,7 @@ In order to build a source code that mix ViSP and MATLAB you should first create
 find ViSP and MATLAB. In the following example we consider the case of the tutorial-matlab.cpp source file.
 
 \code
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(visp-matlab)
 

diff --git a/doc/tutorial/developper/tutorial-add-new-dependency.dox b/doc/tutorial/developper/tutorial-add-new-dependency.dox
@@ -305,7 +305,7 @@ $ more CMakeLists.txt
 \code
 project(example-dummy)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_core visp_robot)
 
@@ -409,7 +409,7 @@ $ cd $VISP_WS/my-project
 $ more CMakeLists.txt
 \endcode
 \code
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-dummy)
 

diff --git a/doc/tutorial/rendering/tutorial-panda3d.dox b/doc/tutorial/rendering/tutorial-panda3d.dox
@@ -34,6 +34,7 @@ vpPanda3DBaseRenderer, which implements basic functions for a panda renderer.
 
 - Hereafter you will find the instructions to build and install Panda3D from source on Ubuntu 22.04
   \code{.sh}
+  $ sudo apt install python3-pip
   $ mkdir -p $VISP_WS/3rdparty/panda3d
   $ cd $VISP_WS/3rdparty/panda3d
   $ git clone https://github.com/panda3d/panda3d

diff --git a/doc/tutorial/started/tutorial-getting-started.dox b/doc/tutorial/started/tutorial-getting-started.dox
@@ -228,7 +228,7 @@ example. A minimalistic `CMakeLists.txt` should contain the following lines.
 
 Open your editor and copy/paste the following lines in `VISP_WS/started/CMakeLists.txt` file.
 \code
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(tutorial-image)
 
@@ -248,7 +248,7 @@ The `find_package()` CMake command searches for a `VISPConfig.cmake` file that w
 
 Note that the previous `CMakeLists.txt` file can also be:
 \code
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(tutorial-image)
 

diff --git a/doc/tutorial/supported-third-parties/supported-third-parties.dox b/doc/tutorial/supported-third-parties/supported-third-parties.dox
@@ -115,6 +115,34 @@ $ sudo apt-get install libpng-dev
 $ su -c "yum install libpng-devel"
 \endverbatim
 
+\section soft_ar 3D Rendering and Augmented Reality
+
+These are the optional 3rd-parties supported by ViSP in \ref module_ar for 3D Rendering and Augmented Reality.
+
+\subsection soft_ar_Ogre3D Ogre3D
+
+- <b>Ubuntu or debian installation since Ubuntu 24.04</b>
+\code{.sh}
+$ sudo apt-get install libogre-1.12-dev libois-dev
+\endcode
+- <b>Ubuntu or debian installation for Ubuntu 22.04 or before</b>
+\code{.sh}
+$ sudo apt-get install libogre-1.9-dev libois-dev
+\endcode
+- <b>Fedora or RedHat installation</b>
+\code{.sh}
+$ su -c "yum install ogre-devel ogre-samples ois-devel"
+\endcode
+
+\subsection soft_ar_Panda3D Panda3D
+
+Panda3D installation instructions are provided in \ref tutorial-panda3d.
+- <b>\ref tutorial-panda3d-install-ubuntu</b>
+
+- <b>\ref tutorial-panda3d-install-macos</b>
+
+- <b>\ref tutorial-panda3d-install-windows</b>
+
 \section soft_robot Robot Control
 
 The following optional third-parties are used in \ref module_robot to enable the robot arms usage supported by ViSP.

diff --git a/example/CMakeLists.txt b/example/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(ViSP-examples)
 

diff --git a/example/calibration/CMakeLists.txt b/example/calibration/CMakeLists.txt
@@ -35,7 +35,7 @@
 
 project(example-calibration)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_core visp_vision visp_gui visp_io)
 

diff --git a/example/coin-simulator/CMakeLists.txt b/example/coin-simulator/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-coin-simulator)
 

diff --git a/example/device/display/CMakeLists.txt b/example/device/display/CMakeLists.txt
@@ -35,7 +35,7 @@
 
 project(example-device-display)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_core visp_gui visp_io)
 

diff --git a/example/device/framegrabber/CMakeLists.txt b/example/device/framegrabber/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-device-framegrabber)
 

diff --git a/example/device/kinect/CMakeLists.txt b/example/device/kinect/CMakeLists.txt
@@ -35,7 +35,7 @@
 
 project(example-device-kinect)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_core visp_sensor visp_gui)
 

diff --git a/example/device/laserscanner/CMakeLists.txt b/example/device/laserscanner/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-device-laserscanner)
 

diff --git a/example/device/light/CMakeLists.txt b/example/device/light/CMakeLists.txt
@@ -35,7 +35,7 @@
 
 project(example-device-laserscanner)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_core visp_robot visp_io)
 

diff --git a/example/direct-visual-servoing/CMakeLists.txt b/example/direct-visual-servoing/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-direct-vvs)
 

diff --git a/example/homography/CMakeLists.txt b/example/homography/CMakeLists.txt
@@ -35,7 +35,7 @@
 
 project(example-homography)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_core visp_vision visp_io)
 

diff --git a/example/image/CMakeLists.txt b/example/image/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-image)
 

diff --git a/example/kalman/CMakeLists.txt b/example/kalman/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-kalman)
 

diff --git a/example/manual/CMakeLists.txt b/example/manual/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-manual)
 

diff --git a/example/manual/geometric-features/CMakeLists.txt b/example/manual/geometric-features/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(GeometricFeatures)
 
@@ -8,4 +8,3 @@ if(VISP_FOUND)
 endif()
 
 add_executable(manGeometricFeatures manGeometricFeatures.cpp)
-
diff --git a/example/manual/hello-world/CMake/CMakeLists.txt b/example/manual/hello-world/CMake/CMakeLists.txt
@@ -1,6 +1,6 @@
 project(HelloWorld)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED)
 if(VISP_FOUND)

diff --git a/example/manual/image-manipulation/CMakeLists.txt b/example/manual/image-manipulation/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(ImageManipulation)
 
@@ -12,4 +12,3 @@ add_executable(manGrab1394       manGrab1394.cpp)
 add_executable(manGrabDirectShow manGrabDirectShow.cpp)
 add_executable(manGrabDisk       manGrabDisk.cpp)
 add_executable(manGrabV4l2       manGrabV4l2.cpp)
-
diff --git a/example/manual/moments/CMakeLists.txt b/example/manual/moments/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(man-moment)
 
@@ -8,5 +8,3 @@ if(VISP_FOUND)
 endif()
 
 add_executable(manServoMomentsSimple manServoMomentsSimple.cpp)
-
-
diff --git a/example/manual/ogre/CMakeLists.txt b/example/manual/ogre/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(OgreTutorial)
 

diff --git a/example/manual/simulation/CMakeLists.txt b/example/manual/simulation/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(ImageManipulation)
 
@@ -10,4 +10,3 @@ endif()
 add_executable(manServo4PointsDisplay manServo4PointsDisplay.cpp)
 add_executable(manSimu4Dots           manSimu4Dots.cpp)
 add_executable(manSimu4Points         manSimu4Points.cpp)
-
diff --git a/example/math/CMakeLists.txt b/example/math/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-math)
 

diff --git a/example/moments/image/CMakeLists.txt b/example/moments/image/CMakeLists.txt
@@ -35,7 +35,7 @@
 
 project(example-moments-image)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_core visp_vs visp_robot visp_gui)
 

diff --git a/example/moments/points/CMakeLists.txt b/example/moments/points/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-moments-points)
 

diff --git a/example/moments/polygon/CMakeLists.txt b/example/moments/polygon/CMakeLists.txt
@@ -35,7 +35,7 @@
 
 project(example-moments-polygon)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_core visp_vs visp_robot visp_gui)
 

diff --git a/example/ogre-simulator/CMakeLists.txt b/example/ogre-simulator/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-ogre-simulator)
 

diff --git a/example/parse-argv/CMakeLists.txt b/example/parse-argv/CMakeLists.txt
@@ -35,7 +35,7 @@
 
 project(example-parse-argv)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 find_package(VISP REQUIRED visp_core visp_io)
 

diff --git a/example/particle-filter/CMakeLists.txt b/example/particle-filter/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-kalman)
 

diff --git a/example/pose-estimation/CMakeLists.txt b/example/pose-estimation/CMakeLists.txt
@@ -33,7 +33,7 @@
 #
 #############################################################################
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 project(example-pose-estimation)
 

diff --git a/example/reflex-takktile/CMakeLists.txt b/example/reflex-takktile/CMakeLists.txt
@@ -35,7 +35,7 @@
 
 project(example-reflex-takktile)
 
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.10)
 
 if(CMAKE_SYSTEM_NAME MATCHES WindowsPhone OR CMAKE_SYSTEM_NAME MATCHES WindowsStore)
   set(WINRT TRUE)