0031918: Application Framework - New binary format for fast reading part of OCAF...
[occt.git] / src / BinTools / BinTools_OStream.hxx
1 // Copyright (c) 2021 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _BinTools_OStream_HeaderFile
15 #define _BinTools_OStream_HeaderFile
16
17 #include <BinTools.hxx>
18 #include <BinTools_ObjectType.hxx>
19 #include <TopAbs_ShapeEnum.hxx>
20 #include <TopAbs_Orientation.hxx>
21 #include <gp_Pnt.hxx>
22 #include <Poly_Triangle.hxx>
23 #include <gp_Vec3f.hxx>
24
25 //! Substitution of OStream for shape writer for fast management of position in the file
26 //! and operation on all writing types.
27 class BinTools_OStream
28 {
29 public:
30
31   //! Creates OStream using the current stream OStream.
32   Standard_EXPORT BinTools_OStream (Standard_OStream& theStream);
33
34   //! Returns the current position of the stream
35   Standard_EXPORT const uint64_t& Position() { return myPosition; }
36   //! Writes the reference to the given position (an offset between the current and the given one).
37   Standard_EXPORT void WriteReference (const uint64_t& thePosition);
38   //! Writes an identifier of shape type and orientation into the stream.
39   Standard_EXPORT void WriteShape (const TopAbs_ShapeEnum& theType, const TopAbs_Orientation& theOrientation);
40
41
42   //! Writes an object type to the stream.
43   Standard_EXPORT BinTools_OStream& operator << (const BinTools_ObjectType& theType);
44   //! Writes a byte to the stream.
45   Standard_EXPORT BinTools_OStream& operator << (const Standard_Byte& theValue);
46   //! Writes a real to the stream.
47   Standard_EXPORT BinTools_OStream& operator << (const Standard_Real& theValue);
48   //! Writes a boolean to the stream.
49   Standard_EXPORT BinTools_OStream& operator << (const Standard_Boolean& theValue);
50   //! Writes a integer to the stream.
51   Standard_EXPORT BinTools_OStream& operator << (const Standard_Integer& theValue);
52   //! Writes a extended character to the stream.
53   Standard_EXPORT BinTools_OStream& operator << (const Standard_ExtCharacter& theValue);
54   //! Writes a 3D point to the stream.
55   Standard_EXPORT BinTools_OStream& operator << (const gp_Pnt& theValue);
56   //! Writes a 3D direction to the stream.
57   Standard_EXPORT BinTools_OStream& operator << (const gp_Dir& theValue);
58   //! Writes a 2D point to the stream.
59   Standard_EXPORT BinTools_OStream& operator << (const gp_Pnt2d& theValue);
60   //! Writes a 2D direction to the stream.
61   Standard_EXPORT BinTools_OStream& operator << (const gp_Dir2d& theValue);
62   //! Writes a transformation matrix to the stream.
63   Standard_EXPORT BinTools_OStream& operator << (const gp_Trsf& theValue);
64   //! Writes triangle nodes indices to the stream.
65   Standard_EXPORT BinTools_OStream& operator << (const Poly_Triangle& theValue);
66   //! Writes a vector to the stream.
67   Standard_EXPORT BinTools_OStream& operator << (const gp_Vec3f& theValue);
68
69   //! Writes 3 booleans as one byte to the stream.
70   Standard_EXPORT void PutBools (
71     const Standard_Boolean theValue1, const Standard_Boolean theValue2, const Standard_Boolean theValue3);
72
73   //! Writes 7 booleans as one byte to the stream.
74   Standard_EXPORT void PutBools (
75     const Standard_Boolean theValue1, const Standard_Boolean theValue2, const Standard_Boolean theValue3,
76     const Standard_Boolean theValue4, const Standard_Boolean theValue5, const Standard_Boolean theValue6,
77     const Standard_Boolean theValue7);
78
79 private:
80   Standard_OStream* myStream; ///< pointer to the stream
81   uint64_t myPosition; ///< the current position relatively to the OStream position at the moment of creation of this class instance
82   Standard_Real myRealBuf[12]; ///< buffer for 12 reals storage
83   Standard_Integer myIntBuf[3]; ///< buffer for 3 integers storage
84   float myFloatBuf[3]; ///< buffer for 3 floats storage
85 };
86
87 #endif // _BinTools_OStream_HeaderFile