mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-03 17:56:21 +03:00
0022827: Make non-CPP source files (CDLs, headers) to appear in MS VS project files -- documentation
Generation of OCCT overview documentation added as building of "Overview" project. BUILD_OCCT_OVERVIEW variable introduced to offer generation OCCT overview documentation in html format. Overview md files added to overview OCCT project. "Building with CMake" article updated; overview.html copy into an install directory. CMAKE_BUILD_TYPE for single-configuration generators described; BUILD_CONFIGURATION removed.
This commit is contained in:
ibs
abv
parent
9e3ca93a91
commit
adc33035ae
@ -22,16 +22,6 @@ project (OCCT)
|
||||
# Solution folder property
|
||||
set_property (GLOBAL PROPERTY USE_FOLDERS ON)
|
||||
|
||||
# Generate documentation
|
||||
# Overview and User Guides
|
||||
set (DOC_GENERATE_OVERVIEW OFF CACHE BOOL "Generate Overview and User Guides")
|
||||
if (NOT DOC_OVERVIEW_OUTPUT_FORMAT)
|
||||
set (DOC_OVERVIEW_OUTPUT_FORMAT "html" CACHE STRING "Output format of Overview and User Guides" FORCE)
|
||||
SET_PROPERTY (CACHE DOC_OVERVIEW_OUTPUT_FORMAT PROPERTY STRINGS html chm pdf)
|
||||
endif()
|
||||
# class Reference Manual
|
||||
set (DOC_GENERATE_REFMAN OFF CACHE BOOL "Generate class Reference Manual")
|
||||
|
||||
# Tests
|
||||
set (TESTS_RUN OFF CACHE BOOL "Run tests or not")
|
||||
set (TESTS_INSTALL OFF CACHE BOOL "Copy tests to folder install")
|
||||
@ -103,6 +93,9 @@ foreach (MODULE ${OCCT_MODULES})
|
||||
set (BUILD_${MODULE} ON CACHE BOOL "include ${MODULE}")
|
||||
endforeach()
|
||||
|
||||
# Overview
|
||||
set (BUILD_OCCT_OVERVIEW OFF CACHE BOOL "Build OCCT overview in HTML format")
|
||||
|
||||
if (NOT USE_VTK)
|
||||
list (REMOVE_ITEM Visualization_TOOLKITS TKIVtk)
|
||||
list (REMOVE_ITEM Draw_TOOLKITS TKIVtkDraw)
|
||||
@ -232,6 +225,25 @@ else()
|
||||
OCCT_CHECK_AND_UNSET ("INSTALL_TBB")
|
||||
endif()
|
||||
|
||||
# Doxygen
|
||||
if (BUILD_OCCT_OVERVIEW)
|
||||
if (NOT DEFINED INSTALL_OCCT_OVERVIEW)
|
||||
set (INSTALL_OCCT_OVERVIEW OFF CACHE BOOL "Copy OCCT overview into install directory")
|
||||
endif()
|
||||
|
||||
if (INSTALL_OCCT_OVERVIEW)
|
||||
install (DIRECTORY "${CMAKE_BINARY_DIR}/doc/overview" DESTINATION "${INSTALL_DIR}/doc")
|
||||
install (FILES "${CMAKE_SOURCE_DIR}/dox/resources/overview.html" DESTINATION "${INSTALL_DIR}")
|
||||
endif()
|
||||
|
||||
OCCT_INCLUDE_CMAKE_FILE ("adm/cmake/doxygen")
|
||||
else()
|
||||
OCCT_CHECK_AND_UNSET ("INSTALL_OCCT_OVERVIEW")
|
||||
|
||||
OCCT_CHECK_AND_UNSET ("3RDPARTY_DOXYGEN_EXECUTABLE")
|
||||
OCCT_CHECK_AND_UNSET ("3RDPARTY_DOXYGEN_DOT_EXECUTABLE")
|
||||
endif()
|
||||
|
||||
string (REGEX REPLACE ";" " " 3RDPARTY_NOT_INCLUDED "${3RDPARTY_NOT_INCLUDED}")
|
||||
|
||||
# check all 3rdparty paths
|
||||
@ -278,6 +290,15 @@ if (WIN32)
|
||||
set (CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}/${OS_WITH_BIT}/${COMPILER}/bind")
|
||||
endif()
|
||||
|
||||
if ("${INSTALL_DIR}" STREQUAL "")
|
||||
get_filename_component (CMAKE_BINARY_DIR_PARENT ${CMAKE_BINARY_DIR} DIRECTORY)
|
||||
|
||||
set (INSTALL_DIR "${CMAKE_BINARY_DIR_PARENT}/install" CACHE PATH "Directory that will contain install files of OCCT" FORCE)
|
||||
set (CMAKE_INSTALL_PREFIX "${INSTALL_DIR}" CACHE INTERNAL "" FORCE )
|
||||
|
||||
message (STATUS "Info: INSTALL_DIR has been set as ${INSTALL_DIR}")
|
||||
endif()
|
||||
|
||||
message (STATUS "\nInfo: Collecting all OCCT header files into ${CMAKE_BINARY_DIR}/inc ...")
|
||||
|
||||
# (!) patch is not taken into account COLLECT_AND_INSTALL_OCCT_HEADER_FILES
|
||||
@ -288,15 +309,6 @@ COLLECT_AND_INSTALL_OCCT_HEADER_FILES ("${CMAKE_SOURCE_DIR}" "${CMAKE_SOURCE_DIR
|
||||
# COLLECT_AND_INSTALL_OCCT_HEADER_FILES ("${BUILD_PATCH_DIR}" "${CMAKE_SOURCE_DIR}/adm/templates/header.in" "${CMAKE_BINARY_DIR}")
|
||||
#endif()
|
||||
|
||||
if ("${INSTALL_DIR}" STREQUAL "")
|
||||
get_filename_component (CMAKE_BINARY_DIR_PARENT ${CMAKE_BINARY_DIR} DIRECTORY)
|
||||
|
||||
set (INSTALL_DIR "${CMAKE_BINARY_DIR_PARENT}/install" CACHE PATH "Directory that will contain install files of OCCT" FORCE)
|
||||
set (CMAKE_INSTALL_PREFIX "${INSTALL_DIR}" CACHE INTERNAL "" FORCE )
|
||||
|
||||
message (STATUS "INSTALL_DIR has been set as ${INSTALL_DIR}")
|
||||
endif()
|
||||
|
||||
OCCT_INSTALL_FILE_OR_DIR ("data" "${INSTALL_DIR}")
|
||||
OCCT_INSTALL_FILE_OR_DIR ("samples/tcl" "${INSTALL_DIR}/samples")
|
||||
|
||||
@ -322,17 +334,6 @@ if (TESTS_RUN AND TESTS_INSTALL)
|
||||
add_custom_target(START_TESTS ${INSTALL_DIR}/draw.${SCRIPT_EXT} -c testgrid -overwrite -outdir ${INSTALL_DIR}/TestResults DEPENDS INSTALL)
|
||||
endif()
|
||||
|
||||
# Creation of "GenerateDocumentation" project
|
||||
if (DOC_GENERATE_OVERVIEW OR DOC_GENERATE_REFMAN)
|
||||
OCCT_INCLUDE_CMAKE_FILE("adm/cmake/occt_gendoc")
|
||||
if(DOC_GENERATE_OVERVIEW)
|
||||
gendoc(-overview -${DOC_OVERVIEW_OUTPUT_FORMAT})
|
||||
endif()
|
||||
if(DOC_GENERATE_REFMAN)
|
||||
gendoc(-refman -html)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
# DRAW.BAT or DRAW.SH
|
||||
if (NOT "${BUILD_PATCH_DIR}" STREQUAL "" AND EXISTS "${BUILD_PATCH_DIR}/adm/templates/draw.${SCRIPT_EXT}")
|
||||
install (FILES "${BUILD_PATCH_DIR}/adm/templates/draw.${SCRIPT_EXT}" DESTINATION "${INSTALL_DIR}" PERMISSIONS
|
||||
@ -397,6 +398,10 @@ foreach (USED_TOOLKIT ${USED_TOOLKITS})
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
if (BUILD_OCCT_OVERVIEW)
|
||||
add_subdirectory (dox)
|
||||
endif()
|
||||
|
||||
# patch DRAWEXE
|
||||
if (MSVC AND 3RDPARTY_DLL_DIRS)
|
||||
list (FIND USED_TOOLKITS DRAWEXE DRAWEXE_INDEX)
|
||||
|
||||
46
adm/cmake/doxygen.cmake
Normal file
46
adm/cmake/doxygen.cmake
Normal file
@ -0,0 +1,46 @@
|
||||
# doxygen
|
||||
|
||||
if (NOT DEFINED 3RDPARTY_DOXYGEN_EXECUTABLE)
|
||||
set (3RDPARTY_DOXYGEN_EXECUTABLE "" CACHE FILEPATH "The Path to the doxygen command")
|
||||
endif()
|
||||
|
||||
if (NOT DEFINED 3RDPARTY_DOXYGEN_DOT_EXECUTABLE)
|
||||
set (3RDPARTY_DOXYGEN_DOT_EXECUTABLE "" CACHE FILEPATH "The path to the dot program used by doxygen")
|
||||
endif()
|
||||
|
||||
if (NOT DEFINED 3RDPARTY_DOXYGEN_SKIP_DOT_EXECUTABLE)
|
||||
set (3RDPARTY_DOXYGEN_SKIP_DOT_EXECUTABLE OFF CACHE BOOL "Skip trying to find Dot")
|
||||
endif()
|
||||
|
||||
if (3RDPARTY_DOXYGEN_SKIP_DOT_EXECUTABLE)
|
||||
OCCT_CHECK_AND_UNSET (3RDPARTY_DOXYGEN_DOT_EXECUTABLE)
|
||||
endif()
|
||||
|
||||
if (NOT 3RDPARTY_DOXYGEN_EXECUTABLE OR (NOT 3RDPARTY_DOXYGEN_SKIP_DOT_EXECUTABLE AND NOT 3RDPARTY_DOXYGEN_DOT_EXECUTABLE))
|
||||
|
||||
set (DOXYGEN_SKIP_DOT ${3RDPARTY_DOXYGEN_SKIP_DOT_EXECUTABLE})
|
||||
find_package (Doxygen)
|
||||
|
||||
if (NOT 3RDPARTY_DOXYGEN_EXECUTABLE AND DOXYGEN_EXECUTABLE)
|
||||
set (3RDPARTY_DOXYGEN_EXECUTABLE "${DOXYGEN_EXECUTABLE}" CACHE FILEPATH "The Path to the doxygen command" FORCE)
|
||||
endif()
|
||||
|
||||
if (NOT 3RDPARTY_DOXYGEN_SKIP_DOT_EXECUTABLE AND NOT 3RDPARTY_DOXYGEN_DOT_EXECUTABLE AND DOXYGEN_DOT_EXECUTABLE)
|
||||
set (3RDPARTY_DOXYGEN_DOT_EXECUTABLE "${DOXYGEN_DOT_EXECUTABLE}" CACHE FILEPATH "The path to the dot program used by doxygen" FORCE)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if (NOT 3RDPARTY_DOXYGEN_EXECUTABLE OR NOT EXISTS "${3RDPARTY_DOXYGEN_EXECUTABLE}")
|
||||
list (APPEND 3RDPARTY_NOT_INCLUDED 3RDPARTY_DOXYGEN_EXECUTABLE)
|
||||
endif()
|
||||
|
||||
if (NOT 3RDPARTY_DOXYGEN_SKIP_DOT_EXECUTABLE)
|
||||
if (NOT 3RDPARTY_DOXYGEN_DOT_EXECUTABLE OR NOT EXISTS "${3RDPARTY_DOXYGEN_DOT_EXECUTABLE}")
|
||||
list (APPEND 3RDPARTY_NOT_INCLUDED 3RDPARTY_DOXYGEN_DOT_EXECUTABLE)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
# unset all redundant variables
|
||||
OCCT_CHECK_AND_UNSET (DOXYGEN_SKIP_DOT)
|
||||
OCCT_CHECK_AND_UNSET (DOXYGEN_EXECUTABLE)
|
||||
OCCT_CHECK_AND_UNSET (DOXYGEN_DOT_EXECUTABLE)
|
||||
File diff suppressed because it is too large
Load Diff
@ -314,3 +314,27 @@ function (OCCT_MODULES_AND_TOOLKITS MODULE_LIST)
|
||||
set (${MODULE_LIST} ${${MODULE_LIST}} PARENT_SCOPE)
|
||||
endfunction()
|
||||
|
||||
# Returns OCCT version string from file Standard_Version.hxx (if available)
|
||||
function (OCCT_VERSION OCCT_VERSION_VAR)
|
||||
set (OCC_VERSION_COMPLETE "7.1.0")
|
||||
set (OCC_VERSION_DEVELOPMENT "")
|
||||
|
||||
set (OCCT_VERSION_LOCALVAR "${OCC_VERSION_COMPLETE}.${OCC_VERSION_DEVELOPMENT}")
|
||||
|
||||
set (STANDARD_VERSION_FILE "${CMAKE_SOURCE_DIR}/src/Standard/Standard_Version.hxx")
|
||||
if (EXISTS "${STANDARD_VERSION_FILE}")
|
||||
foreach (SOUGHT_VERSION OCC_VERSION_COMPLETE OCC_VERSION_DEVELOPMENT)
|
||||
file (STRINGS "${STANDARD_VERSION_FILE}" ${SOUGHT_VERSION} REGEX "^#define ${SOUGHT_VERSION} .*")
|
||||
string (REGEX REPLACE ".*${SOUGHT_VERSION} .*\"([^ ]+)\".*" "\\1" ${SOUGHT_VERSION} "${${SOUGHT_VERSION}}" )
|
||||
endforeach()
|
||||
|
||||
if (NOT "${OCC_VERSION_DEVELOPMENT}" STREQUAL "")
|
||||
set (OCCT_VERSION_LOCALVAR "${OCC_VERSION_COMPLETE}.${OCC_VERSION_DEVELOPMENT}")
|
||||
else()
|
||||
set (OCCT_VERSION_LOCALVAR "${OCC_VERSION_COMPLETE}")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
set (${OCCT_VERSION_VAR} "${OCCT_VERSION_LOCALVAR}" PARENT_SCOPE)
|
||||
endfunction()
|
||||
|
||||
|
||||
104
dox/CMakeLists.txt
Normal file
104
dox/CMakeLists.txt
Normal file
@ -0,0 +1,104 @@
|
||||
project (Overview)
|
||||
|
||||
# directory that contains all raw OCCT overview articles (markdown format)
|
||||
set (OCCT_OVERVIEW_DIR "${CMAKE_SOURCE_DIR}/dox")
|
||||
|
||||
# directory that contains resources for the generation of OCCT documentation
|
||||
set (OCCT_OVERVIEW_RESOURCE_DIR "${OCCT_OVERVIEW_DIR}/resources")
|
||||
|
||||
# directory that contains all generated OCCT articles
|
||||
set (OCCT_GENERATED_DOC_DIR "${CMAKE_BINARY_DIR}/doc")
|
||||
if (NOT EXISTS "${OCCT_GENERATED_DOC_DIR}")
|
||||
file (MAKE_DIRECTORY "${OCCT_GENERATED_DOC_DIR}")
|
||||
endif()
|
||||
|
||||
# directory that contains generated OCCT overview articles
|
||||
set (OCCT_GENERATED_OVERVIEW_DIR "${OCCT_GENERATED_DOC_DIR}/overview")
|
||||
if (NOT EXISTS "${OCCT_GENERATED_OVERVIEW_DIR}")
|
||||
file (MAKE_DIRECTORY "${OCCT_GENERATED_OVERVIEW_DIR}")
|
||||
endif()
|
||||
|
||||
# directory that contains generated OCCT overview articles in html format
|
||||
set (OCCT_GENERATED_HTML_OVERVIEW_DIR "${OCCT_GENERATED_OVERVIEW_DIR}/html")
|
||||
if (NOT EXISTS "${OCCT_GENERATED_HTML_OVERVIEW_DIR}")
|
||||
file (MAKE_DIRECTORY "${OCCT_GENERATED_HTML_OVERVIEW_DIR}")
|
||||
endif()
|
||||
|
||||
# read OCCT articles that should be generated
|
||||
set (OCCT_ARTICLES "")
|
||||
if (EXISTS "${OCCT_OVERVIEW_DIR}/FILES_HTML.txt" )
|
||||
file (STRINGS "${OCCT_OVERVIEW_DIR}/FILES_HTML.txt" OCCT_ARTICLES REGEX "^[^#]+")
|
||||
else()
|
||||
message (FATAL_ERROR "FILES_HTML.txt is not found in ${OCCT_OVERVIEW_DIR}")
|
||||
endif()
|
||||
|
||||
# configuration file for doxygen
|
||||
set (OCCT_CONFIG_FOR_DOXYGEN "${OCCT_GENERATED_DOC_DIR}/occt.cfg")
|
||||
|
||||
set (3RDPARTY_MATHJAX_RELATIVE_PATH "http://cdn.mathjax.org/mathjax/latest")
|
||||
|
||||
OCCT_VERSION (OCCT_SOURCE_VERSION)
|
||||
|
||||
configure_file ("${OCCT_OVERVIEW_RESOURCE_DIR}/occt_ug_html.doxyfile" "${OCCT_CONFIG_FOR_DOXYGEN}" COPYONLY)
|
||||
|
||||
# Add common options for generation of Overview and User Guides
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nPROJECT_NUMBER = ${OCCT_SOURCE_VERSION}")
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nOUTPUT_DIRECTORY = ${OCCT_GENERATED_OVERVIEW_DIR}/.")
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nPROJECT_LOGO = ${OCCT_OVERVIEW_DIR}/resources/occ_logo.png")
|
||||
|
||||
set (OCCT_ARTICLE_PARAM_INPUT "INPUT =")
|
||||
set (OCCT_ARTICLE_PARAM_IMAGEPATH "IMAGE_PATH = ${OCCT_OVERVIEW_DIR}/resources/ ")
|
||||
|
||||
set (OCCT_ARTICLES_ABSPATH "")
|
||||
foreach (OCCT_ARTICLE ${OCCT_ARTICLES})
|
||||
get_filename_component (OCCT_ARTICLE_ABSOLUTE_PATH "${OCCT_OVERVIEW_DIR}/${OCCT_ARTICLE}" ABSOLUTE)
|
||||
get_filename_component (OCCT_ARTICLE_PARENT_DIR "${OCCT_ARTICLE_ABSOLUTE_PATH}" PATH)
|
||||
|
||||
if (EXISTS "${OCCT_ARTICLE_PARENT_DIR}/images")
|
||||
set (OCCT_ARTICLE_PARAM_IMAGEPATH "${OCCT_ARTICLE_PARAM_IMAGEPATH} ${OCCT_ARTICLE_PARENT_DIR}/images")
|
||||
endif()
|
||||
|
||||
set (OCCT_ARTICLE_PARAM_INPUT "${OCCT_ARTICLE_PARAM_INPUT} ${OCCT_ARTICLE_ABSOLUTE_PATH}")
|
||||
|
||||
set (SOURCE_GROUP_NAME "")
|
||||
|
||||
# add the file to appropriate source group
|
||||
get_filename_component (CURRENT_TAIL_PATH "${OCCT_ARTICLE}" PATH)
|
||||
while (CURRENT_TAIL_PATH AND NOT "${CURRENT_TAIL_PATH}" STREQUAL "..")
|
||||
get_filename_component (CURRENT_DIR_NAME "${CURRENT_TAIL_PATH}" NAME)
|
||||
set (SOURCE_GROUP_NAME "${CURRENT_DIR_NAME}\\${SOURCE_GROUP_NAME}")
|
||||
|
||||
# one step out (get parent directory)
|
||||
get_filename_component (CURRENT_TAIL_PATH "${CURRENT_TAIL_PATH}" PATH)
|
||||
endwhile()
|
||||
SOURCE_GROUP ("${SOURCE_GROUP_NAME}" FILES ${OCCT_ARTICLE_ABSOLUTE_PATH})
|
||||
|
||||
list (APPEND OCCT_ARTICLES_ABSPATH ${OCCT_ARTICLE_ABSOLUTE_PATH})
|
||||
endforeach()
|
||||
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\n${OCCT_ARTICLE_PARAM_INPUT}")
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\n${OCCT_ARTICLE_PARAM_IMAGEPATH}")
|
||||
|
||||
# Add document type-specific options
|
||||
# generate tree view
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nGENERATE_TREEVIEW = YES")
|
||||
|
||||
# HTML Search engine options
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nSEARCHENGINE = YES")
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nSERVER_BASED_SEARCH = YES")
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nEXTERNAL_SEARCH = NO")
|
||||
|
||||
# Formula options
|
||||
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nMATHJAX_RELPATH = ${3RDPARTY_MATHJAX_RELATIVE_PATH}")
|
||||
|
||||
# Copy index file to provide fast access to HTML documentation
|
||||
file(COPY "${OCCT_OVERVIEW_RESOURCE_DIR}/index.html" DESTINATION "${OCCT_GENERATED_OVERVIEW_DIR}")
|
||||
|
||||
add_custom_target (${PROJECT_NAME}
|
||||
COMMAND ${3RDPARTY_DOXYGEN_EXECUTABLE} ${OCCT_CONFIG_FOR_DOXYGEN}
|
||||
WORKING_DIRECTORY ${OCCT_GENERATED_DOC_DIR}
|
||||
COMMENT "Generating OCCT overview documentation with Doxygen"
|
||||
SOURCES ${OCCT_ARTICLES_ABSPATH}
|
||||
VERBATIM)
|
||||
|
||||
set_property (TARGET ${PROJECT_NAME} PROPERTY FOLDER "Documentation")
|
||||
@ -17,16 +17,16 @@ instructions for your platform in @ref occt_dev_guides__building.
|
||||
|
||||
## Define the location of build and install directories.
|
||||
|
||||
The build directory is where intermediate files (projects / makefiles, objects, binaries) will be created. Each built configuration should have its own build directory.
|
||||
The build directory is where intermediate files (projects / makefiles, objects, binaries) will be created.
|
||||
|
||||
The install directory is where binaries will be installed after build, along with header files and resources required for OCCT use in applications.
|
||||
It is possible to install several configurations of OCCT (differentiated by platform, bitness, compiler, and build type) into the same directory.
|
||||
|
||||
It is recommended to separate build and install directories from OCCT source directory, for example:
|
||||
|
||||
/user/home/occt/ - sources
|
||||
/user/home/tmp/occt-build-vc10-x64-release - intermediate files
|
||||
/user/home/occt-install - installed binaries
|
||||
/user/home/occt/ - sources
|
||||
/user/home/tmp/occt-build-vc10-x64 - intermediate files
|
||||
/user/home/occt-install - installed binaries
|
||||
|
||||
## CMake usage
|
||||
|
||||
@ -42,7 +42,7 @@ Specify the root folder of OCCT (<i>$CASROOT</i>, which contains *CMakelists.txt
|
||||
|
||||
Specify the location (build folder) for Cmake generated project files by clicking **Browse Build**.
|
||||
|
||||
Each configuration of the project should be built in its own directory. When building multiple configurations it is recommended to indicate in the name of build directories the system, bitness, compiler, and build type (e.g., <i>d:/occt/build/win32-vc9-debug</i> ).
|
||||
Each configuration of the project should be built in its own directory. When building multiple configurations it is recommended to indicate in the name of build directories the system, bitness, compiler, and build type (e.g., <i>d:/occt/build/win32-vc9</i> ).
|
||||
|
||||
**Configure** opens the window with a drop-down list of generators supported by CMake project. Select the required generator (e.g., Visual Studio 2008) and click **Finish**.
|
||||
|
||||
@ -52,7 +52,7 @@ Each configuration of the project should be built in its own directory. When bui
|
||||
|
||||
In the console, change to the build directory and call *ccmake* with the path to the source directory of the project:
|
||||
|
||||
> cd ~/occt/build/debug
|
||||
> cd ~/occt/build
|
||||
> ccmake ~/occt
|
||||
|
||||
@figure{/dev_guides/building/cmake/images/cmake_image003.png}
|
||||
@ -74,26 +74,29 @@ which need to be defined. This error will appear until all required variables ar
|
||||
|
||||
Note: In *cmake-gui* there is "grouped" option, which groups variables with a common prefix.
|
||||
|
||||
**Note**: If a single-configuration generator is chosen (such as make), there is the need to specify *CMAKE_BUILD_TYPE* variable
|
||||
with the value of further build type: Debug, Release or RelWithDebInfo.
|
||||
|
||||
### Selection of the components to be built
|
||||
|
||||
The variables with <i>BUILD_</i> prefix allow specifying OCCT components and
|
||||
configuration to be built:
|
||||
|
||||
* *BUILD_CONFIGURATION* - defines configuration to be built (Release by default).
|
||||
* <i>BUILD_<MODULE></i> - specifies whether the corresponding OCCT module should be
|
||||
built (all toolkits). Note that even if the whole module is not
|
||||
selected for build, its toolkits used by other toolkits
|
||||
selected for build will be included automatically.
|
||||
* *BUILD_TOOLKITS* - allows including additional toolkits from non-selected
|
||||
modules (should be list of toolkit names separated by a
|
||||
space or a semicolon).
|
||||
* *BUILD_SAMPLES* - specifies whether OCCT MFC samples should be built.
|
||||
* *BUILD_PATCH_DIR* - optionally specifies additional folder containing patched OCCT source files.
|
||||
The patch may contain arbitrary subset of OCCT source files (including CMake scripts, templates, etc.), organized in the same structure of folders as OCCT.
|
||||
The projects generated by CMake will use files found in the patch folder instead of the corresponding files of OCCT.
|
||||
* *BUILD_LIBRARY_TYPE* - specifies whether static or shared libraries should be built.
|
||||
* <i>BUILD_<MODULE></i> - specifies whether the corresponding OCCT module should be
|
||||
built (all toolkits). Note that even if the whole module is not
|
||||
selected for build, its toolkits used by other toolkits
|
||||
selected for build will be included automatically.
|
||||
* *BUILD_TOOLKITS* - allows including additional toolkits from non-selected
|
||||
modules (should be list of toolkit names separated by a
|
||||
space or a semicolon).
|
||||
* *BUILD_MFC_SAMPLES* - specifies whether OCCT MFC samples should be built.
|
||||
* *BUILD_OCCT_OVERVIEW* - specifies whether OCCT overview documentation should be generated.
|
||||
* *BUILD_PATCH_DIR* - optionally specifies additional folder containing patched OCCT source files.
|
||||
The patch may contain arbitrary subset of OCCT source files (including CMake scripts, templates, etc.), organized in the same structure of folders as OCCT.
|
||||
The projects generated by CMake will use files found in the patch folder instead of the corresponding files of OCCT.
|
||||
|
||||
Check variables with <i>USE_</i> prefix (<i>USE_FREEIMAGE, USE_GL2PS, USE_TBB,</i> and
|
||||
<i>USE_OPENCL</i>) if you want to enable use of the corresponding optional 3rd-party
|
||||
Check variables with <i>USE_</i> prefix (<i>USE_FREEIMAGE, USE_GL2PS, USE_TBB,</i>) if there is the need to enable use of the corresponding optional 3rd-party
|
||||
library.
|
||||
|
||||
### 3rd-party configuration (The variables with <i>3RDPARTY_</i> prefix)
|
||||
@ -116,7 +119,7 @@ The result of the search are recorded in the corresponding variables:
|
||||
* *3RDPARTY_\<PRODUCT\>_DLL_DIR* - path to the directory containing a shared library (e.g., <i>D:/3rdparty/tcltk-86-32/bin</i>) This variable is able just in windows case
|
||||
|
||||
|
||||
Note: a libraries and include directories should be the children of product directory if the last one is defined.
|
||||
Note: each library and include directory should be the children of product directory if the last one is defined.
|
||||
|
||||
The search process is as follows:
|
||||
|
||||
@ -161,6 +164,11 @@ change appropriate cmake variables (edit CMakeCache.txt file or edit in cmake-gu
|
||||
Define *INSTALL_DIR* variable as the path will be contain the built OCCT files (libraries, executables and headers)
|
||||
If <i>INSTALL_\<PRODUCT\></i> variable is checked, 3rd-party products will be copied to the install directory.
|
||||
|
||||
Additional INSTALL_ variables:
|
||||
|
||||
* INSTALL_SAMPLES - copy all OCCT samples into the install folder
|
||||
* INSTALL_OCCT_OVERVIEW - copy generated OCCT overview documentation into the install folder
|
||||
|
||||
At the end of the configuration process "configuring done" message will be shown and the generation process can be started.
|
||||
|
||||
## OCCT Generation
|
||||
|
||||
9
dox/resources/overview.html
Normal file
9
dox/resources/overview.html
Normal file
@ -0,0 +1,9 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
|
||||
<meta http-equiv="refresh" content="0;URL=doc/overview/html/index.html">
|
||||
</head>
|
||||
<body>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
x
Reference in New Issue
Block a user