0027051: BRepBuilderAPI_GTransform produces invalid result
[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
4b3541c6 31set (INSTALL_DIR_WITH_VERSION_DESCR
32"Use OCCT version number as suffix for names of directories")
33
34set (INSTALL_DIR_LAYOUT_DESCR
35"Defines structure of OCCT files (binaries, resources, headers etc.) for the install directory.
36Two variants are predefined: for Windows (standard OCCT layout) and for Unix operating systems (standard Linux layout).
37If needed, layout can be customized with INSTALL_DIR_* variables.")
38
39set (INSTALL_DIR_BIN_DESCR
40"Subdirectory of INSTALL_DIR where binaries will be installed")
41set (INSTALL_DIR_INCLUDE_DESCR
42"Subdirectory of INSTALL_DIR where OCCT headers will be installed")
43set (INSTALL_DIR_DATA_DESCR
44"Subdirectory of INSTALL_DIR where sample data files will be installed")
45set (INSTALL_DIR_DOC_DESCR
46"Subdirectory of INSTALL_DIR where documentation will be installed")
47set (INSTALL_DIR_LIB_DESCR
48"Subdirectory of INSTALL_DIR where libraries (.so on Linux, .lib on Windows) will be installed")
49set (INSTALL_DIR_RESOURCE_DESCR
50"Subdirectory of INSTALL_DIR where OCCT resource files will be installed")
51set (INSTALL_DIR_SAMPLES_DESCR
52"Subdirectory of INSTALL_DIR where samples will be installed")
53set (INSTALL_DIR_TESTS_DESCR
54"Subdirectory of INSTALL_DIR where test scripts will be installed")
55set (INSTALL_DIR_SCRIPT_DESCR
56"Subdirectory of INSTALL_DIR where scripts will be installed")
57
f2e9c853 58macro (INSTALL_MESSAGE INSTALL_TARGET_VARIABLE INSTALL_TARGET_STRING)
59set (${INSTALL_TARGET_VARIABLE}_DESCR
60"Indicates whether ${INSTALL_TARGET_STRING} should be installed (building INSTALL
61project) into the installation directory (INSTALL_DIR variable)")
62endmacro()
316d77d9 63
0e617b05 64INSTALL_MESSAGE (INSTALL_SAMPLES "OCCT samples")
65INSTALL_MESSAGE (INSTALL_TEST_CASES "non-regression OCCT test scripts")
4b3541c6 66INSTALL_MESSAGE (INSTALL_DOC_Overview "OCCT overview documentation (HTML format)")
f2e9c853 67INSTALL_MESSAGE (INSTALL_FREEIMAGE "FreeImage binaries")
68INSTALL_MESSAGE (INSTALL_FREEIMAGEPLUS "FreeImagePlus binaries")
69INSTALL_MESSAGE (INSTALL_FREETYPE "FreeType binaries")
70INSTALL_MESSAGE (INSTALL_GL2PS "GL2PS binaries")
71INSTALL_MESSAGE (INSTALL_TBB "TBB binaries")
72INSTALL_MESSAGE (INSTALL_TCL "TCL binaries")
82f443b6 73INSTALL_MESSAGE (INSTALL_TK "TK binaries")
4b3541c6 74
e713baee 75#INSTALL_MESSAGE (INSTALL_VTK "VTK binaries ")
316d77d9 76
77# build variables
f2e9c853 78macro (BUILD_MODULE_MESSAGE BUILD_MODULE_TARGET_VARIABLE BUILD_MODULE_TARGET_STRING)
79set (${BUILD_MODULE_TARGET_VARIABLE}_DESCR
80"Indicates whether ${BUILD_MODULE_TARGET_STRING} module should be built or not.
81It should be noted that some toolkits of the module can be built even if this module
82is not checked (this happens if some other modules depend on these toolkits)")
83endmacro()
84
85BUILD_MODULE_MESSAGE (BUILD_MODULE_ApplicationFramework "ApplicationFramework")
86BUILD_MODULE_MESSAGE (BUILD_MODULE_DataExchange "DataExchange")
87BUILD_MODULE_MESSAGE (BUILD_MODULE_Draw "Draw")
88BUILD_MODULE_MESSAGE (BUILD_MODULE_FoundationClasses "FoundationClasses")
89BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingAlgorithms "ModelingAlgorithms")
90BUILD_MODULE_MESSAGE (BUILD_MODULE_ModelingData "ModelingData")
91BUILD_MODULE_MESSAGE (BUILD_MODULE_Visualization "Visualization")
92
93
94set (BUILD_ADDITIONAL_TOOLKITS_DESCR
95"Semicolon-separated individual toolkits to include into build process. If you
96want to build some particular libraries (toolkits) only, then you may uncheck
97all modules in the corresponding BUILD_MODUE_* options and provide the list of
98necessary libraries here. Of course, all dependencies will be resolved automatically")
99
4b3541c6 100set (BUILD_MODULE_MfcSamples_DESCR
f2e9c853 101"Indicates whether OCCT MFC samples should be built together with OCCT.
102These samples show some possibilities of using OCCT and they can be executed
103with script samples.bat from the installation directory (INSTALL_DIR)")
104
4b3541c6 105set (BUILD_DOC_Overview_DESCR
f2e9c853 106"Indicates whether OCCT overview documentation project (Markdown format) should be
107created together with OCCT. It is not built together with OCCT. Checking this options
108leads to automatic search of Doxygen binaries. Building of it will be call Doxygen command
109to generate the documentation in HTML format. The documentation will be available in the
4b3541c6 110installation directory (overview.bat script) if INSTALL_DOC_Overview variable is checked")
f2e9c853 111
112set (3RDPARTY_DIR_DESCR
113"The root directory where all required 3-rd party products will be searched. If a
1143-rd party product have been found - corresponding CMake variables will be specified
115(VTK: 3RDPARTY_VTK_DIR, 3RDPARTY_VTK_INCLUDE_DIR, 3RDPARTY_VTK_LIBRARY_DIR)")
116
117set (USE_FREEIMAGE_DESCR
118"Indicates whether Freeimage product should be used in OCCT visualization
119module for support of popular graphics image formats (PNG, BMP etc)")
120
121set (USE_GL2PS_DESCR
122"Indicates whether GL2PS product should be used in OCCT visualization
123module for support of vector image formats (PS, EPS etc)")
124
125set (USE_TBB_DESCR
126"Indicates whether TBB 3-rd party is used or not. TBB stands for Threading Building Blocks,
127the technology of Intel Corp, which comes with different mechanisms and patterns for
128injecting parallelism into your application. OCCT remains parallel even without TBB product")
129
130set (USE_VTK_DESCR
131"Indicates whether VTK 3-rd party is used or not. VTK stands for Visualization
132ToolKit, the technology of Kitware Inc intended for general-purpose scientific
133visualization. OCCT comes with a bridge between CAD data representation and
134VTK by means of its dedicated VIS component (VTK Integration Services).")
135
136set (USE_GLX_DESCR "Indicates whether X11 OpenGl on OSX is used or not")
316d77d9 137
f60111dc 138set (USE_D3D_DESCR "Indicates whether optional Direct3D wrapper in OCCT visualization module should be build or not")
139
316d77d9 140macro (BUILD_MODULE MODULE_NAME)
141 set (BUILD_MODULE_${MODULE_NAME} ON CACHE BOOL "${BUILD_MODULE_${MODULE_NAME}_DESCR}")
142endmacro()