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