3.3.4. List of common CMake Variables and Environment Variables used in the Itom project#
This chapter is to hold lots of common CMAKE Variables and System Environment variables, used throughout the itom and its plugin’s projects, in the hope this will reduce the amount of try-and error cycles to fill in the right patterns.
Environment Variables are set in the system environment and can be set in via the command terminal.
Linux/MaxOS: .. code-block:: bash
export <VARIABLE_NAME>=<Value>
to change the environment variables permanently the user has to modify the shell profile settings. The location of the corresponding file depends on the system.
sudo echo "export <VARIABLE_NAME>=<Value>" >> ~/.profile
Windows: .. code-block:: bash
set <VARIABLE_NAME> <Value>
to change the environment variables permanently use:
setx <VARIABLE_NAME> <Value>
In general it is recommended to use the system environment variables, because they can be reused permanently and are used to set during the internal cmake configuration to define the correct location of the cmake modules and configurations scripts, which in turn define the set of Cmake Variables.
CMake Variables cam used to override configurations Cmake configurations based on Environment variables. They can be set during the command line call of the cmake configuration via the -D<Variable name> Flag (e.g. -D OpenCV_DIR), or within the CMAKE-GUI.
This list is to be extended, but if you want to compile a certain plugin, best is to check with the doc provided by it.
3.3.4.1. Environment Variables:#
Env. Variable |
Description |
|---|---|
ITOM_SDK_ROOT |
Path to the build ITOM SDK Path, as created after a successful itom build. (e.g. <Itom_BuildFolder>/SDK). Should be set manually if ITOM is not build outside of the proposed build structure. |
QT_ROOT |
Path to the compiler specific Qt folder (e.g. <QT_BuildFolder>/msvc####_##). |
PYTHON_ROOT |
Path to the Python installation folder (e.g. C:/Python3). |
OPENCV_ROOT |
Path to folder containing OpenCVConfig.cmake or OpenCVConfig-version.cmake (e.g. <OpenCV_BuildFolder>/x64/vc##/lib). |
BOOST_ROOT |
Path to the boost build folder (e.g. <BOOST_BuildFolder>). |
FLANN_ROOT |
Path to the flann build folder (e.g. <FLANN_BuildFolder>). |
VTK_ROOT |
The folder in the vtk module containing VTKConfig.cmake (e.g. <VTK_BuildFolder>libcmakevtk-#.# ) or VTKConfigVersion.cmake, highly depending on the vtk version you are using. On Linux Systems you need to separately install vtk-dev(even if it does not fit the version you want to use) for one or two headers that are missing otherwise… |
EIGEN_ROOT |
Path to folder containing subfolders “build”, “Eigen”, “unsupported” |
PCL_ROOT |
Path to the pcl build folder (e.g. <PCL_BuildFolder>PCL1.12.0cmake). |
LIBUSB_ROOT |
Path to the libusb build folder (e.g. <LIBUSB_BuildFolder>). |
FFTW_ROOT |
Path to the fftw build folder (e.g. <FFTW_BuildFolder>). |