mirror of
https://github.com/Open-Cascade-SAS/OCCT.git
synced 2026-09-07 05:08:13 +08:00
Add deprecation notices to various documentation files
- Added a deprecation notice to the following files: - boolean_operations.md - brep_format.md - build_upgrade.md - building_3rdparty.md - building_documentation.md - building_occt.md - coding_rules.md - contribution.md - contribution_workflow.md - de_wrapper.md - debug.md - documentation.md - draw_scripts.md - draw_test_harness.md - foundation_classes.md - git_guide.md - iges.md - inspector.md - license.md - mesh.md - modeling_algos.md - modeling_data.md - novice_guide.md - ocaf.md - ocaf_func.md - pbr_math.md - sample_ocaf.md - samples.md - shape_healing.md - specification.md - step.md - tests.md - tutorial.md - upgrade.md - user_guides.md - vis.md - visualization.md - xde.md
dpasukhi
+2
@@ -1,5 +1,7 @@
|
||||
# Introduction <a id="mainpage" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<img src="images/occt_logo.png" alt="">
|
||||
|
||||
Welcome to Open CASCADE Technology (OCCT), a software development platform
|
||||
|
||||
+5
-1
@@ -1,4 +1,6 @@
|
||||
# AIS: Custom Presentation <a id="tutorials__ais_object" class="anchor"></a>
|
||||
# AIS: Custom Presentation <a id="tutorials__ais_object" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="intro">Getting Started</a></h2>
|
||||
|
||||
@@ -908,3 +910,5 @@ vfit
|
||||
~~~~
|
||||
|
||||
You may also take a look onto source code of this command at `src/QADraw/QADraw_Tutorials`.cxx if you have some problems following the tutorial.
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Boolean Operations <a id="specification__boolean_operations" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="specification__boolean_1">Introduction</a></h2>
|
||||
|
||||
Boolean operations are used to create new shapes from the combinations of two groups of shapes.
|
||||
@@ -3595,3 +3597,5 @@ bapibop r 4
|
||||
~~~~
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# BRep Format <a id="specification__brep_format" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="specification__brep_format_1">Introduction</a></h2>
|
||||
|
||||
BREP format is used to store 3D models and allows to store a model which consists
|
||||
@@ -2407,3 +2409,5 @@ Flag \<face data natural restriction flag\> is used in a special way [1].
|
||||
+1 0
|
||||
0
|
||||
```
|
||||
|
||||
|
||||
|
||||
+5
-1
@@ -1,4 +1,6 @@
|
||||
# Build, Debug and Upgrade <a id="build_upgrade" class="anchor"></a>
|
||||
# Build, Debug and Upgrade <a id="build_upgrade" class="anchor"></a>
|
||||
|
||||
> **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 building, debugging and upgrade procedures:
|
||||
|
||||
@@ -7,3 +9,5 @@ This chapter contains the detailed information about building, debugging and upg
|
||||
* [Building Documentation](building_documentation)
|
||||
* [Debug](debug)
|
||||
* [Upgrade](upgrade)
|
||||
|
||||
|
||||
|
||||
+5
-1
@@ -1,4 +1,6 @@
|
||||
# Build 3rd-parties <a id="build_upgrade_building_3rdparty" class="anchor"></a>
|
||||
# Build 3rd-parties <a id="build_upgrade_building_3rdparty" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
On Windows, the easiest way to install third-party libraries is to download archive with pre-built binaries from https://dev.opencascade.org/resources/download/3rd-party-components.
|
||||
On Linux and macOS, it is recommended to use the version installed in the system natively.
|
||||
|
||||
@@ -550,3 +552,5 @@ in `FREEIMAGE_SRC_DIR` by the corrected file, which you can find in attachment t
|
||||
5. Clean temporary files
|
||||
|
||||
make clean
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Build Documentation <a id="build_upgrade__building_documentation" class="anchor"></a>
|
||||
# Build Documentation <a id="build_upgrade__building_documentation" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
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.
|
||||
@@ -16,3 +18,5 @@ To generate Reference manual:
|
||||
Run this command without arguments to get help on supported options.
|
||||
|
||||
See [Link](contribution#occt_contribution__documentation) for prerequisites and details on OCCT documentation system.
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Build OCCT <a id="build_upgrade__building_occt" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
Before building OCCT, make sure to have all required third-party libraries installed.
|
||||
The list of required libraries depends on what OCCT modules will be used, and your preferences.
|
||||
The typical minimum is **FreeType** (necessary for Visualization) and **Tcl/Tk** (for DRAW).
|
||||
@@ -405,3 +407,5 @@ To start *DRAWEXE*, which has been built with XCode on Mac OS X, perform the fol
|
||||
~~~~
|
||||
|
||||
Option *d* is used if OCCT has been built in **Debug** mode.
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Coding Rules <a id="occt_contribution__coding_rules" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_coding_rules_1">Introduction</a></h2>
|
||||
|
||||
The purpose of this document is to define a common programming style for Open CASCADE Technology.
|
||||
@@ -1147,3 +1149,5 @@ void main()
|
||||
Position);
|
||||
}
|
||||
~~~~
|
||||
|
||||
|
||||
|
||||
+5
-1
@@ -1,4 +1,6 @@
|
||||
# Contribution <a id="contribution" class="anchor"></a>
|
||||
# Contribution <a id="contribution" class="anchor"></a>
|
||||
|
||||
> **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)
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Contribution Workflow <a id="occt_contribution__contribution_workflow" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_contribution_intro">Introduction</a></h2>
|
||||
|
||||
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. |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Data Exchange Wrapper (DE_Wrapper) <a id="occt_user_guides__de_wrapper" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_de_wrapper_1">Introduction</a></h2>
|
||||
|
||||
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}
|
||||
~~~~
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# Debugging tools and hints <a id="occt__debug" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_debug_intro">Introduction</a></h2>
|
||||
|
||||
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:
|
||||
<h3><a id="occt_debug_sanitizers_windows">Windows</a></h3>
|
||||
|
||||
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).
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Documentation System <a id="occt_contribution__documentation" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="OCCT_DM_SECTION_1">Introduction</a></h2>
|
||||
|
||||
OCCT documentation is provided in several forms:
|
||||
@@ -509,3 +511,5 @@ that leads to the following result:
|
||||
$$
|
||||
\sqrt{3x-1}+(1+x)^2
|
||||
$$
|
||||
|
||||
|
||||
|
||||
+5
-2
@@ -1,4 +1,6 @@
|
||||
# Draw: Demo Scripts <a id="samples__draw_scripts" class="anchor"></a>
|
||||
# Draw: Demo Scripts <a id="samples__draw_scripts" class="anchor"></a>
|
||||
|
||||
> **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 <i>CASROOT/samples/tcl</i>. 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 \<command_name\>* to find out the arguments for a given command
|
||||
2. Type *help \<command_name\>* to find out the arguments for a given command
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Draw Test Harness <a id="occt_user_guides__test_harness" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_draw_1">Introduction</a></h2>
|
||||
|
||||
@@ -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
|
||||
~~~~
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Foundation Classes <a id="occt_user_guides__foundation_classes" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_fcug_1">Introduction</a></h2>
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# Guide to installing and using Git for OCCT development <a id="occt_contribution__git_guide" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_gitguide_1">Overview</a></h2>
|
||||
|
||||
<h3><a id="occt_gitguide_1_1">Purpose</a></h3>
|
||||
@@ -514,3 +516,5 @@ To rebase your branch into a single commit, you need to do the following:
|
||||
<img src="images/OCCT_GitGuide_V2_image026.png" alt="" width="320">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# IGES Translator <a id="occt_user_guides__iges" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_iges_1">Introduction</a></h2>
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# Inspector <a id="occt_user_guides__inspector" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_inspector_1">Introduction</a></h2>
|
||||
|
||||
This manual explains how to use the Inspector.
|
||||
@@ -635,3 +637,5 @@ In MSVC studio, a separate folder contains Inspector projects.
|
||||
* DFBrowser,
|
||||
* ShapeView,
|
||||
* VInspector.
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# License <a id="occt_public_license" class="anchor"></a>
|
||||
|
||||
> **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.
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# Mesh <a id="occt_user_guides__mesh" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_modalg_11_1">Mesh presentations</a></h2>
|
||||
|
||||
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 de
|
||||
<h3><a id="occt_modalg_11_3_9">Postprocess discrete model</a></h3>
|
||||
|
||||
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*.
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Modeling Algorithms <a id="occt_user_guides__modeling_algos" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_modalg_1">Introduction</a></h2>
|
||||
|
||||
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).
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Modeling Data <a id="occt_user_guides__modeling_data" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_modat_0">Introduction</a></h2>
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Novice Guide <a id="samples__novice_guide" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="diffs">Modeling with OCCT: Key differences</a></h2>
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# OCAF <a id="occt_user_guides__ocaf" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_ocaf_1">Introduction</a></h2>
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
+5
-1
@@ -1,4 +1,6 @@
|
||||
# OCAF: Function Mechanism <a id="samples__ocaf_func" class="anchor"></a>
|
||||
# OCAF: Function Mechanism <a id="samples__ocaf_func" class="anchor"></a>
|
||||
|
||||
> **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;
|
||||
}
|
||||
~~~~
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,4 +1,6 @@
|
||||
# PBR math (rasterization) <a id="specification__pbr_math" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
<h2><a id="pbr_preface">Preface</a></h2>
|
||||
|
||||
**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
|
||||
| <a id="Guy18">Guy18</a> | 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). |
|
||||
| <a id="Aguilar17">Aguilar17</a> | 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). |
|
||||
| <a id="Ramamoorthi01">Ramamoorthi01</a> | 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. |
|
||||
|
||||
|
||||
|
||||
+5
-1
@@ -1,4 +1,6 @@
|
||||
# OCAF: Usage Tutorial <a id="samples__ocaf" class="anchor"></a>
|
||||
# OCAF: Usage Tutorial <a id="samples__ocaf" class="anchor"></a>
|
||||
|
||||
> **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.
|
||||
|
||||
|
||||
|
||||
+3
-1
@@ -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)
|
||||
<br>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)
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Shape Healing <a id="occt_user_guides__shape_healing" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_shg_1">Overview</a></h2>
|
||||
|
||||
<h3><a id="occt_shg_1_1">Introduction</a></h3>
|
||||
@@ -2271,3 +2273,5 @@ aMsg01.AddInteger (73);
|
||||
aMsg01.AddString ("SampleFile");
|
||||
// fill out the code areas
|
||||
~~~~
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,11 @@
|
||||
# Specifications <a id="specification" class="anchor"></a>
|
||||
|
||||
> **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 specifications information:
|
||||
|
||||
* [Boolean Operations](boolean_operations)
|
||||
* [BRep Format](brep_format)
|
||||
* [PBR Math (Rasterization)](pbr_math)
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# STEP Translator <a id="occt_user_guides__step" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_step_1">Introduction</a></h2>
|
||||
|
||||
STEP is more and more widely used to exchange data between various software, involved in CAD, PDM, Analysis, etc... STEP is far more than an "exchange standard" : it provides a technology and a set of methodologies to describe the data to exchange in a modular and upgradeable way. Regarding OCCT, this mostly applies to CAD data but it is not a limitation, other kinds of data for specific applications can be addressed too.
|
||||
@@ -1889,3 +1891,5 @@ Attributes can be imported from STEP.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# Automated Testing System <a id="occt_contribution__tests" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="testmanual_intro">Introduction</a></h2>
|
||||
|
||||
This document provides OCCT developers and contributors with an overview and practical guidelines for work with OCCT automatic testing system.
|
||||
@@ -1490,3 +1492,5 @@ Use options <i>-tol_\* </i> for that.
|
||||
checktrinfo result -defl 1 -tol_abs_defl 0.001
|
||||
~~~~
|
||||
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# Modeling: Bottle Tutorial <a id="occt__tutorial" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="sec1">Overview </a></h2>
|
||||
|
||||
This tutorial will teach you how to use Open CASCADE Technology services to model a 3D object. The purpose of this tutorial is not to describe all Open CASCADE Technology classes but to help you start thinking in terms of Open CASCADE Technology as a tool.
|
||||
@@ -829,3 +831,5 @@ Complete definition of MakeBottle function (defined in the file src/MakeBottle.c
|
||||
}
|
||||
~~~~
|
||||
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# Upgrade from older OCCT versions <a id="occt__upgrade" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="upgrade_intro">Introduction</a></h2>
|
||||
|
||||
This document provides technical details on changes made in particular versions of OCCT. It can help to upgrade user applications based on previous versions of OCCT to newer ones.
|
||||
@@ -2446,3 +2448,5 @@ The most recommended manager is `JeMalloc`. To use it with a plugin system, like
|
||||
`BUILD_OPT_PROFILE` is a new variable to define optimization level. Available profiles:
|
||||
* `Default` - specializes only in quality-dependent parameters for the compiler.
|
||||
* `Production` - specializes in performance and quality-dependent parameters for the compiler and linker.
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# User Guides <a id="user_guides" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
OCCT User Guides are organized by OCCT modules:
|
||||
|
||||
* [Foundation Classes](foundation_classes)
|
||||
@@ -16,3 +18,5 @@ OCCT User Guides are organized by OCCT modules:
|
||||
* [Open CASCADE Application Framework (OCAF)](ocaf)
|
||||
* [DRAW Test Harness](draw_test_harness)
|
||||
* [Inspector](inspector)
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# VTK Integration Services (VIS) <a id="occt_user_guides__vis" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_vis_1">Introduction</a></h2>
|
||||
|
||||
VIS component provides adaptation functionality for visualization of OCCT topological shapes by means of VTK library. This User’s Guide describes how to apply VIS classes in application dealing with 3D visualization based on VTK library.
|
||||
@@ -405,3 +407,5 @@ IVtk_ShapeIdList subShapeIds
|
||||
* *IVtkDraw_HighlightAndSelectionPipeline* -- Creates VTK pipeline with OCCT shape data source and properly initialized VIS filters.
|
||||
* *IVtkDraw_Interactor* -- Controls simple interactive actions, such as detection and selection of the displayed shapes.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Visualization <a id="occt_user_guides__visualization" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_visu_1">Introduction</a></h2>
|
||||
|
||||
Visualization in Open CASCADE Technology is based on the separation of:
|
||||
@@ -2246,3 +2248,5 @@ It maintains a map "Attribute ID --> attribute value" and can be easily extended
|
||||
|
||||
In all other respects, *MeshVS_Mesh* is very similar to any other class derived from *AIS_InteractiveObject*
|
||||
and it should be used accordingly (refer to the description of *AIS package* in the documentation).
|
||||
|
||||
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
# Extended Data Exchange (XDE) <a id="occt_user_guides__xde" class="anchor"></a>
|
||||
|
||||
> **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).
|
||||
|
||||
<h2><a id="occt_xde_1">Introduction</a></h2>
|
||||
|
||||
This manual explains how to use the **eXtended Data Exchange** (XDE).
|
||||
@@ -1381,3 +1383,5 @@ As a result, if an application works on Assemblies, on Colors or Layers, on Vali
|
||||
it can rely on all or a part of the XDE definitions, and include them in its own data structure.
|
||||
|
||||
In addition, if an application has a data structure far from these notions, it can get data (such as Colors and Names on Shapes) according to its needs, but without having to consider the whole.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user