Welcome to Open CASCADE Technology (OCCT), a software development platform
diff --git a/ais_object.md b/ais_object.md
index 007fa53..f59b53d 100644
--- a/ais_object.md
+++ b/ais_object.md
@@ -1,4 +1,6 @@
-# AIS: Custom Presentation Introduction
The purpose of this document is to define a common programming style for Open CASCADE Technology. @@ -1147,3 +1149,5 @@ void main() Position); } ~~~~ + + diff --git a/contribution.md b/contribution.md index 197f300..fe71d9a 100644 --- a/contribution.md +++ b/contribution.md @@ -1,4 +1,6 @@ -# Contribution +# Contribution + +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). This chapter contains the detailed information about contribution procedure: @@ -7,3 +9,5 @@ This chapter contains the detailed information about contribution procedure: * [Coding Rules](coding_rules) * [Tests](tests) * [Documentation](documentation) + + diff --git a/contribution_workflow.md b/contribution_workflow.md index 202869b..680882c 100644 --- a/contribution_workflow.md +++ b/contribution_workflow.md @@ -1,5 +1,7 @@ # Contribution Workflow +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Introduction
The purpose of this document is to describe standard workflow for processing contributions to certified version of OCCT. @@ -464,3 +466,5 @@ The category corresponds to the component of OCCT where the issue is found: | Documentation updated | The documentation has been updated to resolve a misunderstanding causing the issue. | | Won’t fix | It is decided to keep the existing behavior. | + + diff --git a/de_wrapper.md b/de_wrapper.md index 84ec330..2dbc066 100644 --- a/de_wrapper.md +++ b/de_wrapper.md @@ -1,5 +1,7 @@ # Data Exchange Wrapper (DE_Wrapper) +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Introduction
This guide explains how to use the **Data Exchange Wrapper** (DE Wrapper). @@ -435,3 +437,5 @@ provider.STEP.OCC.read.precision.val : 0.0001 " readfile S5 $filename -conf ${conf} ~~~~ + + diff --git a/debug.md b/debug.md index 12205d7..31a1f47 100644 --- a/debug.md +++ b/debug.md @@ -1,5 +1,7 @@ # Debugging tools and hints +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Introduction
This manual describes facilities included in OCCT to support debugging, and provides some hints for more efficient debug. @@ -413,3 +415,5 @@ Known problems (as of CLang 6.0) are:Windows
Though CLang toolset is available in Visual Studio 2015 and newer, sanitizer do not seem to be available out of the box (last tested with VS 2019 16.2.3). + + diff --git a/documentation.md b/documentation.md index f2bc72e..4a1ed14 100644 --- a/documentation.md +++ b/documentation.md @@ -1,5 +1,7 @@ # Documentation System +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Introduction
OCCT documentation is provided in several forms: @@ -509,3 +511,5 @@ that leads to the following result: $$ \sqrt{3x-1}+(1+x)^2 $$ + + diff --git a/draw_scripts.md b/draw_scripts.md index b555bfb..ae11b65 100644 --- a/draw_scripts.md +++ b/draw_scripts.md @@ -1,4 +1,6 @@ -# Draw: Demo Scripts +# Draw: Demo Scripts + +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). All demo scripts are provided with OCCT sources and locate in CASROOT/samples/tcl. To play around them please follow the steps below: @@ -121,4 +123,5 @@ Type pload ALL **Getting Help** 1. Type *help* to see all available commands -2. Type *help \Introduction
@@ -11916,3 +11918,5 @@ The procedure consists in defining the system variables and using the *pload* co Draw[]> set env(CSF_MyDrawPluginDefaults) /users/test Draw[]> pload -MyDrawPlugin ALL ~~~~ + + diff --git a/foundation_classes.md b/foundation_classes.md index be96db8..608e96f 100644 --- a/foundation_classes.md +++ b/foundation_classes.md @@ -1,5 +1,7 @@ # Foundation Classes +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Introduction
This manual explains how to use Open CASCADE Technology (**OCCT**) Foundation Classes. @@ -1913,3 +1915,5 @@ The approximation is greater than the other precisions because it is designed to It has been provided as a reasonable compromise by the designers of the Approximation algorithm. The current value is *Confusion() * 10*. Note that Approximation is greater than Confusion, so care must be taken when using Confusion in an approximation process. + + diff --git a/git_guide.md b/git_guide.md index 24128a7..49232b6 100644 --- a/git_guide.md +++ b/git_guide.md @@ -1,5 +1,7 @@ # Guide to installing and using Git for OCCT development +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Overview
Purpose
@@ -514,3 +516,5 @@ To rebase your branch into a single commit, you need to do the following:
+
+
diff --git a/iges.md b/iges.md
index 8d53c12..8eb5038 100644
--- a/iges.md
+++ b/iges.md
@@ -1,5 +1,7 @@
# IGES Translator
+> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml).
+
Introduction
The IGES interface reads IGES files and translates them to Open CASCADE Technology models. The interface is able to translate one entity, a group of entities or a whole file. Before beginning a translation, you can set a range of parameters to manage the translation process. If you like, you can also check file consistency before translation. The IGES interface also translates OCCT models to IGES files. @@ -1319,3 +1321,5 @@ where S is OStream. + + diff --git a/inspector.md b/inspector.md index c24e98f..89bdd7e 100644 --- a/inspector.md +++ b/inspector.md @@ -1,5 +1,7 @@ # Inspector +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Introduction
This manual explains how to use the Inspector. @@ -635,3 +637,5 @@ In MSVC studio, a separate folder contains Inspector projects. * DFBrowser, * ShapeView, * VInspector. + + diff --git a/license.md b/license.md index b46d0eb..afd278a 100644 --- a/license.md +++ b/license.md @@ -1,5 +1,7 @@ # License +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). + Open CASCADE Technology is available under GNU Lesser General Public License (LGPL) version 2.1 with additional exception. @@ -518,3 +520,5 @@ provided with the Open CASCADE Technology libraries (including code of CDL generic classes) under terms of your choice, provided that you give prominent notice in supporting documentation to this code that it makes use of or is based on facilities provided by the Open CASCADE Technology software. + + diff --git a/mesh.md b/mesh.md index fa7da94..fe597df 100644 --- a/mesh.md +++ b/mesh.md @@ -1,5 +1,7 @@ # Mesh +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Mesh presentations
In addition to support of exact geometrical representation of 3D objects Open CASCADE Technology provides functionality to work with tessellated representations of objects in form of meshes. @@ -233,3 +235,5 @@ Range splitter tools provide functionality to generate internal surface nodes dePostprocess discrete model
This stage implements actions to be performed after meshing of faces. Depending on target goals it can be changed or omitted. By default, *BRepMesh_ModelPostProcessor* commits polygonal data stored in the data model to *TopoDS_Edge*. + + diff --git a/modeling_algos.md b/modeling_algos.md index 296dfc4..ba6d667 100644 --- a/modeling_algos.md +++ b/modeling_algos.md @@ -1,5 +1,7 @@ # Modeling Algorithms +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Introduction
This manual explains how to use the Modeling Algorithms. It provides basic documentation on modeling algorithms. @@ -3607,3 +3609,5 @@ For more details on the connexity commands please refer the [MakeConnected comma To track the history of a shape modification during MakeConnected operation the [standard history commands](draw_test_harness#occt_draw_hist) can be used. To have possibility to access the error/warning shapes of the operation use the *bdrawwarnshapes* command before running the algorithm (see command usage in the [Errors and warnings reporting system](boolean_operations#specification__boolean_ers) of Boolean operations user guide). + + diff --git a/modeling_data.md b/modeling_data.md index b16151a..8941247 100644 --- a/modeling_data.md +++ b/modeling_data.md @@ -1,5 +1,7 @@ # Modeling Data +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Introduction
Modeling Data supplies data structures to represent 2D and 3D geometric models. @@ -1532,3 +1534,5 @@ The package *BRepBndLib* contains methods *BRepBndLib::Add(...), BRepBndLib::Add Nevertheless, (in general) the result returned by both algorithms is not always optimal (i.e. sometimes another OBB exists with a smaller surface area). Moreover, the first method does not allow computing OBBs of shapes with a complex geometry. 2. Currently, the algorithm of OBB creation is implemented for objects in 3D space only. + + diff --git a/novice_guide.md b/novice_guide.md index 43173c5..9bd315a 100644 --- a/novice_guide.md +++ b/novice_guide.md @@ -1,5 +1,7 @@ # Novice Guide +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Modeling with OCCT: Key differences
Open CASCADE Technology (OCCT) is an object-oriented C++ framework designed for rapid production of sophisticated CAD/CAM/CAE applications. @@ -110,3 +112,5 @@ This may seem overwhelming at first, but if you have the clear understanding of Aside from the Overview documentation itself, the [Reference manual](https://dev.opencascade.org/doc/refman/html/index.html) is present. Use it to check classes descriptions, dependencies and examples. Additionally, there is a [Forum](https://dev.opencascade.org/forums) where you can contact the OCCT community and developers. + + diff --git a/ocaf.md b/ocaf.md index edb4663..e867bfe 100644 --- a/ocaf.md +++ b/ocaf.md @@ -1,5 +1,7 @@ # OCAF +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +Introduction
This manual explains how to use the Open CASCADE Application Framework (OCAF). @@ -2802,3 +2804,5 @@ In C++, the application behavior is implemented in virtual functions redefined i * **Topological naming** -- systematic referencing of topological entities so that these entities can still be identified after the models they belong to have gone through several steps in modeling. In other words, topological naming allows you to track entities through the steps in the modeling process. This referencing is needed when a model is edited and regenerated, and can be seen as a mapping of labels and name attributes of the entities in the old version of a model to those of the corresponding entities in its new version. Note that if the topology of a model changes during the modeling, this mapping may not fully coincide. A Boolean operation, for example, may split edges. * **Topological tracking** -- following a topological entity in a model through the steps taken to edit and regenerate that model. * **Valid label** -- in a data framework, this is a label, which is already recomputed in the scope of regeneration sequence and includes the label containing a feature which is to be recalculated. Consider the case of a box to which you first add a fillet, then a protrusion feature. For recalculation purposes, only valid labels of each construction stage are used. In recalculating a fillet, they are only those of the box and the fillet, not the protrusion feature which was added afterwards. + + diff --git a/ocaf_func.md b/ocaf_func.md index 6784f6e..8fed824 100644 --- a/ocaf_func.md +++ b/ocaf_func.md @@ -1,4 +1,6 @@ -# OCAF: Function Mechanism +# OCAF: Function Mechanism + +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). Let us describe the usage of the "Function Mechanism" of Open CASCADE Application Framework on a simple example. This example represents a "nail" composed by a cone and two cylinders of different radius and height: @@ -283,3 +285,5 @@ drivers for a function driver table with the help of *TFunction_DriverTable* cl return 0; } ~~~~ + + diff --git a/pbr_math.md b/pbr_math.md index 8bb69e5..6016c4b 100644 --- a/pbr_math.md +++ b/pbr_math.md @@ -1,4 +1,6 @@ # PBR math (rasterization) + +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml).Preface
**Empirical** illumination models like **Phong reflection model** have been used in real-time graphics for a long time due to their simplicity, convincing look and affordable performance. @@ -791,3 +793,5 @@ TODO | Guy18 | Romain Guy, Mathias Agopian, "Physically Based Rendering in Filament", *Part of Google's Filament project documentation*: [https://google.github.io/filament/](https://google.github.io/filament/Filament.md.html). | | Aguilar17 | Orlando Aguilar, "Spherical Harmonics", *Blog post*: [http://orlandoaguilar.github.io/sh/spherical/harmonics/irradiance/map/2017/02/12/SphericalHarmonics.html](http://orlandoaguilar.github.io/sh/spherical/harmonics/irradiance/map/2017/02/12/SphericalHarmonics.html). | | Ramamoorthi01 | Ravi Ramamoorthi, Pat Hanrahan, "An Efficient Representation for Irradiance Environment Maps", *SIGGRAPH '01: Proceedings of the 28th annual conference on Computer graphics and interactive techniques*, August 2001, pp. 497-500. | + + diff --git a/sample_ocaf.md b/sample_ocaf.md index 5a6aeba..5740837 100644 --- a/sample_ocaf.md +++ b/sample_ocaf.md @@ -1,4 +1,6 @@ -# OCAF: Usage Tutorial +# OCAF: Usage Tutorial + +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). ## Getting Started @@ -584,3 +586,5 @@ The following scenario is used: - creating a Fillet (using the selected edges) and pushing the result as a modification of Box1; - creating a Cut (Box1, Box2) as a modification of Box1 and push it in DF; - recovering the result from DF. + + diff --git a/samples.md b/samples.md index d7b6797..0916e19 100644 --- a/samples.md +++ b/samples.md @@ -1,4 +1,5 @@ -- [Tutorials and Demos](#samples__tutorials) +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +- [Tutorials and Demos](#samples__tutorials) * [Novice Guide](novice_guide)A document providing an introductory information to newcomers. * [Draw Scripts](draw_scripts) @@ -57,3 +58,4 @@ - [Java Android OCCT](samples_java_android_occt) - [iOS UIKit](occt_samples_ios_uikit) - [GLFW](occt_samples_glfw) + diff --git a/shape_healing.md b/shape_healing.md index 14041ac..1879761 100644 --- a/shape_healing.md +++ b/shape_healing.md @@ -1,5 +1,7 @@ # Shape Healing +> **DEPRECATION NOTICE:** This documentation is deprecated. Please visit the official documentation at https://dev.opencascade.org/doc/overview/html/ or download documentation from the release packages (https://github.com/Open-Cascade-SAS/OCCT/releases) or build it manually from the needed version. GitHub Actions triggered by PR also generates overview documentation (see "Build documentation" step in https://github.com/Open-Cascade-SAS/OCCT/actions/workflows/build-and-test-multiplatform.yml). +