0028371: Configuration - update system requirements page
[occt.git] / dox / overview / overview.md
1 \feffOverview {#mainpage}
2 ========
3
4 @tableofcontents
5
6 @htmlonly<center>@endhtmlonly 
7 @image html /resources/occt_logo.png
8 @image latex /resources/occt_logo.png
9 @htmlonly</center>@endhtmlonly
10
11 @section OCCT_OVW_SECTION_1 Welcome
12
13 Welcome to Open CASCADE Technology (OCCT), a software development platform 
14 providing services for 3D surface and solid modeling, CAD data exchange, and 
15 visualization. Most of OCCT functionality is available in the form of C++ 
16 libraries. OCCT can be best applied in development of software dealing with 3D 
17 modeling (CAD), manufacturing / measuring (CAM) or numerical simulation (CAE).
18
19 @section OCCT_OVW_SECTION_2 Copyrights
20
21 Open CASCADE Technology and all materials, including this documentation, is 
22 Copyright (c) 1999-2016 by OPEN CASCADE S.A.S. All rights reserved.
23
24 @htmlonly<center>@endhtmlonly
25 http://www.opencascade.com
26 @image html /resources/occ_logo.png
27 @image latex /resources/occ_logo.png
28 @htmlonly</center>@endhtmlonly
29
30  License
31 --------
32
33 Open CASCADE Technology is free software; you can redistribute it and / or 
34 modify it under the terms of the 
35 @ref license_lgpl_21 "GNU Lesser General Public License (LGPL) version 2.1", 
36 with additional @ref occt_lgpl_exception "exception".
37
38 Alternatively, Open CASCADE Technology may be used under the terms of Open 
39 CASCADE commercial license or contractual agreement.
40
41 Note that Open CASCADE Technology is provided on an "AS IS" basis, WITHOUT 
42 WARRANTY OF ANY KIND. The entire risk related to any use of the OCCT code and 
43 materials is on you. See the @ref occt_public_license "license" text for formal 
44 disclaimer.
45
46  Trademark information
47 ----------------------
48
49 You are hereby informed that all software is a property of its respective authors and is protected by 
50 international and domestic laws on intellectual property and trademarks. 
51 Should you need further information, please directly contact the authors.
52
53 **CAS.CADE** and **Open CASCADE** are registered trademarks of 
54 OPEN CASCADE S.A.S.
55
56 **Linux** is a registered trademark of Linus Torvalds.
57
58 **Windows** is a registered trademark of Microsoft Corporation in the United States and other countries.
59
60 **Mac** and the Mac logo are trademarks of Apple Inc., registered in the U.S. and other countries.
61
62  Acknowledgments
63 -----------------
64
65 The following parties are acknowledged for producing tools which are used within 
66 Open CASCADE Technology libraries or for release preparation.
67
68 You are hereby informed that all rights to the software listed below belong to its respective 
69 authors and such software may not be freely available and/or be free of charge for any kind 
70 of use or purpose. We strongly recommend that you carefully read the license of these products 
71 and, in case you need any further information, directly contact their authors.
72
73 **Qt** is a cross-platform application framework that is widely used for developing application software 
74 with graphical user interface (GUI). Qt is free and open source software distributed under 
75 the terms of the GNU Lesser General Public License. In OCCT Qt is used for programming samples. 
76 If you need further information on Qt, please, refer to Qt Homepage (http://www.qt.io/)
77
78 **Tcl** is a high-level programming language. Tk is a graphical user interface (GUI) toolkit, 
79 with buttons, menus, listboxes, scrollbars, and so on. Taken together Tcl and Tk provide a solution 
80 to develop cross-platform graphical user interfaces with a native look and feel. Tcl/Tk is under copyright by 
81 Scriptics Corp., Sun Microsystems, and other companies. However, Tcl/Tk is an open source, and 
82 the copyright allows you to use, modify, and redistribute Tcl/Tk for any purpose, without an 
83 explicit license agreement and without paying any license fees or royalties. 
84 To use Tcl/Tk, please refer to the Licensing Terms (http://www.tcl.tk/software/tcltk/license.html).
85
86 **GL2PS** is developed by Christophe Geuzaine and others. It is optionally used by OCCT to
87 export content of OpenGL scene to vector graphics formats (PS, PDF, EMF, SVG). 
88 The library is licensed under GL2PS LICENSE http://www.geuz.org/gl2ps/COPYING.GL2PS Version 2, November 2003.
89
90 **FreeType 2** is developed by Antoine Leca, David Turner, Werner Lemberg and others. 
91 It is a software font engine that is designed to be small, efficient, highly customizable and 
92 portable while capable of producing high-quality output (glyph images). This product 
93 can be used in graphic libraries, display servers, font conversion tools, 
94 text image generation tools, and many other products.
95
96 FreeType 2 is released under two open-source licenses: BSD-like FreeType License and the GPL.
97
98 **Intel(R) Threading Building Blocks (TBB)** offers a rich and complete approach to expressing parallelism in a C++ program. 
99 It is a library that helps you to take advantage of multi-core processor performance without having to be a threading expert. 
100 Threading Building Blocks is not just a threads-replacement library. It represents a higher-level, task-based parallelism that 
101 abstracts platform details and threading mechanisms for scalability and performance. 
102 TBB is available under GPLv2 license with the runtime exception.
103
104 **OpenGL** is an industry standard API for 3D graphics used by OCCT for 
105 implementation of 3D viewer. OpenGL specification is developed by the
106 Khronos group, http://www.khronos.org/opengl/. OCCT code includes header 
107 file *glext.h* obtained from Khronos web site.
108
109 **VTK** -- The **Visualization Toolkit (VTK)** is an open-source, freely available software system for 3D computer graphics, image processing and visualization. OCCT VIS component provides adaptation functionality for visualization of OCCT topological shapes by means of VTK library. If you need further information on VTK, please, refer to VTK Homepage http://www.vtk.org/.
110
111 **Doxygen** developed by Dimitri van Heesch is open source documentation system for 
112 C++, C, Java, Objective-C, Python, IDL, PHP and C#. This product is used in Open CASCADE Technology 
113 for automatic creation of Technical Documentation from C++ header files. 
114 If you need further information on Doxygen, please refer to http://www.stack.nl/~dimitri/doxygen/index.html.
115
116 **Graphviz** is open source graph visualization software developed by John Ellson, Emden Gansner, Yifan Hu and Arif Bilgin. 
117 Graph visualization is representiation of structured information as diagrams of abstract graphs and networks. 
118 This product is used together with Doxygen in Open CASCADE Technology for automatic creation of Technical Documentation 
119 (generation of dependency graphs). Current versions of Graphviz are licensed on an open source 
120 basis under The Eclipse Public License (EPL) (http://www.graphviz.org/License.php).
121
122 **Inno Setup** is a free script-driven installation system created in CodeGear Delphi by Jordan Russell. 
123 In OCCT Inno Setup is used to create Installation Wizard on Windows. 
124 It is licensed under Inno Setup License (http://www.jrsoftware.org/files/is/license.txt).
125
126 **FreeImage** is an Open Source library supporting popular graphics image formats, such as PNG, BMP, JPEG, TIFF, 
127 and others used by multimedia applications. This library is developed by HervĂ© Drolon and Floris van den Berg. 
128 FreeImage is easy to use, fast, multithreading safe, compatible with all 32-bit or 64-bit versions of Windows, 
129 and cross-platform (works both with Linux and Mac OS X). FreeImage is optionally used by OCCT to work
130 with images, on conditions of the FreeImage Public License (FIPL) (http://freeimage.sourceforge.net/freeimage-license.txt).
131
132 **MikTEX** is up-to-date implementation of TeX/LaTeX and related programs for Windows. It is used 
133 for generation of User and Developer Guides in PDF format. See http://miktex.org for information
134 on this tool.
135
136 Adobe Systems, Inc. provides **Adobe Reader**, which can be used to view files in Portable Document Format (PDF). 
137
138 @section OCCT_OVW_SECTION_3 Documentation
139
140 OCCT documentation is provided in several forms:
141
142 - This overview provides general description of OCCT structure, functionality, modules, and features. 
143   It is available in HTML format (generated by Doxygen) and includes User and Developer Guides.
144   The sources of this documentation are contained in **dox** subdirectory of OCCT sources 
145   (plain text format is used, with mixed MarkDown / Doxygen syntax mark-up).
146
147 - User and Developer Guides describing in details OCCT modules and development tools are also available in 
148   Adobe Portable Document Format (PDF). To read this format, you need Adobe Acrobat Reader, 
149   which is a freeware and can be downloaded from the Adobe site. 
150
151 - Full reference documentation covering all OCCT classes generated automatically by Doxygen 
152   software is provided in HTML format. 
153   Reference documentation is presented in **Modules --> Toolkits --> Packages --> Classes** 
154   logic structure with cross-references to all OCCT classes and complete in-browser search by all classes.
155
156 See @ref occt_dev_guides__documentation "OCCT Documentation Guide" for details on OCCT documentation system.
157
158 **Generation of HTML documentation**
159
160 To generate HTML documentation from sources contained in *dox* subdirectory, 
161 you need to have Tcl and Doxygen 1.8.5 (or above) installed on your system.
162
163 Use script **gendoc** (batch file on Windows, shell script on Linux / Mac OSX) to generate documentation.
164
165 To generate Overview documentation:
166
167     cmd> gendoc -overview
168
169 To generate Reference manual:
170
171     cmd> gendoc -refman
172
173 Run this command without arguments to get help on supported options.
174
175 @section OCCT_OVW_SECTION_5 Requirements
176
177 Open CASCADE Technology is designed to be highly portable and is known to 
178 work on wide range of platforms. 
179 Current version is officially certified on Windows (IA-32 and x86-64), 
180 Linux (x86-64), OS X / macOS (x86-64), Android (armv7 and x86), and 
181 iOS (armv7, arm64) platforms. 
182
183 The tables below describe the recommended software configurations
184 for which OCCT is certified to work.
185
186 @subsection overview_req_cpp C++ Compiler / IDE
187
188 | OS        | Compiler |
189 | --------- | ----------- |
190 | Windows   | Microsoft Visual Studio: 2010 SP1<sup>1</sup>, 2012 Update 4, 2013 Update 5, 2015 <br> Intel C++ Composer XE 2013 SP1 <br> GCC 4.3+ (Mingw-w64)|
191 | Linux     | GNU gcc 4.3+ <br> LLVM CLang 3.6+ |
192 | OS X      | XCode 6 or newer |
193 | Android   | NDK r10, GNU gcc 4.8 or newer |
194
195 1) VC++ 10 64-bit is used for regular testing and for building 
196   binary package of official release of OCCT on Windows.
197
198 @subsection overview_req_libs Third-party libraries
199
200 | Component | Requirement |
201 | --------- | ----------- |
202 | Graphic library | OpenGL 3.3+, OpenGL ES 2.0+ <br> Direct3D 9 |
203 | Qt (for samples and demos) | Desktop: Qt 4.8.6+ http://www.qt.io/download/ <br> Android: Qt 5.3.2+ http://www.qt.io/download/ |
204 | TCL (for testing tools)    | Tcl/Tk 8.6.3+ http://www.tcl.tk/software/tcltk/download.html <br> or ActiveTcl 8.6 http://www.activestate.com/activetcl/downloads (for Windows)| 
205 | Freetype (for text rendering) | FreeType 2.4.11-2.5.5 http://sourceforge.net/projects/freetype/files/ |
206 | FreeImage (optional, for support of common 2D graphic formats) | FreeImage 3.17.0+ http://sourceforge.net/projects/freeimage/files |
207 | gl2ps (optional, for export contents of OCCT viewer to vector formats) | gl2ps-1.3.8+  http://geuz.org/gl2ps/ |
208 | Intel TBB (optional, for multithreaded algorithms) | TBB 4.x or 5.x http://www.threadingbuildingblocks.org/ |
209 | VTK (for VTK Integration Services | VTK 6.1+ http://www.vtk.org/VTK/resources/software.html |
210 | Doxygen (optional for building documentation) | Doxygen 1.8.5+ http://www.stack.nl/~dimitri/doxygen/download.html |
211
212 @subsection overview_req_hw Hardware
213
214 | Component | Requirement |
215 | --------- | ----------- |
216 | Minimum memory    | 512 MB, 1 GB recommended |
217 | Free disk space (complete installation) | 600 MB approx. |
218
219 On desktop, 3D viewer for optimal performance requires graphics processing unit (GPU) supporting OpenGL 3.3 or above. 
220 Ray tracing requires OpenGL 4.0+ or OpenGL 3.3+ with *GL_ARB_texture_buffer_object_rgb32* extension.
221 Textures within ray tracing will be available only when *GL_ARB_bindless_texture extension* is provided by driver.
222
223 On mobile platforms, OpenGL ES 2.0+ is required for 3D viewer (OpenGL ES 3.1+ is recommended).
224 The ray tracing is not yet available on mobile platforms.
225 Some old hardware might be unable to execute complex GLSL programs (e.g. with high number of light sources, clipping planes).
226
227 OCCT 3D Viewer, in general, supports wide range of graphics hardware - from very old to new.
228 Therefore, if you observe some unexpected visual issues - first check for OpenGL driver update (or firmware update in case of mobile platforms);
229 but beware that driver update might also come with new bugs.
230 Don't forget to report these bugs to vendors.
231
232 @section OCCT_OVW_SECTION_4 Installation
233
234 In most cases you need to rebuild OCCT on your platform (OS, compiler) before
235 using it in your project, to ensure binary compatibility.
236 See @ref occt_dev_guides__building for instructions on
237 building OCCT from sources on supported platforms.
238
239 @subsection OCCT_OVW_SECTION_4_1 Using Windows installer
240
241 On Windows Open CASCADE Technology can be installed with binaries precompiled by 
242 Visual C++ 2010 with installation procedure.
243
244 **Recommendation:**
245
246 If you have a previous version of OCCT installed on your station, 
247 and you do not plan to use it along with the new version, you might want to uninstall 
248 the previous version (using Control Panel, Add/Remove Programs) before 
249 the installation of this new version, to avoid possible problems 
250 (conflict of system variables, paths, etc).
251
252 **Attention:** For full installation OCCT requires approximately 650 Mb of disk space, 
253 but during the installation process you will need 1,2 Gb of free disk space.
254
255 OCCT installation with reference documentation requires 1,4 Gb on disk.
256
257   * Download the OCCT installer from OPEN CASCADE web site using the link. you have been provided
258   * Launch the installer and follow the instructions.
259
260 The includes and binaries of third-party libraries necessary for building and launching 
261 OCCT are included into binary distribution (built with Visual C++ 2010). 
262 When the installation is complete, you will find the directories for 3rd party products 
263 (some might be absent in case of custom installation) and the main **OCCT** directory:
264
265 @image html /overview/images/overview_3rdparty.png 
266 @image latex /overview/images/overview_3rdparty.png 
267
268 The contents of the OCCT-7.0.0 directory (called further "OCCT root", or $CASROOT) are as follows:
269
270 @image html /overview/images/overview_installation.png "The directory tree"
271 @image latex /overview/images/overview_installation.png "The directory tree"
272
273   * **adm**   This folder contains administration files, which allow rebuilding OCCT;
274   * **adm/cmake**  This folder contains files of CMake building procedure;
275   * **adm/msvc**  This folder contains Visual Studio projects for Visual C++  2005, 2008, 2010, 2012 and 2013 which allow rebuilding OCCT under Windows platform in 32 and 64-bit mode;
276   * **data**  This folder contains CAD files in different formats, which can be used to test the OCCT functionality;
277   * **doc**  This folder contains OCCT documentation in HTML and PDF format;
278   * **dox**  This folder contains sources of OCCT documentation in plain text (MarkDown) format;
279   * **inc**  This folder contains copies of all OCCT header files;
280   * **samples**  This folder contains sample applications.
281   * **src**  This folder contains OCCT source files. They are organized in folders, one per development unit;
282   * **tests**  This folder contains scripts for OCCT testing.
283   * **win64/vc10**  This folder contains executable and library files built in optimize mode for Windows platform by Visual C++  2010;
284
285 @section OCCT_OVW_SECTION_4_2 Environment Variables
286
287 To run any Open CASCADE Technology application you need to set the environment variables.
288
289 ### On Windows
290
291 You can define the environment variables with env.bat script located in the 
292 $CASROOT folder. This script accepts two arguments to be used: 
293 the version of Visual Studio (vc8 -- vc12) and the architecture (win32 or win64).
294
295 The additional environment settings necessary for compiling OCCT libraries and samples 
296 by Microsoft Visual Studio can be set using script custom.bat located in the same folder. 
297 You might need to edit this script to correct the paths to third-party libraries 
298 if they are installed on your system in a non-default location.
299
300 Script msvc.bat can be used with the same arguments for immediate launch of Visual Studio for (re)compiling OCCT.
301
302 ### On Unix
303
304
305   If OCCT was built by Code::Blocks, you can define the environment variables with env_cbp.sh or custom_cbp.sh script.
306
307   If OCCT was built by Automake, you can define the environment variables with env_amk.sh or custom_amk.sh script.
308
309 The scripts are located in the OCCT root folder.
310
311  
312 ### Description of system variables:
313
314   * **CASROOT** is used to define the root directory of Open CASCADE Technology;
315   * **PATH** is required to define the path to OCCT binaries and 3rdparty folder;
316   * **LD_LIBRARY_PATH** is required to define the path to OCCT libraries (on UNIX platforms only);
317   * **MMGT_OPT** (optional) if set to 1, the memory manager performs optimizations as described below; if set to 2, 
318     Intel (R) TBB optimized memory manager is used; if 0 (default), every memory block is allocated 
319     in C memory heap directly (via malloc() and free() functions). 
320     In the latter case, all other options starting with *MMGT*, except MMGT_CLEAR, are ignored;
321   * **MMGT_CLEAR** (optional) if set to 1 (default), every allocated memory block is cleared by zeros; 
322     if set to 0, memory block is returned as it is;
323   * **MMGT_CELLSIZE** (optional) defines the maximal size of blocks allocated in large pools of memory. Default is 200;
324   * **MMGT_NBPAGES** (optional) defines the size of memory chunks allocated for small blocks in pages 
325     (operating-system dependent). Default is 10000;
326   * **MMGT_THRESHOLD** (optional) defines the maximal size of blocks that are recycled internally 
327     instead of being returned to the heap. Default is 40000;
328   * **MMGT_MMAP** (optional) when set to 1 (default), large memory blocks are allocated using 
329     memory mapping functions of the operating system; if set to 0, 
330     they will be allocated in the C heap by malloc();
331   * **CSF_LANGUAGE** (optional) defines default language of messages;
332   * **CSF_DEBUG** (optional, Windows only): if defined then a diagnostic message is displayed in case of an exception;
333   * **CSF_DEBUG_BOP** (optional): if defined then it should specify directory where diagnostic data on problems occured in Boolean operations will be saved;
334   * **CSF_MDTVTexturesDirectory** defines the directory for available textures when using texture mapping;
335   * **CSF_ShadersDirectory** (optional) defines the directory for GLSL programs for Ray Tracing renderer (embedded resources are used when variable is undefined);
336   * **CSF_SHMessage** (optional) defines the path to the messages file for *ShapeHealing*;
337   * **CSF_XSMessage** (optional) defines the path to the messages file for **STEP** and **IGES** translators;
338   * **CSF_StandardDefaults**, **CSF_StandardLiteDefaults*, **CSF_XCAFDefaults**, and **CSF_PluginDefaults** define paths to directory where configuration files for OCAF persistence are located (required for open/save operations with OCAF documents);
339   * **CSF_IGESDefaults** and **CSF_STEPDefaults** (optional) define paths to directory where resource files of **IGES** and **STEP** translators are located;
340   * **CSF_XmlOcafResource** is required in order to set the path to **XSD** resources, which defines XML grammar.
341   * **CSF_MIGRATION_TYPES** is required in order to read documents that contain old data types, such as *TDataStd_Shape*;
342
343 @section OCCT_OVW_SECTION_7 Getting Started
344
345 @subsection OCCT_OVW_SECTION_7_1 Draw Test Harness
346
347 Draw is a command interpreter based on TCL and a graphical system used for testing and demonstrating OCCT modeling libraries.
348
349 Draw can be used interactively to create, display and modify objects such as curves, surfaces and topological shapes.
350
351 @image html /overview/images/overview_draw.png
352 @image latex /overview/images/overview_draw.png
353
354 Scripts can be written to customize Draw and perform tests. 
355 New types of objects and new commands can be added using C++ programming language.
356
357 Draw contains:
358
359   * A command interpreter based on TCL command language.
360   * A 2D an 3D graphic viewer with support of operations such as zoom, pan, rotation and full-screen views.
361   * An optional set of geometric commands to create and modify curves and surfaces and to use OCCT geometry algorithms.
362   * A set of topological commands to create and modify BRep shapes and to use OCCT topology algorithms.
363   * A set of graphic commands for view and display operations including Mesh Visualization Service.
364   * A set of Application framework commands for handling of files and attributes.
365   * A set of Data Exchange commands for translation of files from various formats (IGES,STEP) into OCCT shapes.
366   * A set of Shape Healing commands: check of overlapping edges, approximation of a shape to BSpline, etc.  
367
368 You can add new custom test harness commands to Draw in order to test 
369 or demonstrate a new functionality, which you are developing.
370
371 Currently DRAW Test Harness is a single executable called *DRAWEXE*.
372
373 Commands grouped in toolkits can be loaded at run-time thereby implementing dynamically loaded plug-ins. 
374 Thus you can work only with the commands that suit your needs adding 
375 the commands dynamically without leaving the Test Harness session.
376
377 Declaration of available plug-ins is done through special resource file(s). 
378 The *pload* command loads the plug-in in accordance with 
379 the specified resource file and activates the commands implemented in the plug-in.
380
381 The whole process of using the plug-in mechanism as well as the instructions for extending Test Harness is described in the @ref occt_user_guides__test_harness.
382
383 Draw Test Harness provides an environment for OCCT automated testing system. 
384 Please, consult its @ref occt_dev_guides__tests "Automated Testing System" for details.
385
386 Remarks:
387
388 * The DRAWEXE executable is delivered with the installation procedure on Windows platform only.
389 * To start it, launch DRAWEXE executable from Open CASCADE Technology/Draw Test Harness item of the Start\\Programs menu.
390
391 @subsection OCCT_OVW_SECTION_7_2 Experimenting with Draw Test Harness
392
393  Running Draw
394 ------------
395
396 **On Linux:**
397
398 1. If OCCT was built by Code::Blocks  use <i>$CASROOT/draw_cbp.sh</i> file to launch *DRAWEXE* executable;
399 2. If OCCT was built by Automake    use <i>$CASROOT/draw_amk.sh</i> file to launch *DRAWEXE* executable;
400
401 Draw[1]> prompt appears in the command window
402
403 Type *pload ALL*
404
405 **On Windows:**
406
407 Launch Draw executable from Open CASCADE Technology\\Test Harness\\Draw Test Harness 
408 item of the Start\\Programs menu or Use <i>$CASROOT\\draw.bat</i> file to launch *DRAWEXE* executable.
409
410 Draw[1]> prompt appears in the command window
411
412 Type pload ALL
413
414 **Creating your first geometric objects**
415
416 1. In the command window, type *axo* to create an axonometric view
417 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.
418 3. Type *fit* to fill the viewer with the cube
419 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
420
421 **Manipulating the view**
422
423 1. Type *clear* to erase the view
424 2. Type *donly c* to display the cylinder only
425 3. Type *donly b* to display the cube only
426 4. Type *hlr hlr b* to display the cube in the hidden line removal mode
427
428 **Running demonstration files**
429
430 1. Type *cd ../..* to return to the root directory
431 2. Type *cd samples/tcl* to reach the *DrawResources* directory
432 3. Type *source \<demo_file\>* to run the demonstration file provided with Open CASCADE. The following demonstration files are available:
433   * DataExchangeDemo.tcl: demonstrates sample sequence of operations with writing and reading IGES file
434   * ModelingDemo.tcl: demonstrates creation of simple shape and displaying it in HLR mode
435   * VisualizationDemo.tcl: demonstrates use of 3d viewer
436   * cad.tcl: creates solid shape looking like abbreviation "CAD"
437   * bottle.tcl: creates bottle as in OCCT Tutorial
438   * drill.tcl: creates twist drill bit shape
439   * cutter.tcl: creates milling cutter shape
440   * xde.tcl: demonstrates creation of simple assembly in XDE
441   * materials.tcl: demonstrates visual properties of materials supported by 3d viewer
442   * raytrace.tcl: demonstrates use of ray tracing display in 3d viewer
443   * dimensions.tcl: demonstrates use of dimensions, clipping, and capping in 3d viewer
444
445 **Getting Help**
446
447 1. Type *help* to see all available commands
448 2. Type *help \<command_name\>* to find out the arguments for a given command
449
450 @subsection OCCT_OVW_SECTION_7_3 Programming Samples
451
452 @subsubsection OCCT_OVW_SECTION_7_3_1 MFC 
453
454 Visual C++ programming samples containing 10 Visual C++ projects 
455 illustrating how to use a particular module or functionality.
456
457 The list of MFC samples:
458
459   * Geometry
460   * Modeling
461   * Viewer2d
462   * Viewer3d
463   * ImportExport
464   * Ocaf
465   * Triangulation
466   * HLR
467   * Animation
468   * Convert
469
470 @image html /overview/images/overview_mvc.png
471 @image latex /overview/images/overview_mvc.png
472
473 **Remarks:**
474
475   * MFC samples are available only on Windows platform;
476   * To start a sample use Open CASCADE Technology\\Samples\\Mfc\\ item of the Start\\Programs menu;
477   * Read carefully readme.txt to learn about launching and compilation options.
478
479 See \subpage samples_mfc_standard "Readme" for details.
480
481 @subsubsection OCCT_OVW_SECTION_7_3_2 Qt
482
483 OCCT contains three samples based on Qt application framework
484
485  Import Export
486 -------------
487
488  Import Export programming sample contains 3D Viewer and Import / Export functionality.
489
490 @image html /overview/images/overview_qt.png
491 @image latex /overview/images/overview_qt.png
492
493  Tutorial
494 ---------
495
496 The Qt programming tutorial teaches how to use Open CASCADE Technology services to model a 3D object. 
497 The purpose of the tutorial is not to explain all OCCT classes but 
498 to help start thinking in terms of the Open CASCADE Technology.
499
500 This tutorial assumes that  the user has experience in using and setting up C++. 
501 From the viewpoint of programming, Open CASCADE Technology is designed 
502 to enhance user's C++ tools with high performance modeling classes, methods and functions. 
503 The combination of these resources allows creating substantial applications.
504
505 **See also:** @ref occt__tutorial "OCCT Tutorial" 
506
507 **Remarks:**
508
509   * Qt samples are available on all supported platforms;
510   * To start a sample on Windows use Open CASCADE Technology\\Samples\\Qt\\ item of the Start\\Programs menu.
511
512 @subsubsection OCCT_OVW_SECTION_7_3_3 C#
513
514 C# sample demonstrates integration of OCCT 3D Viewer and Import / Export functionality into .NET applications (using Windows Forms and WPF front ends).
515
516 @image html /overview/images/overview_c__ie.png
517 @image latex /overview/images/overview_c__ie.png
518
519 Import:
520
521   * BRep
522   * Iges
523   * Step
524
525 Export: 
526
527   * Brep
528   * Iges
529   * Step
530   * Stl
531   * Vrml
532
533 See \subpage samples_csharp_occt "Readme" for details.
534
535 There is also another C# example with the same functionality, which demonstrates the integration of Direct3D Viewer into .NET applications using WPF front end.
536
537 See \subpage samples_csharp_direct3d "Readme" for details.
538
539 @subsubsection OCCT_OVW_SECTION_7_3_4 Android
540
541 There are two samples are representing usage OCCT framework on Android mobile platform. They represent an OCCT-based 3D-viewer with CAD import support in formats BREP, STEP and IGES: jniviewer (java) and AndroidQt (qt+qml)
542
543 jniviewer
544 @image html /overview/images/samples_java_android_occt.jpg
545 @image latex /overview/images/samples_java_android_occt.jpg
546 Java -- See \subpage samples_java_android_occt "Readme" for details.
547
548 AndroidQt
549 @image html /overview/images/samples_qml_android_occt.jpg
550 @image latex /overview/images/samples_qml_android_occt.jpg
551 Qt -- See \subpage samples_qml_android_occt "Readme" for details.