Files
OCCT/src/ModelingData/TKBRep/BinTools/BinTools.hxx
Pasukhin Dmitry 14d4e91171 Coding - Global Refactoring OCCT as a part of 8.0.0 (#955)
- Added automated migration scripts for handle syntax, standard types, and macros
- Deprecated legacy `Standard_*` types and macros in favor of native C++ equivalents
- Introduced modern `occ` namespace with template-based type checking helpers
- Enhanced NCollection macros to support variadic arguments for complex template types- Added automated migration scripts for handle syntax, standard types, and macros
- Deprecated legacy `Standard_*` types and macros in favor of native C++ equivalents
- Introduced modern `occ` namespace with template-based type checking helpers
- Enhanced NCollection macros to support variadic arguments for complex template types
2025-12-28 14:38:06 +00:00

130 lines
6.1 KiB
C++

// Created on: 2004-05-11
// Created by: Sergey ZARITCHNY <szy@opencascade.com>
// Copyright (c) 2004-2014 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_HeaderFile
#define _BinTools_HeaderFile
#include <BinTools_FormatVersion.hxx>
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>
#include <Standard_Real.hxx>
#include <Message_ProgressRange.hxx>
class TopoDS_Shape;
//! Tool to keep shapes in binary format
class BinTools
{
public:
DEFINE_STANDARD_ALLOC
Standard_EXPORT static Standard_OStream& PutReal(Standard_OStream& OS, const double& theValue);
Standard_EXPORT static Standard_OStream& PutShortReal(Standard_OStream& OS,
const float& theValue);
Standard_EXPORT static Standard_OStream& PutInteger(Standard_OStream& OS, const int theValue);
Standard_EXPORT static Standard_OStream& PutBool(Standard_OStream& OS, const bool theValue);
Standard_EXPORT static Standard_OStream& PutExtChar(Standard_OStream& OS,
const char16_t theValue);
Standard_EXPORT static Standard_IStream& GetReal(Standard_IStream& IS, double& theValue);
Standard_EXPORT static Standard_IStream& GetShortReal(Standard_IStream& IS, float& theValue);
Standard_EXPORT static Standard_IStream& GetInteger(Standard_IStream& IS, int& theValue);
Standard_EXPORT static Standard_IStream& GetBool(Standard_IStream& IS, bool& theValue);
Standard_EXPORT static Standard_IStream& GetExtChar(Standard_IStream& IS, char16_t& theValue);
//! Writes the shape to the stream in binary format BinTools_FormatVersion_CURRENT.
//! This alias writes shape with triangulation data.
//! @param[in] theShape the shape to write
//! @param[in][out] theStream the stream to output shape into
//! @param theRange the range of progress indicator to fill in
static void Write(const TopoDS_Shape& theShape,
Standard_OStream& theStream,
const Message_ProgressRange& theRange = Message_ProgressRange())
{
Write(theShape, theStream, true, false, BinTools_FormatVersion_CURRENT, theRange);
}
//! Writes the shape to the stream in binary format of specified version.
//! @param[in] theShape the shape to write
//! @param[in][out] theStream the stream to output shape into
//! @param[in] theWithTriangles flag which specifies whether to save shape with (TRUE) or without
//! (FALSE) triangles;
//! has no effect on triangulation-only geometry
//! @param[in] theWithNormals flag which specifies whether to save triangulation with (TRUE) or
//! without (FALSE) normals;
//! has no effect on triangulation-only geometry
//! @param[in] theVersion the BinTools format version
//! @param theRange the range of progress indicator to fill in
Standard_EXPORT static void Write(
const TopoDS_Shape& theShape,
Standard_OStream& theStream,
const bool theWithTriangles,
const bool theWithNormals,
const BinTools_FormatVersion theVersion,
const Message_ProgressRange& theRange = Message_ProgressRange());
//! Reads a shape from <theStream> and returns it in <theShape>.
Standard_EXPORT static void Read(TopoDS_Shape& theShape,
Standard_IStream& theStream,
const Message_ProgressRange& theRange = Message_ProgressRange());
//! Writes the shape to the file in binary format BinTools_FormatVersion_CURRENT.
//! @param[in] theShape the shape to write
//! @param[in] theFile the path to file to output shape into
//! @param theRange the range of progress indicator to fill in
static bool Write(const TopoDS_Shape& theShape,
const char* theFile,
const Message_ProgressRange& theRange = Message_ProgressRange())
{
return Write(theShape, theFile, true, false, BinTools_FormatVersion_CURRENT, theRange);
}
//! Writes the shape to the file in binary format of specified version.
//! @param[in] theShape the shape to write
//! @param[in] theFile the path to file to output shape into
//! @param[in] theWithTriangles flag which specifies whether to save shape with (TRUE) or without
//! (FALSE) triangles;
//! has no effect on triangulation-only geometry
//! @param[in] theWithNormals flag which specifies whether to save triangulation with (TRUE) or
//! without (FALSE) normals;
//! has no effect on triangulation-only geometry
//! @param[in] theVersion the BinTools format version
//! @param theRange the range of progress indicator to fill in
Standard_EXPORT static bool Write(
const TopoDS_Shape& theShape,
const char* theFile,
const bool theWithTriangles,
const bool theWithNormals,
const BinTools_FormatVersion theVersion,
const Message_ProgressRange& theRange = Message_ProgressRange());
//! Reads a shape from <theFile> and returns it in <theShape>.
Standard_EXPORT static bool Read(TopoDS_Shape& theShape,
const char* theFile,
const Message_ProgressRange& theRange = Message_ProgressRange());
};
#endif // _BinTools_HeaderFile