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