Skip to content

Commit 4340981

Browse files
a-betenevbugmaster
authored andcommitted
Update of title page of documentation (overview)
- Copyright year is updated - Links to 3rd-party libraries and their licenses are actualized - Description and snapshot of iOS sample added - Visual Studio 2017 is mentioned among supported compilers
1 parent 7d7a3e8 commit 4340981

4 files changed

Lines changed: 39 additions & 28 deletions

File tree

dox/FILES_HTML.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ overview/overview.md
1313

1414
../samples/qt/AndroidQt/ReadMe.md
1515
../samples/java/jniviewer/ReadMe.md
16+
../samples/ios/UIKitSample/ReadMe.md
1617

1718
tutorial/tutorial.md
1819

47.6 KB
Loading

dox/overview/overview.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ modeling (CAD), manufacturing / measuring (CAM) or numerical simulation (CAE).
1818
@section OCCT_OVW_SECTION_2 Copyrights
1919

2020
Open CASCADE Technology and all materials, including this documentation, is
21-
Copyright (c) 1999-2016 by OPEN CASCADE S.A.S. All rights reserved.
21+
Copyright (c) 1999-2017 by OPEN CASCADE S.A.S. All rights reserved.
2222

2323
@htmlonly<center>@endhtmlonly
2424
https://www.opencascade.com
@@ -83,28 +83,28 @@ To use Tcl/Tk, please refer to the Licensing Terms (https://www.tcl.tk/software/
8383

8484
**GL2PS** is developed by Christophe Geuzaine and others. It is optionally used by OCCT to
8585
export content of OpenGL scene to vector graphics formats (PS, PDF, EMF, SVG).
86-
The library is licensed under GL2PS LICENSE https://www.geuz.org/gl2ps/COPYING.GL2PS Version 2, November 2003.
86+
The library is licensed under GL2PS license (http://www.geuz.org/gl2ps/COPYING.GL2PS).
8787

8888
**FreeType 2** is developed by Antoine Leca, David Turner, Werner Lemberg and others.
8989
It is a software font engine that is designed to be small, efficient, highly customizable and
9090
portable while capable of producing high-quality output (glyph images). This product
9191
can be used in graphic libraries, display servers, font conversion tools,
9292
text image generation tools, and many other products.
93-
94-
FreeType 2 is released under two open-source licenses: BSD-like FreeType License and the GPL.
93+
FreeType 2 is released under two open-source licenses: BSD-like FreeType License and the GPL (https://www.freetype.org/license.html).
9594

9695
**Intel(R) Threading Building Blocks (TBB)** offers a rich and complete approach to expressing parallelism in a C++ program.
9796
It is a library that helps you to take advantage of multi-core processor performance without having to be a threading expert.
9897
Threading Building Blocks is not just a threads-replacement library. It represents a higher-level, task-based parallelism that
9998
abstracts platform details and threading mechanisms for scalability and performance.
100-
TBB is available under GPLv2 license with the runtime exception.
99+
TBB version 2017 is available under Apache 2.0 license, while older versions
100+
until 4.4 are available under GPLv2 license with the runtime exception (https://www.threadingbuildingblocks.org).
101101

102102
**OpenGL** is an industry standard API for 3D graphics used by OCCT for
103103
implementation of 3D viewer. OpenGL specification is developed by the
104104
Khronos group, https://www.khronos.org/opengl/. OCCT code includes header
105105
file *glext.h* obtained from Khronos web site.
106106

107-
**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 https://www.vtk.org/.
107+
**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/.
108108

109109
**Doxygen** developed by Dimitri van Heesch is open source documentation system for
110110
C++, C, Java, Objective-C, Python, IDL, PHP and C#. This product is used in Open CASCADE Technology
@@ -115,17 +115,17 @@ If you need further information on Doxygen, please refer to https://www.stack.nl
115115
Graph visualization is representiation of structured information as diagrams of abstract graphs and networks.
116116
This product is used together with Doxygen in Open CASCADE Technology for automatic creation of Technical Documentation
117117
(generation of dependency graphs). Current versions of Graphviz are licensed on an open source
118-
basis under The Eclipse Public License (EPL) (https://www.graphviz.org/License.php).
118+
basis under The Eclipse Public License (EPL) (http://www.graphviz.org/License.php).
119119

120120
**Inno Setup** is a free script-driven installation system created in CodeGear Delphi by Jordan Russell.
121121
In OCCT Inno Setup is used to create Installation Wizard on Windows.
122-
It is licensed under Inno Setup License (https://www.jrsoftware.org/files/is/license.txt).
122+
It is licensed under Inno Setup License (http://www.jrsoftware.org/files/is/license.txt).
123123

124124
**FreeImage** is an Open Source library supporting popular graphics image formats, such as PNG, BMP, JPEG, TIFF,
125125
and others used by multimedia applications. This library is developed by Hervé Drolon and Floris van den Berg.
126126
FreeImage is easy to use, fast, multithreading safe, compatible with all 32-bit or 64-bit versions of Windows,
127127
and cross-platform (works both with Linux and Mac OS X). FreeImage is optionally used by OCCT to work
128-
with images, on conditions of the FreeImage Public License (FIPL) (https://freeimage.sourceforge.net/freeimage-license.txt).
128+
with images, on conditions of the FreeImage Public License (FIPL) (http://freeimage.sourceforge.net/freeimage-license.txt).
129129

130130
**CMake** is an open-source, cross-platform family of tools designed to build, test and package software. CMake is used to control the software compilation process using simple platform and compiler independent configuration files, and generate native makefiles and workspaces that can be used in the compiler environment of your choice.
131131
OCCT uses CMake as a build system. CMake is available under BSD 3-Clause license. See more at https://cmake.org/
@@ -196,7 +196,7 @@ for which OCCT is certified to work.
196196

197197
| OS | Compiler |
198198
| --------- | ----------- |
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)|
199+
| Windows | Microsoft Visual Studio: 2010 SP1<sup>1</sup>, 2012 Update 4, 2013 Update 5, 2015, 2017 <br> Intel C++ Composer XE 2013 SP1 <br> GCC 4.3+ (Mingw-w64)|
200200
| Linux | GNU gcc 4.3+ <br> LLVM CLang 3.6+ |
201201
| OS X | XCode 6 or newer |
202202
| Android | NDK r10, GNU gcc 4.8 or newer |
@@ -209,15 +209,15 @@ for which OCCT is certified to work.
209209
| Component | Requirement |
210210
| --------- | ----------- |
211211
| 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/ |
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 |
216-
| FFmpeg (optional, for video recording) | FFmpeg 3.1+ https://www.ffmpeg.org |
212+
| Qt (for samples and demos) | Desktop: Qt 4.8.6+ https://www.qt.io/download/ <br> Android: Qt 5.3.2+ https://www.qt.io/download/ |
213+
| TCL (for testing tools) | Tcl/Tk 8.6.3+ https://www.tcl.tk/software/tcltk/download.html <br> or ActiveTcl 8.6 https://www.activestate.com/activetcl/downloads (for Windows)|
214+
| Freetype (for text rendering) | FreeType 2.4.11-2.5.5 https://sourceforge.net/projects/freetype/files/ |
215+
| FreeImage (optional, for support of common 2D graphic formats) | FreeImage 3.17.0+ https://sourceforge.net/projects/freeimage/files |
216+
| FFmpeg (optional, for video recording) | FFmpeg 3.1+ https://www.ffmpeg.org/download.html |
217217
| gl2ps (optional, for export contents of OCCT viewer to vector formats) | gl2ps-1.3.8+ http://geuz.org/gl2ps/ |
218-
| Intel TBB (optional, for multithreaded algorithms) | TBB 4.x or 5.x http://www.threadingbuildingblocks.org/ |
219-
| VTK (for VTK Integration Services | VTK 6.1+ http://www.vtk.org/VTK/resources/software.html |
220-
| Doxygen (optional for building documentation) | Doxygen 1.8.5+ http://www.stack.nl/~dimitri/doxygen/download.html |
218+
| Intel TBB (optional, for multithreaded algorithms) | TBB 4.x or 5.x https://www.threadingbuildingblocks.org/ |
219+
| VTK (for VTK Integration Services | VTK 6.1+ http://www.vtk.org/download/ |
220+
| Doxygen (optional for building documentation) | Doxygen 1.8.5+ https://www.stack.nl/~dimitri/doxygen/download.html |
221221

222222
@subsection overview_req_hw Hardware
223223

@@ -534,20 +534,28 @@ Export:
534534
* Stl
535535
* Vrml
536536

537-
See \subpage samples_csharp_occt "Readme" for details.
537+
See \subpage samples_csharp_occt "C# sample Readme" for details.
538538

539539
There is also another C# example with the same functionality, which demonstrates the integration of Direct3D Viewer into .NET applications using WPF front end.
540540

541-
See \subpage samples_csharp_direct3d "Readme" for details.
541+
See \subpage samples_csharp_direct3d "Direct3D C# sample Readme" for details.
542542

543543
@subsubsection OCCT_OVW_SECTION_7_3_4 Android
544544

545545
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)
546546

547547
jniviewer
548548
@figure{/overview/images/samples_java_android_occt.jpg}
549-
Java -- See \subpage samples_java_android_occt "Readme" for details.
549+
Java -- See \subpage samples_java_android_occt "Android Java sample Readme" for details.
550550

551551
AndroidQt
552552
@figure{/overview/images/samples_qml_android_occt.jpg}
553-
Qt -- See \subpage samples_qml_android_occt "Readme" for details.
553+
Qt -- See \subpage samples_qml_android_occt "Android Qt sample Readme" for details.
554+
555+
@subsubsection OCCT_OVW_SECTION_7_3_5 iOS
556+
557+
There is a sample demonstrating usage of OCCT on iOS with Apple UIKit framework.
558+
559+
@figure{/overview/images/sample_ios_uikit.png}
560+
561+
See \subpage occt_samples_ios_uikit "iOS sample Readme" for details.

samples/ios/UIKitSample/ReadMe.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
// This file contains a description of the UIKitSample and step-by-step instructions how to build and run it.
1+
OCCT sample for iOS {#occt_samples_ios_uikit}
2+
==================
3+
4+
UIKitSample consists of the Open CASCADE 3D Viewer which provides import of STEP files and toolbar with three buttons.
5+
6+
The first and second buttons serve for import hardcoded STEP files. The third button displays "About" dialog.
7+
8+
The viewer supports zoom, pan and rotate actions. The viewer supports selection of solids as well.
29

310
Installation and configuration:
411
1. Make sure you are running Mac OS version 10.12.1 or above and properly installed XCode version 8.1 or above.
@@ -9,8 +16,3 @@ Installation and configuration:
916
6. Select the UIKitSample and go to the "Build Settings" tab. After go to the section "Search Paths" and in the field "Header Search Paths" specify a path to the OCCT inc folder. Next in the field "Library Search Paths" specify a path/paths to the OCCT static libraries and Freetype2 static library folders.
1017
7. Connect device and build sample for device or choose simulator as a target and build for simulator.
1118
8. Run sample.
12-
13-
Description:
14-
UIKitSample consists of the Open CASCADE 3D Viewer which provides import of STEP files and toolbar with three buttons.
15-
The first and second buttons serve for import hardcoded STEP files. The third button displays "About" dialog.
16-
The viewer supports zoom, pan and rotate actions. The viewer supports selection of solids as well.

0 commit comments

Comments
 (0)