1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-04 18:06:22 +03:00
mpv d5c71e2057 0031918: Application Framework - New binary format for fast reading part of OCAF document
Implementation of new format for quick reading and writing parts of the documents (sub-set of labels and sub-set of attributes). It consists in writing shapes and all their contents right in the TNaming_NamedShape attribute placement and skipping the shape section. New format 12 for Binary file types is assigned to this version.

Added PCDM_ReaderFilter class that could be used in Open methods of TDocStd_Application. If it is defined, it allows to read:
- into already opened document in append mode AppendMode_Protect (do not overwrite existing attributes) or AppendMode_Overwrite
- only specified sub-trees of the document using AddPath (const TCollection_AsciiString& theEntryToRead)
- only specified attributes using AddRead (const TCollection_AsciiString& theRead) where theRead could be "TDataStd_Name", for example
- to skip specified attributes read using AddSkipped (const TCollection_AsciiString& theSkipped) where theSkipped could be "TDF_Reference", for example

The current limitations:
- only in Bin format
- if shapes have in the document shared topology, loaded in "append" mode in different "load" operations, they will have no shared topology anymore

Modifications:
BinLDrivers and BinDrivers packages - modifications related to the quick part tree format flag usage, skipping shape section writing and adding labels sizes into the document to be able to pass labels during the reading quickly.
BinObjMgt_Persistent and BinObjMgt_Position - to add possibility to write directly into the stream some data just after the attribute. Before this record a data-size is recorded.
BinMXCAFDoc package modifications to write BinMXCAFDoc_LocationDriver location in the same way as shapes write location data right after the attribute (empty) data in this new format.
BinTools package: creation of ShapeReader and ShapeWriter classes with same root class ShapeSetBase with ShapeSet class. These classes allows to write/read shapes directly to the stream. If some object is already in the stream, write a reference - relative position of the duplicated object. The old format of documents is still supported by Bin_ToolsShapeSet class.
PCDM_ReaderFilter - Allows the user to create a reading filter. It contains algorithm to browse labels tree quickly, without usage of referencing by entry-strings.
TDocStd, CDF and some other packages are changed for supporting reading filters API and options.

Tests, documentation and upgrade information are also added for both issues: 31839 and 31918 related to this commit.
2021-07-09 19:13:59 +03:00

Open CASCADE Technology
=======================

This directory contains sources of Open CASCADE Technology (OCCT), a software
development platform providing services for 3D surface and solid modeling, CAD 
data exchange, and visualization. Most of OCCT functionality is available in 
the form of C++ libraries. OCCT can be best applied in development of software 
dealing with 3D modeling (CAD), manufacturing / measuring (CAM) or numerical 
simulation (CAE).

License
-------

Open CASCADE Technology is free software; you can redistribute it and / or 
modify it under the terms of the GNU Lesser General Public version 2.1 as 
published by the Free Software Foundation, with special exception defined in 
the file OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included
in OCCT distribution for complete text of the license.

Alternatively, Open CASCADE Technology may be used under the terms of Open 
CASCADE commercial license or contractual agreement.

Note that Open CASCADE Technology is provided on an "AS IS" basis, WITHOUT 
WARRANTY OF ANY KIND. The entire risk related to any use of the OCCT code and 
materials is on you. See the license text for formal disclaimer.

Packaging
---------

You can receive certified version of OCCT code in different packages.

- Snapshot of Git repository: contains C++ header and source files of OCCT,
  documentation sources, build scripts, and CMake project files.

- Complete source archive: contains all sources of OCCT, generated HTML and PDF
  documentation, and ready-to-use projects for building on all officially 
  supported platforms.

- Binary package (platform-specific): in addition to complete source archive, 
  it includes binaries of OCCT and third-party libraries built on one platform. 
  This package allows using OCCT immediately after installation.

Certified versions of OCCT can be downloaded from http://www.opencascade.com

You can also find OCCT pre-installed on your system, or install it from 
packages provided by a third party. Note that packaging and functionality
of such versions can be different from certified releases. Please consult 
documentation accompanying your version for details.

Documentation
-------------

Open file doc/html/index.html to browse HTML documentation.

If HTML documentation is not available in your package, you can:

- Generate it from sources. 

  You need to have Tcl and Doxygen 1.8.4 (or above) installed on your system.
  and accessible in your environment (check environment variable PATH).
  Use batch file *gendoc.bat* on Windows or Bash script *gendoc* on Linux
  or OS X to (re)generate documentation.

- Read documentation in source plain text (MarkDown) format found in 
  subfolder *dox*

See *dox/dev_guides/documentation/documentation.md* for details.

Building
--------

In most cases you need to rebuild OCCT on your platform (OS, compiler) before
using it in your project, to ensure binary compatibility.

Consult the file *dox/dev_guides/building/building.md* for instructions on
building OCCT from sources on supported platforms.

Version
-------

The current version of OCCT can be consulted in the file
*src/Standard/Standard_Version.hxx*

Development
-----------

For information regarding OCCT code development please consult the official 
OCCT Collaborative Development Portal:
http://dev.opencascade.org
Description
Mirror of OpenCascade OCCT, at https://git.dev.opencascade.org/repos/occt
Readme 167 MiB
Languages
C++ 98.1%
CMake 1%
Tcl 0.3%
C 0.2%
GLSL 0.1%