0027338: Minor corrections in Tcl samples and documentation
[occt.git] / dox / overview / overview.md
f1c9c9d7 1Overview {#mainpage}
ba06f8bb 2========
e2ba9cb1 6@htmlonly<center>@endhtmlonly
7@image html /resources/occt_logo.png
8@image latex /resources/occt_logo.png
ba06f8bb 11@section OCCT_OVW_SECTION_1 Welcome
13Welcome to Open CASCADE Technology (OCCT), a software development platform
14providing services for 3D surface and solid modeling, CAD data exchange, and
15visualization. Most of OCCT functionality is available in the form of C++
16libraries. OCCT can be best applied in development of software dealing with 3D
17modeling (CAD), manufacturing / measuring (CAM) or numerical simulation (CAE).
ba06f8bb 19@section OCCT_OVW_SECTION_2 Copyrights
21Open CASCADE Technology and all materials, including this documentation, is
251a7984 22Copyright (c) 1999-2016 by OPEN CASCADE S.A.S. All rights reserved.
ba06f8bb 23
26@image html /resources/occ_logo.png
27@image latex /resources/occ_logo.png
30 License
33Open CASCADE Technology is free software; you can redistribute it and / or
34modify it under the terms of the
35@ref license_lgpl_21 "GNU Lesser General Public License (LGPL) version 2.1",
36with additional @ref occt_lgpl_exception "exception".
38Alternatively, Open CASCADE Technology may be used under the terms of Open
39CASCADE commercial license or contractual agreement.
41Note that Open CASCADE Technology is provided on an "AS IS" basis, WITHOUT
42WARRANTY OF ANY KIND. The entire risk related to any use of the OCCT code and
43materials is on you. See the @ref occt_public_license "license" text for formal
46 Trademark information
49You are hereby informed that all software is a property of its respective authors and is protected by
50international and domestic laws on intellectual property and trademarks.
51Should you need further information, please directly contact the authors.
53**CAS.CADE** and **Open CASCADE** are registered trademarks of
56**Linux** is a registered trademark of Linus Torvalds.
58**Windows** is a registered trademark of Microsoft Corporation in the United States and other countries.
8bcdd697 60**Mac** and the Mac logo are trademarks of Apple Inc., registered in the U.S. and other countries.
ba06f8bb 61
3f812249 62 Acknowledgments
ba06f8bb 64
65The following parties are acknowledged for producing tools which are used within
66Open CASCADE Technology libraries or for release preparation.
68You are hereby informed that all rights to the software listed below belong to its respective
69authors and such software may not be freely available and/or be free of charge for any kind
70of use or purpose. We strongly recommend that you carefully read the license of these products
71and, in case you need any further information, directly contact their authors.
73**Qt** is a cross-platform application framework that is widely used for developing application software
74with graphical user interface (GUI). Qt is free and open source software distributed under
75the terms of the GNU Lesser General Public License. In OCCT Qt is used for programming samples.
251a7984 76If you need further information on Qt, please, refer to Qt Homepage (http://www.qt.io/)
ba06f8bb 77
78**Tcl** is a high-level programming language. Tk is a graphical user interface (GUI) toolkit,
79with buttons, menus, listboxes, scrollbars, and so on. Taken together Tcl and Tk provide a solution
80to develop cross-platform graphical user interfaces with a native look and feel. Tcl/Tk is under copyright by
81Scriptics Corp., Sun Microsystems, and other companies. However, Tcl/Tk is an open source, and
82the copyright allows you to use, modify, and redistribute Tcl/Tk for any purpose, without an
83explicit license agreement and without paying any license fees or royalties.
84To use Tcl/Tk, please refer to the Licensing Terms (http://www.tcl.tk/software/tcltk/license.html).
ba06f8bb 86**GL2PS** is developed by Christophe Geuzaine and others. It is optionally used by OCCT to
87export content of OpenGL scene to vector graphics formats (PS, PDF, EMF, SVG).
88The library is licensed under GL2PS LICENSE http://www.geuz.org/gl2ps/COPYING.GL2PS Version 2, November 2003.
90**FreeType 2** is developed by Antoine Leca, David Turner, Werner Lemberg and others.
91It is a software font engine that is designed to be small, efficient, highly customizable and
92portable while capable of producing high-quality output (glyph images). This product
93can be used in graphic libraries, display servers, font conversion tools,
94text image generation tools, and many other products.
96FreeType 2 is released under two open-source licenses: BSD-like FreeType License and the GPL.
98**Intel(R) Threading Building Blocks (TBB)** offers a rich and complete approach to expressing parallelism in a C++ program.
99It is a library that helps you to take advantage of multi-core processor performance without having to be a threading expert.
100Threading Building Blocks is not just a threads-replacement library. It represents a higher-level, task-based parallelism that
101abstracts platform details and threading mechanisms for scalability and performance.
102TBB is available under GPLv2 license with the runtime exception.
ba06f8bb 104**OpenGL** is an industry standard API for 3D graphics used by OCCT for
105implementation of 3D viewer. OpenGL specification is developed by the
106Khronos group, http://www.khronos.org/opengl/. OCCT code includes header
107file *glext.h* obtained from Khronos web site.
3f812249 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/.
ba06f8bb 110
111**Doxygen** developed by Dimitri van Heesch is open source documentation system for
112C++, C, Java, Objective-C, Python, IDL, PHP and C#. This product is used in Open CASCADE Technology
113for automatic creation of Technical Documentation from C++ header files.
114If you need further information on Doxygen, please refer to http://www.stack.nl/~dimitri/doxygen/index.html.
116**Graphviz** is open source graph visualization software developed by John Ellson, Emden Gansner, Yifan Hu and Arif Bilgin.
117Graph visualization is representiation of structured information as diagrams of abstract graphs and networks.
118This 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
120basis under The Eclipse Public License (EPL) (http://www.graphviz.org/License.php).
122**Inno Setup** is a free script-driven installation system created in CodeGear Delphi by Jordan Russell.
123In OCCT Inno Setup is used to create Installation Wizard on Windows.
124It is licensed under Inno Setup License (http://www.jrsoftware.org/files/is/license.txt).
126**FreeImage** is an Open Source library supporting popular graphics image formats, such as PNG, BMP, JPEG, TIFF,
127and others used by multimedia applications. This library is developed by Hervé Drolon and Floris van den Berg.
128FreeImage is easy to use, fast, multithreading safe, compatible with all 32-bit or 64-bit versions of Windows,
129and cross-platform (works both with Linux and Mac OS X). FreeImage is optionally used by OCCT to work
130with images, on conditions of the FreeImage Public License (FIPL) (http://freeimage.sourceforge.net/freeimage-license.txt).
132**MikTEX** is up-to-date implementation of TeX/LaTeX and related programs for Windows. It is used
133for generation of User and Developer Guides in PDF format. See http://miktex.org for information
134on this tool.
136Adobe Systems, Inc. provides **Adobe Reader**, which can be used to view files in Portable Document Format (PDF).
138@section OCCT_OVW_SECTION_3 Documentation
140OCCT documentation is provided in several forms:
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).
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.
151- Full reference documentation covering all OCCT classes generated automatically by Doxygen
3554ea68 152 software is provided in HTML format.
ba06f8bb 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.
156See @ref occt_dev_guides__documentation "OCCT Documentation Guide" for details on OCCT documentation system.
158**Generation of HTML documentation**
160To generate HTML documentation from sources contained in *dox* subdirectory,
ae3eaf7b 161you need to have Tcl and Doxygen 1.8.5 (or above) installed on your system.
ba06f8bb 162
e2ba9cb1 163Use script **gendoc** (batch file on Windows, shell script on Linux / Mac OSX) to generate documentation.
ba06f8bb 164
e2ba9cb1 165To generate Overview documentation:
ba06f8bb 166
e2ba9cb1 167 cmd> gendoc -overview
ba06f8bb 168
e2ba9cb1 169To generate Reference manual:
ba06f8bb 170
e2ba9cb1 171 cmd> gendoc -refman
ba06f8bb 172
e2ba9cb1 173Run this command without arguments to get help on supported options.
ba06f8bb 174
175@section OCCT_OVW_SECTION_5 Requirements
177Open CASCADE Technology is designed to be highly portable and is known to
9f33b387 178work on wide range of platforms (UNIX, Linux, Windows, Mac OS X, Android).
ba06f8bb 179Current version is officially certified on Windows (IA-32 and x86-64),
9f33b387 180Linux (x86-64), MAC OS X (x86-64) and Android (4.0.4 armv7) platforms.
ba06f8bb 181
182The tables below describe the recommended hardware and software configurations
183for which OCCT is certified to work.
3554ea68 185@subsection overview_req_os Operating System
ba06f8bb 186
3554ea68 187| OS | Versions |
188| --------- | ----------- |
189| Windows | 10, 8.1, 7 SP1, Vista SP2 |
190| Linux | Mandriva 2010, CentOS 6.3, Fedora 18, Ubuntu 14.10 - 15.10, Debian 6.0, Debian 7.0 |
191| OS X | 10.10 Yosemite / 10.9 Mavericks / 10.8 Mountain Lion / 10.7 Lion |
192| Android | 6.x, 5.x, 4.0.4+ |
251a7984 193| iOS | iOS 7 |
ba06f8bb 194
3554ea68 195@subsection overview_req_cpp C++ Compiler / IDE
ba06f8bb 196
3554ea68 197| OS | Compiler |
198| --------- | ----------- |
251a7984 199| 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)|
3554ea68 200| Linux | GNU gcc 4.3+ <br> LLVM CLang 3.6+ |
201| OS X | XCode 6 or newer |
202| Android | NDK r10, GNU gcc 4.8 or newer |
ba06f8bb 203
251a7984 2041) VC++ 10 64-bit is used for regular testing and for building
3554ea68 205 binary package of official release of OCCT on Windows.
207@subsection overview_req_libs Third-party libraries
209| Component | Requirement |
210| --------- | ----------- |
211| Graphic library | OpenGL 3.3+, OpenGL ES 2.0+ <br> Direct3D 9 |
212| 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/ |
251a7984 213| 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)|
214| Freetype (for text rendering) | FreeType 2.4.11-2.5.5 http://sourceforge.net/projects/freetype/files/ |
215| FreeImage (optional, for support of common 2D graphic formats) | FreeImage 3.17.0+ http://sourceforge.net/projects/freeimage/files |
3554ea68 216| gl2ps (optional, for export contents of OCCT viewer to vector formats) | gl2ps-1.3.8+ http://geuz.org/gl2ps/ |
217| Intel TBB (optional, for multithreaded algorithms) | TBB 4.x or 5.x http://www.threadingbuildingblocks.org/ |
218| VTK (for VTK Integration Services | VTK 6.1+ http://www.vtk.org/VTK/resources/software.html |
251a7984 219| Doxygen (optional for building documentation) | Doxygen 1.8.5+ http://www.stack.nl/~dimitri/doxygen/download.html |
9f33b387 220
3554ea68 221@subsection overview_req_hw Hardware
9f33b387 222
3554ea68 223| Component | Requirement |
224| --------- | ----------- |
225| Minimum memory | 512 MB, 1 GB recommended |
226| Free disk space (complete installation) | 600 MB approx. |
ba06f8bb 227
3554ea68 228On desktop, 3D viewer for optimal performance requires graphics processing unit (GPU) supporting OpenGL 3.3 or above.
251a7984 229Ray tracing requires OpenGL 4.0+ or OpenGL 3.3+ with *GL_ARB_texture_buffer_object_rgb32* extension.
230Textures within ray tracing will be available only when *GL_ARB_bindless_texture extension* is provided by driver.
8bcdd697 231
232On mobile platforms, OpenGL ES 2.0+ is required for 3D viewer. The ray tracing is not yet available on mobile platforms.
233Some old hardware might be unable to execute complex GLSL programs (e.g. with high number of light sources, clipping planes).
ba06f8bb 234
235The following table lists graphic cards tested to work with OCCT.
3554ea68 237| Graphic card | Driver | OS | OpenGL (fixed pipeline) | OpenGL (shaders) | OpenGL (ray tracing) |
ba06f8bb 238| ---- | ---- | ---- | :----: | :----: | :----: |
8bcdd697 239| NVIDIA GeForce GTX 650 | Driver 340.52, OpenGL 4.4 | Windows 7 64 bit | OK | OK | OK |
240| AMD/ATI RadeOn HD 7870 | Driver 14.100, OpenGL 4.4 | Windows 7 64-bit | OK | OK | OK |
241| Intel(R) HD Graphics 2500 | Driver, OpenGL 4.0 | Windows 7 64 bit | OK | OK | limited (no textures) |
8bcdd697 242| NVIDIA GeForce 320 | N/A | Mac OS X 10.6 / OS X 10.10 | OK | OK | not yet supported by OCCT |
243| Apple software OpenGL | N/A | Mac OS X 10.6 / OS X 10.10 | OK | OK | N/A |
3554ea68 244| Mesa 10.2.4 (software emulator) | "Gallium 0.4 on llvmpipe (LLVM 3.4, 256 bits)" OpenGL 3.0 | Windows 7 64 bit | OK | OK | unsupported by software |
ba06f8bb 245
246@section OCCT_OVW_SECTION_4 Installation
248In most cases you need to rebuild OCCT on your platform (OS, compiler) before
249using it in your project, to ensure binary compatibility.
250See @ref occt_dev_guides__building for instructions on
251building OCCT from sources on supported platforms.
253@subsection OCCT_OVW_SECTION_4_1 Using Windows installer
255On Windows Open CASCADE Technology can be installed with binaries precompiled by
18006a0f 256Visual C++ 2010 with installation procedure.
ba06f8bb 257
260If you have a previous version of OCCT installed on your station,
261and you do not plan to use it along with the new version, you might want to uninstall
262the previous version (using Control Panel, Add/Remove Programs) before
263the installation of this new version, to avoid possible problems
264(conflict of system variables, paths, etc).
266**Attention:** For full installation OCCT requires approximately 650 Mb of disk space,
267but during the installation process you will need 1,2 Gb of free disk space.
269OCCT installation with reference documentation requires 1,4 Gb on disk.
271 * Download the OCCT installer from OPEN CASCADE web site using the link. you have been provided
272 * Launch the installer and follow the instructions.
274The includes and binaries of third-party libraries necessary for building and launching
16f82a28 275OCCT are included into binary distribution (built with Visual C++ 2010).
ba06f8bb 276When the installation is complete, you will find the directories for 3rd party products
277(some might be absent in case of custom installation) and the main **OCCT** directory:
279@image html /overview/images/overview_3rdparty.png
280@image latex /overview/images/overview_3rdparty.png
251a7984 282The contents of the OCCT-7.0.0 directory (called further "OCCT root", or $CASROOT) are as follows:
ba06f8bb 283
284@image html /overview/images/overview_installation.png "The directory tree"
285@image latex /overview/images/overview_installation.png "The directory tree"
287 * **adm** This folder contains administration files, which allow rebuilding OCCT;
288 * **adm/cmake** This folder contains files of CMake building procedure;
18006a0f 289 * **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;
ba06f8bb 290 * **data** This folder contains CAD files in different formats, which can be used to test the OCCT functionality;
291 * **doc** This folder contains OCCT documentation in HTML and PDF format;
292 * **dox** This folder contains sources of OCCT documentation in plain text (MarkDown) format;
d3013f55 293 * **inc** This folder contains copies of all OCCT header files;
ba06f8bb 294 * **samples** This folder contains sample applications.
295 * **src** This folder contains OCCT source files. They are organized in folders, one per development unit;
296 * **tests** This folder contains scripts for OCCT testing.
16f82a28 297 * **win64/vc10** This folder contains executable and library files built in optimize mode for Windows platform by Visual C++ 2010;
ba06f8bb 298
299@section OCCT_OVW_SECTION_4_2 Environment Variables
301To run any Open CASCADE Technology application you need to set the environment variables.
303### On Windows
305You can define the environment variables with env.bat script located in the
306$CASROOT folder. This script accepts two arguments to be used:
3f812249 307the version of Visual Studio (vc8 -- vc12) and the architecture (win32 or win64).
ba06f8bb 308
309The additional environment settings necessary for compiling OCCT libraries and samples
310by Microsoft Visual Studio can be set using script custom.bat located in the same folder.
311You might need to edit this script to correct the paths to third-party libraries
312if they are installed on your system in a non-default location.
314Script msvc.bat can be used with the same arguments for immediate launch of Visual Studio for (re)compiling OCCT.
316### On Unix
319 If OCCT was built by Code::Blocks, you can define the environment variables with env_cbp.sh or custom_cbp.sh script.
321 If OCCT was built by Automake, you can define the environment variables with env_amk.sh or custom_amk.sh script.
323The scripts are located in the OCCT root folder.
326### Description of system variables:
ba06f8bb 328 * **CASROOT** is used to define the root directory of Open CASCADE Technology;
329 * **PATH** is required to define the path to OCCT binaries and 3rdparty folder;
330 * **LD_LIBRARY_PATH** is required to define the path to OCCT libraries (on UNIX platforms only);
331 * **MMGT_OPT** (optional) if set to 1, the memory manager performs optimizations as described below; if set to 2,
332 Intel (R) TBB optimized memory manager is used; if 0 (default), every memory block is allocated
333 in C memory heap directly (via malloc() and free() functions).
d3013f55 334 In the latter case, all other options starting with *MMGT*, except MMGT_CLEAR, are ignored;
ba06f8bb 335 * **MMGT_CLEAR** (optional) if set to 1 (default), every allocated memory block is cleared by zeros;
336 if set to 0, memory block is returned as it is;
337 * **MMGT_CELLSIZE** (optional) defines the maximal size of blocks allocated in large pools of memory. Default is 200;
338 * **MMGT_NBPAGES** (optional) defines the size of memory chunks allocated for small blocks in pages
339 (operating-system dependent). Default is 10000;
340 * **MMGT_THRESHOLD** (optional) defines the maximal size of blocks that are recycled internally
341 instead of being returned to the heap. Default is 40000;
342 * **MMGT_MMAP** (optional) when set to 1 (default), large memory blocks are allocated using
343 memory mapping functions of the operating system; if set to 0,
344 they will be allocated in the C heap by malloc();
d3013f55 345 * **CSF_LANGUAGE** (optional) defines default language of messages;
ba06f8bb 346 * **CSF_DEBUG** (optional, Windows only): if defined then a diagnostic message is displayed in case of an exception;
347 * **CSF_DEBUG_BOP** (optional): if defined then it should specify directory where diagnostic data on problems occured in Boolean operations will be saved;
348 * **CSF_MDTVTexturesDirectory** defines the directory for available textures when using texture mapping;
d3013f55 349 * **CSF_ShadersDirectory** defines the directory for GLSL programs (required for 3D viewer to work);
350 * **CSF_UnitsDefinition** and **CSF_UnitsLexicon** should define paths to resource files Lexi_Expr.dat and Units.dat, respectively (required for support of measurement units);
351 * **CSF_SHMessage** defines the path to the messages file for *ShapeHealing*;
352 * **CSF_XSMessage** defines the path to the messages file for **STEP** and **IGES** translators;
353 * **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);
354 * **CSF_IGESDefaults** and **CSF_STEPDefaults** (optional) define paths to directory where resource files of **IGES** and **STEP** translators are located;
ba06f8bb 355 * **CSF_XmlOcafResource** is required in order to set the path to **XSD** resources, which defines XML grammar.
356 * **CSF_MIGRATION_TYPES** is required in order to read documents that contain old data types, such as *TDataStd_Shape*;
ba06f8bb 357
358@section OCCT_OVW_SECTION_7 Getting Started
360@subsection OCCT_OVW_SECTION_7_1 Draw Test Harness
362Draw is a command interpreter based on TCL and a graphical system used for testing and demonstrating OCCT modeling libraries.
364Draw can be used interactively to create, display and modify objects such as curves, surfaces and topological shapes.
366@image html /overview/images/overview_draw.png
367@image latex /overview/images/overview_draw.png
369Scripts can be written to customize Draw and perform tests.
370New types of objects and new commands can be added using C++ programming language.
372Draw contains:
374 * A command interpreter based on TCL command language.
375 * A 2D an 3D graphic viewer with support of operations such as zoom, pan, rotation and full-screen views.
376 * An optional set of geometric commands to create and modify curves and surfaces and to use OCCT geometry algorithms.
377 * A set of topological commands to create and modify BRep shapes and to use OCCT topology algorithms.
378 * A set of graphic commands for view and display operations including Mesh Visualization Service.
379 * A set of Application framework commands for handling of files and attributes.
380 * A set of Data Exchange commands for translation of files from various formats (IGES,STEP) into OCCT shapes.
381 * A set of Shape Healing commands: check of overlapping edges, approximation of a shape to BSpline, etc.
383You can add new custom test harness commands to Draw in order to test
384or demonstrate a new functionality, which you are developing.
251a7984 386Currently DRAW Test Harness is a single executable called *DRAWEXE*.
ba06f8bb 387
388Commands grouped in toolkits can be loaded at run-time thereby implementing dynamically loaded plug-ins.
389Thus you can work only with the commands that suit your needs adding
390the commands dynamically without leaving the Test Harness session.
392Declaration of available plug-ins is done through special resource file(s).
251a7984 393The *pload* command loads the plug-in in accordance with
ba06f8bb 394the specified resource file and activates the commands implemented in the plug-in.
396The 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.
398Draw Test Harness provides an environment for OCCT automated testing system.
399Please, consult its @ref occt_dev_guides__tests "Automated Testing System" for details.
403* The DRAWEXE executable is delivered with the installation procedure on Windows platform only.
404* To start it, launch DRAWEXE executable from Open CASCADE Technology/Draw Test Harness item of the Start\\Programs menu.
406@subsection OCCT_OVW_SECTION_7_2 Experimenting with Draw Test Harness
408 Running Draw
411**On Linux:**
4131. If OCCT was built by Code::Blocks use <i>$CASROOT/draw_cbp.sh</i> file to launch *DRAWEXE* executable;
4142. If OCCT was built by Automake use <i>$CASROOT/draw_amk.sh</i> file to launch *DRAWEXE* executable;
416Draw[1]> prompt appears in the command window
418Type *pload ALL*
420**On Windows:**
422Launch Draw executable from Open CASCADE Technology\\Test Harness\\Draw Test Harness
423item of the Start\\Programs menu or Use <i>$CASROOT\\draw.bat</i> file to launch *DRAWEXE* executable.
425Draw[1]> prompt appears in the command window
427Type pload ALL
429**Creating your first geometric objects**
4311. In the command window, type *axo* to create an axonometric view
4322. 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.
4333. Type *fit* to fill the viewer with the cube
4344. 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
436**Manipulating the view**
4381. Type *clear* to erase the view
4392. Type *donly c* to display the cylinder only
4403. Type *donly b* to display the cube only
4414. Type *hlr hlr b* to display the cube in the hidden line removal mode
443**Running demonstration files**
4451. Type *cd ../..* to return to the root directory
4462. Type *cd samples/tcl* to reach the *DrawResources* directory
4473. Type *source \<demo_file\>* to run the demonstration file provided with Open CASCADE. The following demonstration files are available:
448 * DataExchangeDemo.tcl: demonstrates sample sequence of operations with writing and reading IGES file
449 * ModelingDemo.tcl: demonstrates creation of simple shape and displaying it in HLR mode
450 * VisualizationDemo.tcl: demonstrates use of 3d viewer
a347ef35 451 * cad.tcl: creates solid shape looking like abbreviation "CAD"
ba06f8bb 452 * bottle.tcl: creates bottle as in OCCT Tutorial
453 * drill.tcl: creates twist drill bit shape
a347ef35 454 * cutter.tcl: creates milling cutter shape
455 * xde.tcl: demonstrates creation of simple assembly in XDE
456 * materials.tcl: demonstrates visual properties of materials supported by 3d viewer
ba06f8bb 457 * raytrace.tcl: demonstrates use of ray tracing display in 3d viewer
a347ef35 458 * dimensions.tcl: demonstrates use of dimensions, clipping, and capping in 3d viewer
ba06f8bb 459
460**Getting Help**
4621. Type *help* to see all available commands
4632. Type *help \<command_name\>* to find out the arguments for a given command
465@subsection OCCT_OVW_SECTION_7_3 Programming Samples
467@subsubsection OCCT_OVW_SECTION_7_3_1 MFC
469Visual C++ programming samples containing 10 Visual C++ projects
470illustrating how to use a particular module or functionality.
472The list of MFC samples:
474 * Geometry
475 * Modeling
476 * Viewer2d
477 * Viewer3d
478 * ImportExport
479 * Ocaf
480 * Triangulation
481 * HLR
482 * Animation
483 * Convert
485@image html /overview/images/overview_mvc.png
486@image latex /overview/images/overview_mvc.png
490 * MFC samples are available only on Windows platform;
491 * To start a sample use Open CASCADE Technology\\Samples\\Mfc\\ item of the Start\\Programs menu;
492 * Read carefully readme.txt to learn about launching and compilation options.
494See \subpage samples_mfc_standard "Readme" for details.
496@subsubsection OCCT_OVW_SECTION_7_3_2 Qt
498OCCT contains three samples based on Qt application framework
500 Import Export
503 Import Export programming sample contains 3D Viewer and Import / Export functionality.
505@image html /overview/images/overview_qt.png
506@image latex /overview/images/overview_qt.png
508 Tutorial
511The Qt programming tutorial teaches how to use Open CASCADE Technology services to model a 3D object.
512The purpose of the tutorial is not to explain all OCCT classes but
513to help start thinking in terms of the Open CASCADE Technology.
515This tutorial assumes that the user has experience in using and setting up C++.
516From the viewpoint of programming, Open CASCADE Technology is designed
517to enhance user's C++ tools with high performance modeling classes, methods and functions.
518The combination of these resources allows creating substantial applications.
520**See also:** @ref occt__tutorial "OCCT Tutorial"
ba06f8bb 522**Remarks:**
524 * Qt samples are available on all supported platforms;
525 * To start a sample on Windows use Open CASCADE Technology\\Samples\\Qt\\ item of the Start\\Programs menu.
527@subsubsection OCCT_OVW_SECTION_7_3_3 C#
529C# sample demonstrates integration of OCCT 3D Viewer and Import / Export functionality into .NET applications (using Windows Forms and WPF front ends).
531@image html /overview/images/overview_c__ie.png
532@image latex /overview/images/overview_c__ie.png
536 * BRep
537 * Iges
538 * Step
542 * Brep
543 * Iges
544 * Step
545 * Stl
546 * Vrml
15534713 548See \subpage samples_csharp_occt "Readme" for details.
18006a0f 550There is also another C# example with the same functionality, which demonstrates the integration of Direct3D Viewer into .NET applications using WPF front end.
15534713 551
552See \subpage samples_csharp_direct3d "Readme" for details.
ba06f8bb 553
80eb9670 554@subsubsection OCCT_OVW_SECTION_7_3_4 Android
556There 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)
559@image html /overview/images/samples_java_android_occt.jpg
560@image latex /overview/images/samples_java_android_occt.jpg
3f812249 561Java -- See \subpage samples_java_android_occt "Readme" for details.
80eb9670 562
564@image html /overview/images/samples_qml_android_occt.jpg
565@image latex /overview/images/samples_qml_android_occt.jpg
3f812249 566Qt -- See \subpage samples_qml_android_occt "Readme" for details.