mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-21 10:13:43 +03:00
d5c71e2057
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.
119 lines
4.3 KiB
C++
119 lines
4.3 KiB
C++
// Copyright (c) 2021 OPEN CASCADE SAS
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License 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 and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#ifndef _BinTools_ShapeSetBase_HeaderFile
|
|
#define _BinTools_ShapeSetBase_HeaderFile
|
|
|
|
#include <Standard.hxx>
|
|
#include <Standard_DefineAlloc.hxx>
|
|
#include <Standard_Handle.hxx>
|
|
|
|
#include <Standard_OStream.hxx>
|
|
#include <Standard_IStream.hxx>
|
|
#include <Message_ProgressRange.hxx>
|
|
#include <BinTools_FormatVersion.hxx>
|
|
|
|
class TopoDS_Shape;
|
|
class gp_Pnt;
|
|
|
|
//! Writes to the stream a gp_Pnt data
|
|
Standard_OStream& operator << (Standard_OStream& OS, const gp_Pnt P);
|
|
|
|
//! Computes a hash code for the given value of the uint64_t type, in range [1, theUpperBound]
|
|
inline Standard_Integer HashCode (const uint64_t theValue, const Standard_Integer theUpperBound)
|
|
{
|
|
return IntegerHashCode(theValue, 0xffffffffffffffff, theUpperBound);
|
|
}
|
|
|
|
//! A base class for all readers/writers of TopoDS_Shape into/from stream.
|
|
class BinTools_ShapeSetBase
|
|
{
|
|
public:
|
|
|
|
DEFINE_STANDARD_ALLOC
|
|
|
|
|
|
//! A default constructor.
|
|
Standard_EXPORT BinTools_ShapeSetBase();
|
|
|
|
Standard_EXPORT virtual ~BinTools_ShapeSetBase();
|
|
|
|
//! Return true if shape should be stored with triangles.
|
|
Standard_Boolean IsWithTriangles() const { return myWithTriangles; }
|
|
//! Return true if shape should be stored triangulation with normals.
|
|
Standard_Boolean IsWithNormals() const { return myWithNormals; }
|
|
|
|
//! Define if shape will be stored with triangles.
|
|
//! Ignored (always written) if face defines only triangulation (no surface).
|
|
void SetWithTriangles (const Standard_Boolean theWithTriangles) { myWithTriangles = theWithTriangles; }
|
|
//! Define if shape will be stored triangulation with normals.
|
|
//! Ignored (always written) if face defines only triangulation (no surface).
|
|
void SetWithNormals(const Standard_Boolean theWithNormals) { myWithNormals = theWithNormals; }
|
|
|
|
//! Sets the BinTools_FormatVersion.
|
|
Standard_EXPORT void SetFormatNb (const Standard_Integer theFormatNb);
|
|
|
|
//! Returns the BinTools_FormatVersion.
|
|
Standard_EXPORT Standard_Integer FormatNb() const { return myFormatNb; }
|
|
|
|
//! Clears the content of the set.
|
|
Standard_EXPORT virtual void Clear() {}
|
|
|
|
//! Writes the content of me on the stream <OS> in binary
|
|
//! format that can be read back by Read.
|
|
//!
|
|
//! Writes the locations.
|
|
//!
|
|
//! Writes the geometry calling WriteGeometry.
|
|
//!
|
|
//! Dumps the shapes from last to first.
|
|
//! For each shape :
|
|
//! Write the type.
|
|
//! calls WriteGeometry(S).
|
|
//! Write the flags, the subshapes.
|
|
Standard_EXPORT virtual void Write
|
|
(Standard_OStream& /*OS*/, const Message_ProgressRange& /*theRange*/ = Message_ProgressRange()) {}
|
|
|
|
//! Reads the content of me from the binary stream <IS>. me
|
|
//! is first cleared.
|
|
//!
|
|
//! Reads the locations.
|
|
//!
|
|
//! Reads the geometry calling ReadGeometry.
|
|
//!
|
|
//! Reads the shapes.
|
|
//! For each shape
|
|
//! Reads the type.
|
|
//! calls ReadGeometry(T,S).
|
|
//! Reads the flag, the subshapes.
|
|
Standard_EXPORT virtual void Read
|
|
(Standard_IStream& /*IS*/, const Message_ProgressRange& /*theRange*/ = Message_ProgressRange()) {}
|
|
|
|
//! Writes on <OS> the shape <S>. Writes the
|
|
//! orientation, the index of the TShape and the index
|
|
//! of the Location.
|
|
Standard_EXPORT virtual void Write (const TopoDS_Shape& /*theShape*/, Standard_OStream& /*theStream*/) {}
|
|
|
|
//! An empty virtual method for redefinition in shape-reader.
|
|
Standard_EXPORT virtual void Read (Standard_IStream& /*theStream*/, TopoDS_Shape& /*theShape*/) {}
|
|
|
|
static const Standard_CString THE_ASCII_VERSIONS[BinTools_FormatVersion_UPPER + 1];
|
|
private:
|
|
|
|
Standard_Integer myFormatNb;
|
|
Standard_Boolean myWithTriangles;
|
|
Standard_Boolean myWithNormals;
|
|
};
|
|
|
|
#endif // _BinTools_ShapeSet_HeaderFile
|