Links to OCC web sites in documentation are updated in accordance with the new site design.
@section OCCT_DOC_SECTION_5 Additional Resources
-More information about OCCT can be found at http://www.opencascade.org
+More information about OCCT can be found at http://www.opencascade.com and http://dev.opencascade.org sites.
+
The information on formula syntax can be found at:
http://en.wikipedia.org/wiki/Help:Displaying_a_formula
@tableofcontents
+@htmlonly<center>@endhtmlonly
+@image html /resources/occt_logo.png
+@image latex /resources/occt_logo.png
+@htmlonly</center>@endhtmlonly
+
@section OCCT_OVW_SECTION_1 Welcome
Welcome to Open CASCADE Technology (OCCT), a software development platform
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
-@image html /resources/occt_logo.png
-@image latex /resources/occt_logo.png
-@htmlonly</center>@endhtmlonly
-
@section OCCT_OVW_SECTION_2 Copyrights
Open CASCADE Technology and all materials, including this documentation, is
To generate HTML documentation from sources contained in *dox* subdirectory,
you need to have Tcl and Doxygen 1.8.5 (or above) installed on your system.
-In Tcl prompt, cd to OCCT root folder and run
-
- tclsh> source dox/start.tcl
-
-On Windows you can also run batch script **gendoc.bat**.
-
-
-**Generation of reference documentation**
-
-Reference documentation can be generated with help of WOK tool that
-is available for download from www.opencascade.org and dev.opencascade.org sites.
-
-Prerequisites:
-
- * Doxygen version 1.8.5 or higher
- * Graphviz version 2.28.0 or higher
-
-Run WOK (cd \<WOK_INSTALL_DIR\>/site folder):
-
-* Using WOK TCL shell:
- > wok_tclsh.sh
-
-* Using Emacs editor:
- > wok_emacs.sh
-
-In the WOK prompt, step into your workbench:
+Use script **gendoc** (batch file on Windows, shell script on Linux / Mac OSX) to generate documentation.
- > wokcd <your workbench>
+To generate Overview documentation:
-In your workbench, use **wgendoc** command with –h argument to get information about arguments of **wgendoc** command:
+ cmd> gendoc -overview
- > wgendoc -h
+To generate Reference manual:
-then run **wgendoc** command with required arguments, for instance:
+ cmd> gendoc -refman
- > wgendoc -output=d:/occt/doc {-m=Draw Visualization}
+Run this command without arguments to get help on supported options.
@section OCCT_OVW_SECTION_5 Requirements
Please, see the details in @ref occt_user_guides__foundation_classes "Foundation Classes User's Guide"
-See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
+See also: our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
@section OCCT_TOVW_SECTION_3 Modeling Data
3D geometric models can be stored in OCCT native BREP format.
See @ref occt_user_guides__brep_wp "BREP Format Description White Paper" for details on the format.
-See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
+See also: our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
@section OCCT_TOVW_SECTION_4 Modeling Algorithms
* Algorithms for creation of mechanical features, i.e. depressions, protrusions, ribs and grooves or slots along planar or revolution surfaces.
@figure{/technical_overview/images/0004.png}
-
-
Please, see the details in @ref occt_user_guides__modeling_algos "Modeling Algorithms User's Guide".
-See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
+See also: our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
@section OCCT_TOVW_SECTION_4a Mesh
- STL converter translates Open CASCADE shapes to STL files. STL (STtereoLithography) format is widely used for rapid prototyping (3D printing).
Open CASCADE SAS also offers Advanced Mesh Products:
-- <a href="http://www.opencascade.org/support/products/omf">Open CASCADE Mesh Framework (OMF)</a>
-- <a href="http://www.opencascade.org/support/products/emesh">Express Mesh</a>
+- <a href="http://www.opencascade.com/content/mesh-framework">Open CASCADE Mesh Framework (OMF)</a>
+- <a href="http://www.opencascade.com/content/express-mesh">Express Mesh</a>
@figure{/technical_overview/images/0003.png}
See @ref occt_user_guides__voxels_wp "Voxels User's Guide" for more information.
-See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
+See also: our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
@section OCCT_TOVW_SECTION_6 Data Exchange
* @ref occt_user_guides__iges "IGES" (up to 5.3)
* VRML and STL meshes.
* @ref occt_user_guides__xde "Extended data exchange" (XDE) allows translating additional attributes attached to geometric data (colors, layers, names, materials etc).
-* <a href="http://www.opencascade.org/support/products/dataex/">Advanced Data Exchange Components</a> are available in addition to standard Data Exchange interfaces to support interoperability and data adaptation (also using @ref OCCT_TOVW_SECTION_6a "Shape Healing") with CAD software using the following proprietary formats:
- * <a href="http://www.opencascade.org/support/products/dataex/acis/">ACIS SAT</a>
- * <a href="http://www.opencascade.org/support/products/dataex/parasolid/">Parasolid</a>
- * <a href="http://www.opencascade.org/support/products/dataex/dxf/">DXF</a>
+* <a href="http://www.opencascade.com/content/advanced-data-exchange-components">Advanced Data Exchange Components</a> are available in addition to standard Data Exchange interfaces to support interoperability and data adaptation (also using @ref OCCT_TOVW_SECTION_6a "Shape Healing") with CAD software using the following proprietary formats:
+ * <a href="http://www.opencascade.com/content/acis-sat-import-export">ACIS SAT</a>
+ * <a href="http://www.opencascade.com/content/parasolid-import">Parasolid</a>
+ * <a href="http://www.opencascade.com/content/dxf-import-export">DXF</a>
These components are based on the same architecture as interfaces with STEP and IGES.
For more details refer to @ref occt_user_guides__shape_healing "Shape Healing User's guide".
-See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
+See also: our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
@section OCCT_TOVW_SECTION_7 Application Framework
* @ref occt_user_guides__ocaf_tree_wp "Distribution of Data through OCAF Tree"
* @ref occt_user_guides__ocaf_functionmechanism_wp "Application Framework Function Mechanism"
-See also: <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
+See also: our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
@section OCCT_TOVW_SECTION_8 Draw Test Harness
@image latex /tutorial/images/tutorial_image019.png
We hope that this tutorial has provided you with a feel for the industrial strength power of Open CASCADE Technology.
-If you want to know more and develop major projects using Open CASCADE Technology, we invite you to study our training, support, and consulting services on our site at http://www.opencascade.org/support. Our professional services can maximize the power of your Open CASCADE Technology applications.
+If you want to know more and develop major projects using Open CASCADE Technology, we invite you to study our training, support, and consulting services on our site at http://www.opencascade.com/content/technology-support. Our professional services can maximize the power of your Open CASCADE Technology applications.
@section sec6 Appendix
@section occt_fcug_1 Introduction
-This manual explains how to use Open CASCADE Technology (**OCCT**) Foundation Classes. It provides basic documentation on foundation classes. For advanced information on foundation classes and their applications, see the offerings on our web site at <a href="http://www.opencascade.org/support/training/">www.opencascade.org/support/training/</a>.
+This manual explains how to use Open CASCADE Technology (**OCCT**) Foundation Classes. It provides basic documentation on foundation classes. For advanced information on foundation classes and their applications, see our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
Foundation Classes provide a variety of general-purpose services such as automated dynamic memory management (manipulation of objects by handle), collections, exception handling, genericity by down-casting and plug-in creation.
* an IGES entity is an entity in the IGES normal sense.
* a root entity is the highest level entity of any given type, e.g. type 144 for surfaces and type 186 for solids. Roots are not referenced by other entities.
-This manual mainly explains how to convert an IGES file to an Open CASCADE Technology (**OCCT**) shape and vice versa. It provides basic documentation on conversion. For advanced information on conversion, see our offerings on our web site at <a href="http://www.opencascade.org/support/training/">www.opencascade.org/support/training/</a>
+This manual mainly explains how to convert an IGES file to an Open CASCADE Technology (**OCCT**) shape and vice versa. It provides basic documentation on conversion. For advanced information on conversion, see our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
IGES files produced in accordance with IGES standard versions up to and including version 5.3 can be read. IGES files that are produced by this interface conform to IGES version 5.3 (Initial Graphics Exchange Specification, IGES 5.3. ANS US PRO/IPO-100-1996).
@section occt_modalg_1 Introduction
-This manual explains how to use the Modeling Algorithms. It provides basic documentation on modeling algorithms. For advanced information on Modeling Algorithms, see our offerings on our web site at <a href="http://www.opencascade.org/support/training/">www.opencascade.org/support/training/</a>
+This manual explains how to use the Modeling Algorithms. It provides basic documentation on modeling algorithms. For advanced information on Modeling Algorithms, see our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
The Modeling Algorithms module brings together a wide range of topological algorithms used in modeling. Along with these tools, you will find the geometric algorithms, which they call.
* construction of plate surfaces
* extension of a 3D curve or surface beyond its original bounds.
-OPEN CASCADE company also provides a product known as <a href="http://www.opencascade.org/support/products/ssp/">Surfaces from Scattered Points</a>, which allows constructing surfaces from scattered points. This algorithm accepts or constructs an initial B-Spline surface and looks for its deformation (finite elements method) which would satisfy the constraints. Using optimized computation methods, this algorithm is able to construct a surface from more than 500 000 points.
+OPEN CASCADE company also provides a product known as <a href="http://www.opencascade.com/content/surfaces-scattered-points">Surfaces from Scattered Points</a>, which allows constructing surfaces from scattered points. This algorithm accepts or constructs an initial B-Spline surface and looks for its deformation (finite elements method) which would satisfy the constraints. Using optimized computation methods, this algorithm is able to construct a surface from more than 500 000 points.
SSP product is not supplied with Open CASCADE Technology, but can be purchased separately.
- STL converter translates Open CASCADE shapes to STL files. STL (STtereoLithography) format is widely used for rapid prototyping.
Open CASCADE SAS also offers Advanced Mesh Products:
-- <a href="http://www.opencascade.org/support/products/omf">Open CASCADE Mesh Framework (OMF)</a>
-- <a href="http://www.opencascade.org/support/products/emesh">Express Mesh</a>
+- <a href="http://www.opencascade.com/content/mesh-framework">Open CASCADE Mesh Framework (OMF)</a>
+- <a href="http://www.opencascade.com/content/express-mesh">Express Mesh</a>
Besides, we can efficiently help you in the fields of surface and volume meshing algorithms, mesh optimization algorithms etc. If you require a qualified advice about meshing algorithms, do not hesitate to benefit from the expertise of our team in that domain.
Modeling Data supplies data structures to represent 2D and 3D geometric models.
-This manual explains how to use Modeling Data. For advanced information on modeling data, see our offerings on our web site at <a href="http://www.opencascade.org/support/training/">www.opencascade.org/support/training/</a>.
+This manual explains how to use Modeling Data. For advanced information on modeling data, see our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
@section occt_modat_1 Geometry Utilities
This manual explains how to use the Open CASCADE Application Framework (OCAF).
It provides basic documentation on using OCAF. For advanced information on OCAF
-and its applications, see our offerings on our web site at
-<a href="http://www.opencascade.org/support/training/">www.opencascade.org/support/training/</a>
+and its applications, see our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
OCAF (the Open CASCADE Application Framework) is a RAD (Rapid Application Development) framework used for
specifying and organizing application data. To do this, OCAF provides:
@subsection occt_shg_1_1 Introduction
-This manual explains how to use Shape Healing. It provides basic documentation on its operation. For advanced information on Shape Healing and its applications, see our offerings on our web site at <a href="http://www.opencascade.org/support/training/">www.opencascade.org/support/training/</a>
+This manual explains how to use Shape Healing. It provides basic documentation on its operation. For advanced information on Shape Healing and its applications, see our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
The **Shape Healing** toolkit provides a set of tools to work on the geometry and topology of Open CASCADE Technology (**OCCT**) shapes. Shape Healing adapts shapes so as to make them as appropriate for use by Open CASCADE Technology as possible.
For testing the STEP component in DRAW Test Harness, a set of commands for reading and writing STEP files and analysis of relevant data are provided by the *TKXSDRAW* plugin.
-See also: our web site at <a href="http://www.opencascade.org/support/training/">E-learning and Training</a>.
+See also our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
@subsection occt_step_1_1 STEP Exchanges in Open Cascade technology
* If the 3D services proposed in AIS meet your requirements, you need only read chapter 3 <a href="#occt_visu_3">AIS: Application Interactive Services</a>.
* If you need more detail, for example, a selection filter on another type of entity - you should read chapter 2 <a href="#occt_visu_2">Fundamental Concepts</a>, chapter 3 <a href="#occt_visu_3">AIS: Application Interactive Services</a>, and 4 <a href="#occt_visu_4">3D Presentations</a>. You may want to begin with the chapter presenting AIS.
+
+For advanced information on visualization algorithms, see our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
@section occt_visu_2 Fundamental Concepts
@section occt_xde_1 Introduction
-This manual explains how to use the Extended Data Exchange (XDE). It provides basic documentation on setting up and using XDE. For advanced information on XDE and its applications, see our offerings at <a href="http://www.opencascade.com/services/support/">on our web site</a>.
+This manual explains how to use the Extended Data Exchange (XDE). It provides basic documentation on setting up and using XDE. For advanced information on XDE and its applications, see our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
The Extended Data Exchange (XDE) module allows extending the scope of exchange by translating additional data attached to geometric BREP data, thereby improving the interoperability with external software.
projects / occt-copy.git / commitdiff