OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-03 17:56:21 +03:00
Code Packages Releases Activity
occt/dox/dev_guides/dev_guides.md
ibs 72b7576f48 0023962: Moving OCCT documentation to sources 
OCCT documentation (Overview and User Guides) has been converted from MS Word files to text-based MarkDown format and added to OCCT sources, in the new subfolder 'dox'. The HTML and PDF articles can be generated from the sources using Doxygen and MiKTeX. See the file OCCT_Docs_HowTo.md for details on the new documentation system.

This branch includes:

- new folder structure for Open CASCADE documentation
- sources of almost all OCCT User Guides and Overview
- tcl and bat scripts, which allow to generate HTML and PDF articles
2013-10-17 14:50:43 +04:00

4.6 KiB
Raw Blame History

Developer Guides

@section OCCT_OVW_SECTION1 Source Repository

This directory contains sources of Open CASCADE Technology (OCCT), a collection of C++ libraries providing services for 3D surface and solid modeling, CAD data exchange, and visualization. OCCT can be best applied in development of software dealing with 3D modeling (CAD), manufacturing / measuring (CAM) or numerical simulation (CAE).

The OCCT code is subject to the Open CASCADE Technology Public License Version 6.6 (the "License"). You may not use the content of the relevant files except in compliance with the License. Please see the LICENSE file or obtain a copy of the License at http://www.opencascade.org and read it completely before using this software.

@section OCCT_OVW_SECTION11 Building OCCT Libraries

The source package of the Open CASCADE Technology including the source files of samples and tools and the set of building procedures is available for self-dependent preparation binary files on UNIX and Windows platforms.

In order to build OCCT libraries from these sources for use in your program, you need to:

  1. Install the required third-party libraries.

    Follow the instructions provided in the documents titled "Building 3rd party products for OCCT" on http://dev.opencascade.org/?q=home/resources for choice of the needed libraries, their installation and building.

  2. If you use OCCT sources from Git repository or do come changes affecting CDL files or dependencies of OCCT toolkit, update header files generated from CDL, and regenerate build scripts for your environment using WOK. See \subpage dev_guides__wok "WOK" for details.

    Skip to step 3 if you use complete source package (e.g. official OCCT release) without changes in CDL.

  3. Build using your preferred build tool.

    • \subpage dev_guides__building__automake "Building on Linux with Autotools"
    • \subpage dev_guides__building__cmake "Building with CMake (cross-platform)"
    • \subpage dev_guides__building__code_blocks "Building on Mac OS X with Code::Blocks"
    • \subpage dev_guides__building__msvc "Building on Windows with MS Visual Studio 2005-2012"
    • \subpage dev_guides__building__xcode "Building on Mac OS X with Xcode"

The current version of OCCT can be consulted in the file src/Standard/Standard_Version.hxx

@section OCCT_OVW_SECTION111 Automatic tests

OCCT automatic testing system is integrated with @ref draw "DRAW Test Harness", a console application based on Tcl (a scripting language). All tests are run from DRAW command prompt (run draw.bat or draw.sh to start it).

Standard OCCT tests are located in subdirectory tests of the OCCT root folder. This location is set as default at DRAW start (see environment variable CSF_TestScriptsPath defined in src/DrawResources/DrawDefaults).

The tests are organized in three levels:

  • Group: a group of related test grids, usually testing a particular subset of OCCT functionality (e.g. blend).
  • Grid: a set of test cases within a group, usually aimed at testing a particular aspect or mode of execution of the relevant functionality (e.g. buildevol).
  • Test case: a script implementing an individual test (e.g. K4).

To run all tests, type command testgrid:

Draw[]\> testgrid

For running only a group or a grid of tests, give additional arguments indicating the group and (if needed) the grid name:

Draw[]\> testgrid blend simple

As the tests progress, the result of each test case is reported. At the end of the log a summary of test cases is output, including the list of detected regressions and improvements, if any. The tests are considered as non-regressive if only OK, BAD (i.e. known problem), and SKIPPED (i.e. not executed, typically because of lack of a data file) statuses are reported.

To run a single test, type command 'test' followed by the names of group, grid, and test case.

Draw[1]\> test blend simple A1
CASE blend simple A1: OK

To see intermediate commands and their output during the test execution, add one more argument '-echo' at the end of the command line, or type 'dlog get' after test completion.

For more information consult \subpage dev_guides__tests "Automatic Testing System"

@section OCCT_OVW_SECTION1112 CDL Overview

CDL is the component definition language of the Open CASCADE Technology (OCCT) programming platform. Some components, which CDL allows you to create, are specific to OCCT application architecture.

For more information consult \subpage dev_guides__cdl "Component Definition Language Developer's Guide"

@section OCCT_OVW_SECTION1113 Documentation Overview

\subpage dev_guides__documentation "Documentation Developer's Guide"