@section OCCT_OVW_SECTION_1 Welcome
-Welcome to 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).
+Welcome to Open CASCADE Technology (OCCT), a software development platform
+providing services for 3D surface and solid modeling, CAD data exchange, and
+visualization. Most of OCCT functionality is available in the form of C++
+libraries. OCCT can be best applied in development of software dealing with 3D
+modeling (CAD), manufacturing / measuring (CAM) or numerical simulation (CAE).
@htmlonly<center>@endhtmlonly
http://www.opencascade.org
@section OCCT_OVW_SECTION_2 Copyrights
-Copyright(c) 2001-2013 by OPEN CASCADE S.A.S. All rights reserved.
+Open CASCADE Technology and all materials, including this documentation, is
+Copyright (c) 1999-2013 by OPEN CASCADE S.A.S. All rights reserved.
@htmlonly<center>@endhtmlonly
http://www.opencascade.com
@image latex /resources/occ_logo.png
@htmlonly</center>@endhtmlonly
+ License
+--------
+
+Open CASCADE Technology is free software; you can redistribute it and / or
+modify it under the terms of the
+@ref license_lgpl_21 "GNU Lesser General Public License (LGPL) version 2.1",
+with additional @ref occt_lgpl_exception "exception".
+
+Alternatively, Open CASCADE Technology may be used under the terms of Open
+CASCADE commercial license or contractual agreement.
+
+Note that Open CASCADE Technology is provided on an "AS IS" basis, WITHOUT
+WARRANTY OF ANY KIND. The entire risk related to any use of the OCCT code and
+materials is on you. See the @ref occt_public_license "license" text for formal
+disclaimer.
+
Trademark information
----------------------
international and domestic laws on intellectual property and trademarks.
Should you need further information, please directly contact the authors.
-CAS.CADE and Open CASCADE are registered trademarks of OPEN CASCADE S.A.S.
+**CAS.CADE** and **Open CASCADE** are registered trademarks of
+OPEN CASCADE S.A.S.
+
+**Linux** is a registered trademark of Linus Torvalds.
+
+**Windows** is a registered trademark of Microsoft Corporation in the United States and other countries.
+
+**Mac** and the Mac logo, **OpenCL** and the OpenCL logo, are trademarks of
+Apple Inc., registered in the U.S. and other countries.
Acknowledgements
------------------
Open CASCADE Technology WOK module on Windows also makes use of LGPL-licensed C routines **regexp**
and **getopt**, taken from GNU C library.
+**OpenGL** is an industry standard API for 3D graphics used by OCCT for
+implementation of 3D viewer. OpenGL specification is developed by the
+Khronos group, http://www.khronos.org/opengl/. OCCT code includes header
+file *glext.h* obtained from Khronos web site.
+
+**OpenCL** (Open Computing Language) is open, royalty-free standard for
+cross-platform, parallel programming of modern processors, optionally used by
+OCCT for ray tracing. OpenCL specification is developed by the
+Khronos group, http://www.khronos.org/opencl/. The implementations of OpenCL
+are available from Apple, AMD, NVIDIA, Intel, and other vendors.
+**OpenCL Installable Client Driver (ICD) Loader** is a library provided by
+Khronos group which allows dispatching OpenCL calls to underlying
+implementation.
+
**Doxygen** developed by Dimitri van Heesch is open source documentation system for
C++, C, Java, Objective-C, Python, IDL, PHP and C#. This product is used in Open CASCADE Technology
for automatic creation of Technical Documentation from C++ header files.
Adobe Systems, Inc. provides **Adobe Reader**, which can be used to view files in Portable Document Format (PDF).
-**Linux** is a registered trademark of Linus Torvalds.
-
-**Windows** is a registered trademark of Microsoft Corporation in the United States and other countries.
-
-**Mac** and the Mac logo are trademarks of Apple Inc., registered in the U.S. and other countries.
-
@section OCCT_OVW_SECTION_3 Documentation
OCCT documentation is provided in several forms:
@section OCCT_OVW_SECTION_5 Requirements
-@subsection OCCT_OVW_SECTION_5_1 Linux Intel
-<table>
-<tr> <th>Operating System </th> <th> 64-bit: Mandriva 2010, CentOS 5. 5, CentOS 6.3, Fedora 17, Fedora 18, Ubuntu-1304, Debian 6.0 * </th> </tr>
-<tr> <td> Minimum memory </td> <td> 512 Mb, 1 Gb recommended </td > </tr>
-<tr> <td> Free disk space (complete installation) </td> <td> For full installation Open CASCADE Technology requires 600 Mb of disk space. </td > </tr>
-<tr> <td>Minimum swap space </td> <td> 500 Mb </td > </tr>
-<tr> <td> Video card </td> <td> **GeForce** The following versions of GeForce drivers are recommended:
-- 64-bit Version: 100.14.19 or later http://www.nvidia.com/object/linux_display_amd64_100.14.19.html
-- 32-bit Version: 100.14.19 or later http://www.nvidia.com/object/linux_display_ia32_100.14.19.html </td > </tr>
-<tr> <td> Graphic library </td> <td> OpenGL 1.1+ (OpenGL 2.1+ is recommended) <br> OpenCL 1.1+ (optional for ray tracing) </td > </tr>
-<tr> <td>C++ </td> <td>GNU gcc 4.0. - 4.7.3. </td > </tr>
-<tr> <td> TCL (for testing tools) </td> <td> Tcltk 8.5 or 8.6 http://www.tcl.tk/software/tcltk/8.6.html</td > </tr>
-<tr> <td> Qt (for demonstration tools) </td> <td> Qt 4.6.2 http://qt.nokia.com/downloads </td > </tr>
-<tr> <td> Freetype (OCCT Text rendering) </td> <td> freetype-2.4.11 http://sourceforge.net/projects/freetype/files/ </td > </tr>
-<tr> <td> FreeImage (Support of common graphic formats) </td> <td>FreeImage 3.15.4 http://sourceforge.net/projects/freeimage/files/Source%20Distribution/ </td > </tr>
-<tr> <td> gl2ps (Export contents of OCCT viewer to vector graphic file) </td> <td> gl2ps-1.3.8 http://geuz.org/gl2ps/ </td > </tr>
-<tr> <td>TBB (optional tool for parallelized version of BRepMesh component) </td> <td> TBB 3.x or 4.x http://www.threadingbuildingblocks.org/ </td > </tr>
-<tr> <td> OpenCL (optional for providing ray tracing visualization core </td> <td>http://developer.amd.com/tools-and-sdks/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/downloads/ </td> </tr>
-</table>
-\* Debian 60 64 bit is a permanently tested platform.
-
-@subsection OCCT_OVW_SECTION_5_2 Windows Intel
-
-<table>
-<tr> <th>Operating System </th> <th> 32/64-bit: 8/ 7 SP1 / VISTA SP2 /XP SP3 </th> </tr>
-<tr> <td> Minimum memory </td> <td> 512 Mb, 1 Gb recommended </td > </tr>
-<tr> <td> Free disk space (complete installation) </td> <td> For full installation Open CASCADE Technology requires 650 Mb of disk space but during the process of installation you will need 1,2 Gb of free disk space. </td > </tr>
-<tr> <td>Minimum swap space </td> <td> 500 Mb </td > </tr>
-<tr> <td> Video card </td> <td> **GeForce** Version 266.58 WHQL or later is recommended: http://www.nvidia.com/Download/index.aspx
- </td > </tr>
-<tr> <td> Graphic library </td> <td> OpenGL 1.1+ (OpenGL 2.1+ is recommended) <br> OpenCL 1.1+ (optional for ray tracing) </td > </tr>
-<tr> <td>C++ </td> <td>
-- Microsoft Visual Studio 2005 SP1 with all security updates
-- Microsoft Visual Studio 2008 SP1*
-- Microsoft Visual Studio 2010 SP1
-- Microsoft Visual Studio 2012 Update 3
-- Microsoft Visual Studio 2013
-- Intel C++ Composer XE 2013 SP1
- </td > </tr>
-<tr> <td> TCL (for testing tools) </td> <td> ActiveTcl 8.5 or 8.6 http://www.activestate.com/activetcl/downloads </td > </tr>
-<tr> <td> Qt (for demonstration tools) </td> <td> Qt 4.6.2 http://qt.digia.com/downloads </td > </tr>
-<tr> <td> Freetype (OCCT Text rendering) </td> <td> freetype-2.4.11 http://sourceforge.net/projects/freetype/files/ </td > </tr>
-<tr> <td> FreeImage (Support of common graphic formats )</td> <td>FreeImage 3.15.4 http://sourceforge.net/projects/freeimage/files/Source%20Distribution/ </td > </tr>
-<tr> <td> gl2ps (Export contents of OCCT viewer to vector graphic file) </td> <td> gl2ps-1.3.8 http://geuz.org/gl2ps/ </td > </tr>
-<tr> <td>TBB (optional tool for parallelized version of BRepMesh component) </td> <td> TBB 3.x or 4.x http://www.threadingbuildingblocks.org/ </td > </tr>
-<tr> <td> OpenCL (optional for providing ray tracing visualization core </td> <td>http://developer.amd.com/tools-and-sdks/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/downloads/ </td> </tr>
-</table>
-
-* The official release of OCCT for Windows contains libraries built with VC++ 2008.
-
+Open CASCADE Technology is designed to be highly portable and is known to
+work on wide range of platforms (UNIX, Linux, Windows, Mac OS X).
+Current version is officially certified on Windows (IA-32 and x86-64),
+Linux (x86-64) and MAC OS X (x86-64) platforms.
+
+The tables below describe the recommended hardware and software configurations
+for which OCCT is certified to work.
+
+@subsection OCCT_OVW_SECTION_5_1 Linux
+
+| Operating System | Mandriva 2010, CentOS 5.5, CentOS 6.3, Fedora 17, Fedora 18, Ubuntu-1304, Debian 6.0\* |
+| ----- | ----- |
+| Minimum memory | 512 MB, 1 GB recommended |
+| Free disk space (complete installation) | 600 MB approx. |
+| Video card | See \ref overview_req_graphics |
+| Graphic library | OpenGL 1.1+ (OpenGL 2.1+ is recommended)|
+| C++ | GNU gcc 4.0. - 4.7.3. |
+| TCL (for testing tools) | Tcltk 8.5 or 8.6 http://www.tcl.tk/software/tcltk/8.6.html |
+| Qt (for demonstration tools) | Qt 4.6.2 http://qt.nokia.com/downloads |
+| Freetype (for text rendering) | freetype-2.4.11 http://sourceforge.net/projects/freetype/files/ |
+| FreeImage (optional, for support of common 2D graphic formats) | FreeImage 3.15.4 http://sourceforge.net/projects/freeimage/files |
+| gl2ps (optional, for export contents of OCCT viewer to vector graphic files) | gl2ps-1.3.8 http://geuz.org/gl2ps/ |
+| Intel TBB (optional, for multithreaded algorithms) | TBB 3.x or 4.x http://www.threadingbuildingblocks.org/ |
+| OpenCL (optional, for ray tracing visualization) | OpenCL SDK (usually one provided by vendor of your graphic card) or OpenCL ICD Loader by Khronos group, http://www.khronos.org/registry/cl |
+
+* Debian 60 64 bit is a platform used for regular testing of contributions
+
+@subsection OCCT_OVW_SECTION_5_2 Windows
+
+| Operating System | Windows 8 / 7 SP1 / Vista SP2 / XP SP3 |
+| ----- | ----- |
+| Minimum memory | 512 MB, 1 GB recommended |
+| Free disk space (complete installation) | 600 MB approx. |
+| Video card | See \ref overview_req_graphics |
+| Graphic library | OpenGL 1.1+ (OpenGL 2.1+ is recommended)|
+| C++ | Microsoft Visual Studio: 2005 SP1, 2008 SP1\*, 2010 SP1, 2012 Update 3, 2013 <br>Intel C++ Composer XE 2013 SP1 |
+| TCL (for testing tools) | ActiveTcl 8.5 or 8.6 http://www.activestate.com/activetcl/downloads |
+| Qt (for demonstration tools) | Qt 4.6.2 http://qt.nokia.com/downloads |
+| Freetype (OCCT Text rendering) | freetype-2.4.11 http://sourceforge.net/projects/freetype/files/ |
+| FreeImage (Support of common graphic formats) | FreeImage 3.15.4 http://sourceforge.net/projects/freeimage/files |
+| gl2ps (Export contents of OCCT viewer to vector graphic file) | gl2ps-1.3.8 http://geuz.org/gl2ps/ |
+| Intel TBB (optional, for multithreaded algorithms) | TBB 3.x or 4.x http://www.threadingbuildingblocks.org/ |
+| OpenCL (optional, for ray tracing visualization) | OpenCL SDK (usually one provided by vendor of your graphic card) or OpenCL ICD Loader by Khronos group, http://www.khronos.org/registry/cl |
+
+* VC++ 9 32-bit is used for certification of contributions and for building
+ binary package of official release of OCCT on Windows.
@subsection OCCT_OVW_SECTION_5_3 MAC OS X
-<table>
-<tr> <th>Operating System </th> <th> 64-bit: Mac OS X 10.9 Mavericks / 10.8 Mountain Lion / 10.7 Lion / 10.6.8 Snow Leopard </th> </tr>
-<tr> <td> Minimum memory </td> <td> 512 Mb, 1 Gb recommended </td > </tr>
-<tr> <td> Free disk space (complete installation) </td> <td> For full installation Open CASCADE Technology requires 600 Mb of disk space. </td > </tr>
-<tr> <td>Minimum swap space </td> <td> 500 Mb </td > </tr>
-<tr> <td> Video card </td> <td> **GeForce** Version 266.58 WHQL or later is recommended: http://www.nvidia.com/Download/index.aspx
- </td > </tr>
-<tr> <td> Graphic library </td> <td> OpenGL 1.1+ (OpenGL 2.1+ is recommended) <br> OpenCL 1.1+ (optional for ray tracing) </td > </tr>
-<tr> <td>C++ </td> <td>XCode 3.2 or newer (4.x is recommended) </td > </tr>
-<tr> <td> Qt (for demonstration tools) </td> <td> Qt 4.6.2 http://qt.digia.com/downloads </td > </tr>
-<tr> <td> Freetype (OCCT Text rendering) </td> <td> freetype-2.4.11 http://sourceforge.net/projects/freetype/files/ </td > </tr>
-<tr> <td> FreeImage (Support of common graphic formats )</td> <td>FreeImage 3.15.4 http://sourceforge.net/projects/freeimage/files/Source%20Distribution/ </td > </tr>
-<tr> <td> gl2ps (Export contents of OCCT viewer to vector graphic file) </td> <td> gl2ps-1.3.8 http://geuz.org/gl2ps/ </td > </tr>
-<tr> <td>TBB (optional tool for parallelized version of BRepMesh component) </td> <td> TBB 3.x or 4.x http://www.threadingbuildingblocks.org/ </td > </tr>
-<tr> <td> OpenCL (optional for providing ray tracing visualization core </td> <td> OpenCL 1.2.8 native </td> </tr>
-</table>
+| Operating System | Mac OS X 10.9 Mavericks / 10.8 Mountain Lion / 10.7 Lion / 10.6.8 Snow Leopard |
+| ----- | ----- |
+| Minimum memory | 512 MB, 1 GB recommended |
+| Free disk space (complete installation) | 600 MB approx. |
+| Video card | See \ref overview_req_graphics |
+| Graphic library | OpenGL 1.1+ (OpenGL 2.1+ is recommended)|
+| C++ | XCode 3.2 or newer (4.x is recommended) |
+| Qt (for demonstration tools) | Qt 4.6.2 http://qt.nokia.com/downloads |
+| Freetype (OCCT Text rendering) | freetype-2.4.11 http://sourceforge.net/projects/freetype/files/ |
+| FreeImage (Support of common graphic formats) | FreeImage 3.15.4 http://sourceforge.net/projects/freeimage/files |
+| gl2ps (Export contents of OCCT viewer to vector graphic file) | gl2ps-1.3.8 http://geuz.org/gl2ps/ |
+| Intel TBB (optional, for multithreaded algorithms) | TBB 3.x or 4.x http://www.threadingbuildingblocks.org/ |
+| OpenCL (optional, for ray tracing visualization) | Native OpenCL 1.2.8 |
+
+@subsection overview_req_graphics Graphic cards
+
+For 3d viewer, graphic card or software implementation supporting OpenGL 1.1
+or above is required. OpenGL 2.1+ is highly recommended.
+For ray tracing, hardware implementation of OpenCL 1.1+ is required.
+
+The following table lists graphic cards tested to work with OCCT.
+
+| Graphic card | Driver/GL/GLSL/CL version | OS | OpenGL (fixed pipeline) | OpenGL (shaders) | OpenCL (ray tracing) |
+| ---- | ---- | ---- | :----: | :----: | :----: |
+| NVIDIA GeForce GT 610, 630M, 640 | Driver 311.44, GL 4.3.0, GLSL 4.30 | Windows 7 64 bit | OK | OK | OK |
+| Intel(R) HD Graphics 3000 | GL 3.1.0, GLSL 1.40 | Windows 7 64 bit | OK | OK | none |
+| RadeOn 9600 | GL 2.1.8454, GLSL 1.20 | | OK | bad | none |
+| AMD/ATI RadeOn HD 7870 | Driver 6.14.10.12002, GL 4.2.12002, GLSL 4.20 | Windows 7 64-bit | OK | OK | OK |
+| Mesa 7.8.2 Windows GDI Driver\* | GL 2.1, GLSL version 1.20 | Mac OS X 10.6 / OS X 10.9 | OK | artifacts | none |
+| NVIDIA GeForce 320 | | Mac OS X 10.6 / OS X 10.9 | OK | OK | OK on OSX 10.6, bad on OSX 10.9 |
+| NVIDIA GeForce 6600 GT | GL 2.1.2, GLSL 1.20 | Windows XP 32-bit | OK | OK | none |
+| Apple software OpenGL | | Mac OS X 10.6 / OS X 10.9 | OK | OK | OK |
+
+* Mesa implementation of OpenGL is used for certification testing of OCCT
@section OCCT_OVW_SECTION_4 Installation
they will be allocated in the C heap by malloc();
* **CSF_LANGUAGE** is required to define the default language of messages;
* **CSF_DEBUG** (optional, Windows only): if defined then a diagnostic message is displayed in case of an exception;
- * **CSF_DEBUG_BOP** (optional): if defined then it should specify directovy where diagnostic data on problems occured in Boolean operations will be saved;
+ * **CSF_DEBUG_BOP** (optional): if defined then it should specify directory where diagnostic data on problems occured in Boolean operations will be saved;
* **CSF_MDTVTexturesDirectory** defines the directory for available textures when using texture mapping;
+ * **CSF_ShadersDirectory** defines the directory for GLSL programs (required for advanced rendering techniques and custom shaders);
* **CSF_UnitsDefinition** and **CSF_UnitsLexicon** should define paths to resource files Lexi_Expr.dat and Units.dat, respectively, required for support of measurement units;
* **CSF_SHMessage** is required in order to define the path to the messages file for *ShapeHealing*;
* **CSF_XSMessage** is required in order to define the path to the messages file for **STEP** and **IGES** translators;
The pload command loads the plug-in in accordance with
the specified resource file and activates the commands implemented in the plug-in.
-The whole process of using the plug-in mechanism as well as the instructions for extending Test Harness is described in the
-@ref user_guides__test_harness.
+The whole process of using the plug-in mechanism as well as the instructions for extending Test Harness is described in the @ref user_guides__test_harness.
Draw Test Harness provides an environment for OCCT automated testing system.
Please, consult its @ref dev_guides__tests "Automated Testing System" for details.
**On Linux:**
-1. If OCCT was built by Code::Blocks * use $CASROOT/draw_cbp.sh file to launch DRAWEXE executable;
-2. If OCCT was built by Automake * use $CASROOT/draw_amk.sh file to launch DRAWEXE executable;
+1. If OCCT was built by Code::Blocks use <i>$CASROOT/draw_cbp.sh</i> file to launch *DRAWEXE* executable;
+2. If OCCT was built by Automake use <i>$CASROOT/draw_amk.sh</i> file to launch *DRAWEXE* executable;
Draw[1]> prompt appears in the command window
-Type pload ALL
+Type *pload ALL*
**On Windows:**
Launch Draw executable from Open CASCADE Technology\\Test Harness\\Draw Test Harness
-item of the Start\\Programs menu or Use $CASROOT\\draw.bat file to launch DRAWEXE executable.
+item of the Start\\Programs menu or Use <i>$CASROOT\\draw.bat</i> file to launch *DRAWEXE* executable.
Draw[1]> prompt appears in the command window
**Creating your first geometric objects**
-1. In the command window, type axo to create an axonometric view
-2. Type box b -10 -10 -10 20 20 20 to create a cube b of size 20,
- parallel to the X Y Z axis and centered on the origin.
- The cube will be displayed in the axonometric view in wireframe mode
-3. Type fit to fill the viewer with the cube
-4. Type pcylinder c 2 30 to create a cylinder c of radius 2 and height 30.
- The cylinder will be displayed in addition to the cube
+1. In the command window, type *axo* to create an axonometric view
+2. Type *box b -10 -10 -10 20 20 20* to create a cube *b* of size 20, parallel to the X Y Z axis and centered on the origin. The cube will be displayed in the axonometric view in wireframe mode.
+3. Type *fit* to fill the viewer with the cube
+4. Type *pcylinder c 2 30* to create a cylinder *c* of radius 2 and height 30. The cylinder will be displayed in addition to the cube
**Manipulating the view**
-1. Type clear to erase the view
-2. Type donly c to display the cylinder only
-3. Type donly b to display the cube only
-4. Type hlr hlr b to display the cube in the hidden line removal mode
+1. Type *clear* to erase the view
+2. Type *donly c* to display the cylinder only
+3. Type *donly b* to display the cube only
+4. Type *hlr hlr b* to display the cube in the hidden line removal mode
**Running demonstration files**
-1. Type cd ../.. to return to the root directory
-2. Type cd src/DrawResources to reach the DrawResources directory
-3. Type source "Available Demo File" to run the demonstration provided with Open CASCADE
-4. The following demonstration files are available:
+1. Type *cd ../..* to return to the root directory
+2. Type *cd samples/tcl* to reach the *DrawResources* directory
+3. Type *source <demo_file>* to run the demonstration file provided with Open CASCADE. The following demonstration files are available:
+ * bottle.tcl
+ * challenge.tcl
* DataExchangeDemo.tcl
* ModelingDemo.tcl
- * OCAFDemo.tcl
* VisualizationDemo.tcl
**Getting Help**
-1. Type help to see all available commands
-2. Type help command-name to find out the arguments for a given command
+1. Type *help* to see all available commands
+2. Type *help <command_name>* to find out the arguments for a given command
@subsection OCCT_OVW_SECTION_7_3 Programming Samples
* To start a sample use Open CASCADE Technology\\Samples\\Mfc\\ item of the Start\\Programs menu;
* Read carefully readme.txt to learn about launching and compilation options.
+See \subpage samples_mfc_standard "Readme" for details.
+
@subsubsection OCCT_OVW_SECTION_7_3_2 Qt
OCCT contains three samples based on Qt application framework
Voxel
------
-This is a demonstration application showing OCCT voxel models.
-It also includes a set of non-regression tests and other commands
-for testing this functionality (accessible only through TEST pre-processor definition).
+This is a demonstration application showing OCCT voxel models. It also includes a set of non-regression tests and other commands for testing this functionality (accessible only through TEST pre-processor definition).
-**See also:** Voxels User's guide (under construction)
+**See also:** <a href="occt_voxels_wp.html">Voxels User's guide</a>
**Remarks:**
@subsubsection OCCT_OVW_SECTION_7_3_3 C#
-C# sample demonstrates integration of OCCT 3D Viewer and Import / Export functionality
-into .NET applications (using Windows Forms and WPF front ends).
+C# sample demonstrates integration of OCCT 3D Viewer and Import / Export functionality into .NET applications (using Windows Forms and WPF front ends).
@image html /overview/images/overview_c__ie.png
@image latex /overview/images/overview_c__ie.png
* Step
* Stl
* Vrml
+
+See \subpage samples_csharp "Readme" for details.
+
projects / occt.git / blobdiff