src/BinTools/BinTools_ShapeSet.hxx

   1 // Created on: 2004-05-11
   2 // Created by: Sergey ZARITCHNY <szy@opencascade.com>
   3 // Copyright (c) 2004-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _BinTools_ShapeSet_HeaderFile
  17 #define _BinTools_ShapeSet_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_DefineAlloc.hxx>
  21 #include <Standard_Handle.hxx>
  22
  23 #include <TopTools_IndexedMapOfShape.hxx>
  24 #include <BinTools_LocationSet.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <BRep_Builder.hxx>
  27 #include <BinTools_SurfaceSet.hxx>
  28 #include <BinTools_CurveSet.hxx>
  29 #include <BinTools_Curve2dSet.hxx>
  30 #include <TColStd_IndexedMapOfTransient.hxx>
  31 #include <Standard_Boolean.hxx>
  32 #include <Standard_OStream.hxx>
  33 #include <Standard_IStream.hxx>
  34 #include <TopAbs_ShapeEnum.hxx>
  35 class TopoDS_Shape;
  36 class BinTools_LocationSet;
  37
  38
  39 //! Writes topology in OStream in binary format
  40 class BinTools_ShapeSet
  41 {
  42 public:
  43
  44   DEFINE_STANDARD_ALLOC
  45
  46
  47   //! Builds an empty ShapeSet.
  48   //! Parameter <isWithTriangles> is added for XML Persistence
  49   Standard_EXPORT BinTools_ShapeSet(const Standard_Boolean isWithTriangles = Standard_False);
  50
  51   Standard_EXPORT virtual ~BinTools_ShapeSet();
  52
  53   //! Define if shape will be stored with triangles
  54   Standard_EXPORT void SetWithTriangles (const Standard_Boolean isWithTriangles);
  55
  56   Standard_EXPORT void SetFormatNb (const Standard_Integer theFormatNb);
  57
  58   //! two formats available for the moment:
  59   //! First: does not write CurveOnSurface UV Points into the file
  60   //! on reading calls Check() method.
  61   //! Second: stores CurveOnSurface UV Points.
  62   //! On reading format is recognized from Version string.
  63   Standard_EXPORT Standard_Integer FormatNb() const;
  64
  65   //! Clears the content of the set.
  66   Standard_EXPORT virtual void Clear();
  67
  68   //! Stores <S> and its sub-shape. Returns the index of <S>.
  69   //! The method AddGeometry is called on each sub-shape.
  70   Standard_EXPORT Standard_Integer Add (const TopoDS_Shape& S);
  71
  72   //! Returns the sub-shape of index <I>.
  73   Standard_EXPORT const TopoDS_Shape& Shape (const Standard_Integer I) const;
  74
  75   //! Returns the index of <S>.
  76   Standard_EXPORT Standard_Integer Index (const TopoDS_Shape& S) const;
  77
  78   Standard_EXPORT const BinTools_LocationSet& Locations() const;
  79
  80   Standard_EXPORT BinTools_LocationSet& ChangeLocations();
  81
  82   //! Returns number of shapes read from file.
  83   Standard_EXPORT Standard_Integer NbShapes() const;
  84
  85   //! Writes the content of  me  on the stream <OS> in binary
  86   //! format that can be read back by Read.
  87   //!
  88   //! Writes the locations.
  89   //!
  90   //! Writes the geometry calling WriteGeometry.
  91   //!
  92   //! Dumps the shapes from last to first.
  93   //! For each shape  :
  94   //! Write the type.
  95   //! calls WriteGeometry(S).
  96   //! Write the flags, the subshapes.
  97   Standard_EXPORT virtual void Write (Standard_OStream& OS) const;
  98
  99   //! Reads the content of me from the binary stream  <IS>. me
 100   //! is first cleared.
 101   //!
 102   //! Reads the locations.
 103   //!
 104   //! Reads the geometry calling ReadGeometry.
 105   //!
 106   //! Reads the shapes.
 107   //! For each shape
 108   //! Reads the type.
 109   //! calls ReadGeometry(T,S).
 110   //! Reads the flag, the subshapes.
 111   Standard_EXPORT virtual void Read (Standard_IStream& IS);
 112
 113   //! Writes   on  <OS>   the shape   <S>.    Writes the
 114   //! orientation, the index of the TShape and the index
 115   //! of the Location.
 116   Standard_EXPORT virtual void Write (const TopoDS_Shape& S, Standard_OStream& OS) const;
 117
 118   //! Writes the geometry of  me  on the stream <OS> in a
 119   //! binary format that can be read back by Read.
 120   Standard_EXPORT virtual void WriteGeometry (Standard_OStream& OS) const;
 121
 122   //! Reads the geometry of me from the  stream  <IS>.
 123   Standard_EXPORT virtual void ReadGeometry (Standard_IStream& IS);
 124
 125   //! Reads  from <IS>  a shape  and  returns  it in  S.
 126   //! <NbShapes> is the number of tshapes in the set.
 127   Standard_EXPORT virtual void Read (TopoDS_Shape& S, Standard_IStream& IS, const Standard_Integer NbShapes) const;
 128
 129   //! Writes the geometry of <S>  on the stream <OS> in a
 130   //! binary format that can be read back by Read.
 131   Standard_EXPORT virtual void WriteGeometry (const TopoDS_Shape& S, Standard_OStream& OS) const;
 132
 133   //! Reads the geometry of a shape of type <T> from the
 134   //! stream <IS> and returns it in <S>.
 135   Standard_EXPORT virtual void ReadGeometry (const TopAbs_ShapeEnum T, Standard_IStream& IS, TopoDS_Shape& S);
 136
 137   //! Stores the goemetry of <S>.
 138   Standard_EXPORT virtual void AddGeometry (const TopoDS_Shape& S);
 139
 140   //! Inserts  the shape <S2> in  the  shape <S1>.
 141   Standard_EXPORT virtual void AddShapes (TopoDS_Shape& S1, const TopoDS_Shape& S2);
 142
 143   //! Reads the 3d polygons  of me
 144   //! from the  stream  <IS>.
 145   Standard_EXPORT void ReadPolygon3D (Standard_IStream& IS);
 146
 147   //! Writes the 3d polygons
 148   //! on the stream <OS> in a format that can
 149   //! be read back by Read.
 150   Standard_EXPORT void WritePolygon3D (Standard_OStream& OS) const;
 151
 152   //! Reads the triangulation of me
 153   //! from the  stream  <IS>.
 154   Standard_EXPORT void ReadTriangulation (Standard_IStream& IS);
 155
 156   //! Writes the triangulation
 157   //! on the stream <OS> in a format that can
 158   //! be read back by Read.
 159   Standard_EXPORT void WriteTriangulation (Standard_OStream& OS) const;
 160
 161   //! Reads the polygons on triangulation of me
 162   //! from the  stream  <IS>.
 163   Standard_EXPORT void ReadPolygonOnTriangulation (Standard_IStream& IS);
 164
 165   //! Writes the polygons on triangulation
 166   //! on the stream <OS> in a format that can
 167   //! be read back by Read.
 168   Standard_EXPORT void WritePolygonOnTriangulation (Standard_OStream& OS) const;
 169
 170
 171
 172
 173 protected:
 174
 175
 176
 177
 178
 179 private:
 180
 181
 182
 183   TopTools_IndexedMapOfShape myShapes;
 184   BinTools_LocationSet myLocations;
 185   Standard_Integer myFormatNb;
 186   BRep_Builder myBuilder;
 187   BinTools_SurfaceSet mySurfaces;
 188   BinTools_CurveSet myCurves;
 189   BinTools_Curve2dSet myCurves2d;
 190   TColStd_IndexedMapOfTransient myPolygons2D;
 191   TColStd_IndexedMapOfTransient myPolygons3D;
 192   TColStd_IndexedMapOfTransient myTriangulations;
 193   TColStd_IndexedMapOfTransient myNodes;
 194   Standard_Boolean myWithTriangles;
 195
 196
 197 };
 198
 199
 200
 201
 202
 203
 204
 205 #endif // _BinTools_ShapeSet_HeaderFile