0029520: Visualization - drop deprecated V3d_View::Export() functionality and depende...
[occt.git] / adm / cmake / vardescr.cmake
CommitLineData
316d77d9 1# variable description
2
3#
109aa56e 4set (BUILD_PATCH_DESCR
f2e9c853 5"Points to the directory recognized as a 'patch' for OCCT. If specified,
6the files from this directory take precedence over the corresponding native
7OCCT sources. This way you are able to introduce patches to Open CASCADE
8Technology not affecting the original source distribution")
316d77d9 9
f2e9c853 10
11set (BUILD_LIBRARY_TYPE_DESCR
12"Specifies the type of library to be created. 'Shared' libraries
13are linked dynamically and loaded at runtime. 'Static' libraries
14are archives of object files for use when linking other targets")
15
109aa56e 16set (BUILD_YACCLEX_DESCR
f2e9c853 17"Enables Flex/Bison lexical analyzers. OCCT source files relating to STEP reader and
18ExprIntrp functionality are generated automatically with Flex/Bison. Checking this options
19leads to automatic search of Flex/Bison binaries and regeneration of the mentioned files")
316d77d9 20
ee5befae 21set (BUILD_RESOURCES_DESCR "Enables regeneration of OCCT resource files")
22
109aa56e 23set (BUILD_WITH_DEBUG_DESCR
e13e5f39 24"Enables extended messages of many OCCT algorithms, usually printed to cout.
25These include messages on internal errors and special cases encountered, timing etc.
26Applies only for Debug configuration.")
898f6a92 27
46bd680a 28set (BUILD_SHARED_LIBRARY_NAME_POSTFIX_DESCR
29"Append the postfix to names of output libraries")
30
7a59f4ce 31set (BUILD_ENABLE_FPE_SIGNAL_HANDLER_DESCR
32"Enable/Disable the floating point exceptions (FPE) during DRAW execution only.
33Corresponding environment variable (CSF_FPE) can be changed manually
34in custom.bat/sh scripts without regeneration by CMake.")
35
896faa72 36set (BUILD_USE_PCH_DESCR
37"Use precompiled headers to accelerate the build.
38Precompiled headers are generated automatically by Cotire tool.")
39
316d77d9 40# install variables
f2e9c853 41set (INSTALL_DIR_DESCR
0e617b05 42"The place where built OCCT libraries, headers, test cases (INSTALL_TEST_CASES variable),
e52ba46e 43samples (INSTALL_SAMPLES_DESCR variable) and certain 3rdparties (INSTALL_TBB and
f2e9c853 44other similar variables) will be placed during the installation process (building INSTALL project)")
316d77d9 45
4b3541c6 46set (INSTALL_DIR_WITH_VERSION_DESCR
47"Use OCCT version number as suffix for names of directories")
48
49set (INSTALL_DIR_LAYOUT_DESCR
50"Defines structure of OCCT files (binaries, resources, headers etc.) for the install directory.
51Two variants are predefined: for Windows (standard OCCT layout) and for Unix operating systems (standard Linux layout).
52If needed, layout can be customized with INSTALL_DIR_* variables.")
53
54set (INSTALL_DIR_BIN_DESCR
55"Subdirectory of INSTALL_DIR where binaries will be installed")
56set (INSTALL_DIR_INCLUDE_DESCR
57"Subdirectory of INSTALL_DIR where OCCT headers will be installed")
58set (INSTALL_DIR_DATA_DESCR
59"Subdirectory of INSTALL_DIR where sample data files will be installed")
60set (INSTALL_DIR_DOC_DESCR
61"Subdirectory of INSTALL_DIR where documentation will be installed")
62set (INSTALL_DIR_LIB_DESCR
63"Subdirectory of INSTALL_DIR where libraries (.so on Linux, .lib on Windows) will be installed")
64set (INSTALL_DIR_RESOURCE_DESCR
65"Subdirectory of INSTALL_DIR where OCCT resource files will be installed")
66set (INSTALL_DIR_SAMPLES_DESCR
67"Subdirectory of INSTALL_DIR where samples will be installed")
68set (INSTALL_DIR_TESTS_DESCR
69"Subdirectory of INSTALL_DIR where test scripts will be installed")
70set (INSTALL_DIR_SCRIPT_DESCR
71"Subdirectory of INSTALL_DIR where scripts will be installed")
2e48c1cb 72set (INSTALL_DIR_CMAKE_DESCR
73"Subdirectory of INSTALL_DIR where CMake configuration files will be installed.
74Must be three levels below INSTALL_DIR")
4b3541c6 75
f2e9c853 76macro (INSTALL_MESSAGE INSTALL_TARGET_VARIABLE INSTALL_TARGET_STRING)
77set (${INSTALL_TARGET_VARIABLE}_DESCR
78"Indicates whether ${INSTALL_TARGET_STRING} should be installed (building INSTALL
79project) into the installation directory (INSTALL_DIR variable)")
80endmacro()
316d77d9 81
0e617b05 82INSTALL_MESSAGE (INSTALL_SAMPLES "OCCT samples")
83INSTALL_MESSAGE (INSTALL_TEST_CASES "non-regression OCCT test scripts")
4b3541c6 84INSTALL_MESSAGE (INSTALL_DOC_Overview "OCCT overview documentation (HTML format)")
08f8a185 85INSTALL_MESSAGE (INSTALL_FFMPEG "FFmpeg binaries")
f2e9c853 86INSTALL_MESSAGE (INSTALL_FREEIMAGE "FreeImage binaries")
7d7a3e84 87INSTALL_MESSAGE (INSTALL_EIGEN "EIGEN header files")
1ce0716b 88INSTALL_MESSAGE (INSTALL_EGL "EGL binaries")
89INSTALL_MESSAGE (INSTALL_GLES2 "OpenGL ES 2.0 binaries")
f2e9c853 90INSTALL_MESSAGE (INSTALL_FREETYPE "FreeType binaries")
f2e9c853 91INSTALL_MESSAGE (INSTALL_TBB "TBB binaries")
92INSTALL_MESSAGE (INSTALL_TCL "TCL binaries")
82f443b6 93INSTALL_MESSAGE (INSTALL_TK "TK binaries")
c22e576d 94INSTALL_MESSAGE (INSTALL_VTK "VTK binaries ")
316d77d9 95
96# build variables
f2e9c853 97macro (BUILD_MODULE_MESSAGE BUILD_MODULE_TARGET_VARIABLE BUILD_MODULE_TARGET_STRING)
98set (${BUILD_MODULE_TARGET_VARIABLE}_DESCR
99"Indicates whether ${BUILD_MODULE_TARGET_STRING} module should be built or not.
100It should be noted that some toolkits of the module can be built even if this module
101is not checked (this happens if some other modules depend on these toolkits)")
102endmacro()
103
104BUILD_MODULE_MESSAGE (BUILD_MODULE_ApplicationFramework "ApplicationFramework")
105BUILD_MODULE_MESSAGE (BUILD_MODULE_DataExchange "DataExchange")
106BUILD_MODULE_MESSAGE (BUILD_MODULE_Draw "Draw")
107BUILD_MODULE_MESSAGE (BUILD_MODULE_FoundationClasses "FoundationClasses")
108BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingAlgorithms "ModelingAlgorithms")
109BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingData "ModelingData")
110BUILD_MODULE_MESSAGE (BUILD_MODULE_Visualization "Visualization")
111
112
113set (BUILD_ADDITIONAL_TOOLKITS_DESCR
114"Semicolon-separated individual toolkits to include into build process. If you
115want to build some particular libraries (toolkits) only, then you may uncheck
116all modules in the corresponding BUILD_MODUE_* options and provide the list of
117necessary libraries here. Of course, all dependencies will be resolved automatically")
118
510d9690 119set (BUILD_SAMPLES_MFC_DESCR
f2e9c853 120"Indicates whether OCCT MFC samples should be built together with OCCT.
121These samples show some possibilities of using OCCT and they can be executed
1fa16152 122with script samples.bat from the installation directory (INSTALL_DIR)")
123
510d9690 124set (BUILD_SAMPLES_QT_DESCR
1fa16152 125"Indicates whether OCCT Qt samples should be built together with OCCT.
126These samples show some possibilities of using OCCT and they can be executed
f2e9c853 127with script samples.bat from the installation directory (INSTALL_DIR)")
128
4f4b8935 129set (BUILD_Inspector_DESCR
130"Indicates whether OCCT inspector should be built together with OCCT.
131This inspector provides functionality to interactively inspect low-level content
132of the OCAF data model, OCCT viewer, etc. have been introduced in OCCT.
133It can be executed with script inspector.bat from the installation directory (INSTALL_DIR) or
134using 'tinspector' command in DRAW interpretator")
135
742cc8b0 136set (BUILD_MODULE_UwpSample_DESCR
137"Indicates whether OCCT UWP sample should be built together with OCCT.")
138
4b3541c6 139set (BUILD_DOC_Overview_DESCR
f2e9c853 140"Indicates whether OCCT overview documentation project (Markdown format) should be
141created together with OCCT. It is not built together with OCCT. Checking this options
142leads to automatic search of Doxygen binaries. Building of it will be call Doxygen command
143to generate the documentation in HTML format. The documentation will be available in the
4b3541c6 144installation directory (overview.bat script) if INSTALL_DOC_Overview variable is checked")
f2e9c853 145
146set (3RDPARTY_DIR_DESCR
2e48c1cb 147"The root directory where all required third-party products will be searched. If a
148third-party product have been found - corresponding CMake variables will be specified
f2e9c853 149(VTK: 3RDPARTY_VTK_DIR, 3RDPARTY_VTK_INCLUDE_DIR, 3RDPARTY_VTK_LIBRARY_DIR)")
150
08f8a185 151set (USE_FFMPEG_DESCR
152"Indicates whether FFmpeg framework is used or not. FFmpeg stands for
153multimedia data handling, open-source software libraries used for video encoding and decoding.")
154
f2e9c853 155set (USE_FREEIMAGE_DESCR
156"Indicates whether Freeimage product should be used in OCCT visualization
157module for support of popular graphics image formats (PNG, BMP etc)")
158
1ce0716b 159set (USE_EGL_DESCR
160"Indicates whether EGL should be used in OCCT visualization
161module instead of conventional OpenGL context creation APIs")
162
163set (USE_GLES2_DESCR
164"Indicates whether OpenGL ES 2.0 should be used in OCCT visualization
165module instead of desktop OpenGL")
166
f2e9c853 167set (USE_TBB_DESCR
2e48c1cb 168"Indicates whether TBB is used or not. TBB stands for Threading Building Blocks,
f2e9c853 169the technology of Intel Corp, which comes with different mechanisms and patterns for
170injecting parallelism into your application. OCCT remains parallel even without TBB product")
171
172set (USE_VTK_DESCR
2e48c1cb 173"Indicates whether VTK is used or not. VTK stands for Visualization
f2e9c853 174ToolKit, the technology of Kitware Inc intended for general-purpose scientific
175visualization. OCCT comes with a bridge between CAD data representation and
176VTK by means of its dedicated VIS component (VTK Integration Services).")
177
178set (USE_GLX_DESCR "Indicates whether X11 OpenGl on OSX is used or not")
316d77d9 179
f60111dc 180set (USE_D3D_DESCR "Indicates whether optional Direct3D wrapper in OCCT visualization module should be build or not")
181
316d77d9 182macro (BUILD_MODULE MODULE_NAME)
742cc8b0 183 set (ENABLE_MODULE TRUE)
742cc8b0 184 set (BUILD_MODULE_${MODULE_NAME} ${ENABLE_MODULE} CACHE BOOL "${BUILD_MODULE_${MODULE_NAME}_DESCR}")
316d77d9 185endmacro()