0027253: Boolean cut produces invalid result shape
[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
109aa56e 21set (BUILD_WITH_DEBUG_DESCR
898f6a92 22"Enables extended messages of many OCCT algorithms, usually printed to cout.
23These include messages on internal errors and special cases encountered, timing etc")
24
316d77d9 25# install variables
f2e9c853 26set (INSTALL_DIR_DESCR
0e617b05 27"The place where built OCCT libraries, headers, test cases (INSTALL_TEST_CASES variable),
28samples (INSTALL_SAMPLES_DESCR variable) and certain 3rdparties (INSTALL_GL2PS, INSTALL_TBB and
f2e9c853 29other similar variables) will be placed during the installation process (building INSTALL project)")
316d77d9 30
f2e9c853 31macro (INSTALL_MESSAGE INSTALL_TARGET_VARIABLE INSTALL_TARGET_STRING)
32set (${INSTALL_TARGET_VARIABLE}_DESCR
33"Indicates whether ${INSTALL_TARGET_STRING} should be installed (building INSTALL
34project) into the installation directory (INSTALL_DIR variable)")
35endmacro()
316d77d9 36
0e617b05 37INSTALL_MESSAGE (INSTALL_SAMPLES "OCCT samples")
38INSTALL_MESSAGE (INSTALL_TEST_CASES "non-regression OCCT test scripts")
f2e9c853 39INSTALL_MESSAGE (INSTALL_DOC_OcctOverview "OCCT overview documentation (HTML format)")
40INSTALL_MESSAGE (INSTALL_FREEIMAGE "FreeImage binaries")
41INSTALL_MESSAGE (INSTALL_FREEIMAGEPLUS "FreeImagePlus binaries")
42INSTALL_MESSAGE (INSTALL_FREETYPE "FreeType binaries")
43INSTALL_MESSAGE (INSTALL_GL2PS "GL2PS binaries")
44INSTALL_MESSAGE (INSTALL_TBB "TBB binaries")
45INSTALL_MESSAGE (INSTALL_TCL "TCL binaries")
82f443b6 46INSTALL_MESSAGE (INSTALL_TK "TK binaries")
e713baee 47#INSTALL_MESSAGE (INSTALL_VTK "VTK binaries ")
316d77d9 48
49# build variables
f2e9c853 50macro (BUILD_MODULE_MESSAGE BUILD_MODULE_TARGET_VARIABLE BUILD_MODULE_TARGET_STRING)
51set (${BUILD_MODULE_TARGET_VARIABLE}_DESCR
52"Indicates whether ${BUILD_MODULE_TARGET_STRING} module should be built or not.
53It should be noted that some toolkits of the module can be built even if this module
54is not checked (this happens if some other modules depend on these toolkits)")
55endmacro()
56
57BUILD_MODULE_MESSAGE (BUILD_MODULE_ApplicationFramework "ApplicationFramework")
58BUILD_MODULE_MESSAGE (BUILD_MODULE_DataExchange "DataExchange")
59BUILD_MODULE_MESSAGE (BUILD_MODULE_Draw "Draw")
60BUILD_MODULE_MESSAGE (BUILD_MODULE_FoundationClasses "FoundationClasses")
61BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingAlgorithms "ModelingAlgorithms")
62BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingData "ModelingData")
63BUILD_MODULE_MESSAGE (BUILD_MODULE_Visualization "Visualization")
64
65
66set (BUILD_ADDITIONAL_TOOLKITS_DESCR
67"Semicolon-separated individual toolkits to include into build process. If you
68want to build some particular libraries (toolkits) only, then you may uncheck
69all modules in the corresponding BUILD_MODUE_* options and provide the list of
70necessary libraries here. Of course, all dependencies will be resolved automatically")
71
72set (BUILD_MODULE_OcctMfcSamples_DESCR
73"Indicates whether OCCT MFC samples should be built together with OCCT.
74These samples show some possibilities of using OCCT and they can be executed
75with script samples.bat from the installation directory (INSTALL_DIR)")
76
77set (BUILD_DOC_OcctOverview_DESCR
78"Indicates whether OCCT overview documentation project (Markdown format) should be
79created together with OCCT. It is not built together with OCCT. Checking this options
80leads to automatic search of Doxygen binaries. Building of it will be call Doxygen command
81to generate the documentation in HTML format. The documentation will be available in the
82installation directory (overview.bat script) if INSTALL_DOC_OcctOverview variable is checked")
83
84set (3RDPARTY_DIR_DESCR
85"The root directory where all required 3-rd party products will be searched. If a
863-rd party product have been found - corresponding CMake variables will be specified
87(VTK: 3RDPARTY_VTK_DIR, 3RDPARTY_VTK_INCLUDE_DIR, 3RDPARTY_VTK_LIBRARY_DIR)")
88
89set (USE_FREEIMAGE_DESCR
90"Indicates whether Freeimage product should be used in OCCT visualization
91module for support of popular graphics image formats (PNG, BMP etc)")
92
93set (USE_GL2PS_DESCR
94"Indicates whether GL2PS product should be used in OCCT visualization
95module for support of vector image formats (PS, EPS etc)")
96
97set (USE_TBB_DESCR
98"Indicates whether TBB 3-rd party is used or not. TBB stands for Threading Building Blocks,
99the technology of Intel Corp, which comes with different mechanisms and patterns for
100injecting parallelism into your application. OCCT remains parallel even without TBB product")
101
102set (USE_VTK_DESCR
103"Indicates whether VTK 3-rd party is used or not. VTK stands for Visualization
104ToolKit, the technology of Kitware Inc intended for general-purpose scientific
105visualization. OCCT comes with a bridge between CAD data representation and
106VTK by means of its dedicated VIS component (VTK Integration Services).")
107
108set (USE_GLX_DESCR "Indicates whether X11 OpenGl on OSX is used or not")
316d77d9 109
f60111dc 110set (USE_D3D_DESCR "Indicates whether optional Direct3D wrapper in OCCT visualization module should be build or not")
111
316d77d9 112macro (BUILD_MODULE MODULE_NAME)
113 set (BUILD_MODULE_${MODULE_NAME} ON CACHE BOOL "${BUILD_MODULE_${MODULE_NAME}_DESCR}")
114endmacro()