src/BRepTools/BRepTools.hxx

   1 // Created on: 1992-08-28
   2 // Created by: Remi LEQUETTE
   3 // Copyright (c) 1992-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _BRepTools_HeaderFile
  18 #define _BRepTools_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Real.hxx>
  25 #include <Standard_Boolean.hxx>
  26 #include <TopTools_IndexedMapOfShape.hxx>
  27 #include <Standard_OStream.hxx>
  28 #include <Standard_IStream.hxx>
  29 #include <Standard_CString.hxx>
  30
  31 #include <Message_ProgressIndicator.hxx>
  32
  33 class TopoDS_Face;
  34 class TopoDS_Wire;
  35 class TopoDS_Edge;
  36 class Bnd_Box2d;
  37 class TopoDS_Vertex;
  38 class TopoDS_Shell;
  39 class TopoDS_Solid;
  40 class TopoDS_CompSolid;
  41 class TopoDS_Compound;
  42 class TopoDS_Shape;
  43 class Message_ProgressIndicator;
  44 class BRep_Builder;
  45 class BRepTools_WireExplorer;
  46 class BRepTools_Modification;
  47 class BRepTools_Modifier;
  48 class BRepTools_TrsfModification;
  49 class BRepTools_NurbsConvertModification;
  50 class BRepTools_GTrsfModification;
  51 class BRepTools_Substitution;
  52 class BRepTools_Quilt;
  53 class BRepTools_ShapeSet;
  54 class BRepTools_ReShape;
  55
  56
  57 //! The BRepTools package provides  utilities for BRep
  58 //! data structures.
  59 //!
  60 //! * WireExplorer : A tool to explore the topology of
  61 //! a wire in the order of the edges.
  62 //!
  63 //! * ShapeSet :  Tools used for  dumping, writing and
  64 //! reading.
  65 //!
  66 //! * UVBounds : Methods to compute the  limits of the
  67 //! boundary  of a  face,  a wire or   an edge in  the
  68 //! parametric space of a face.
  69 //!
  70 //! *  Update : Methods  to call when   a topology has
  71 //! been created to compute all missing data.
  72 //!
  73 //! * UpdateFaceUVPoints  :  Method to  update  the UV
  74 //! points stored   with  the edges   on a face.  This
  75 //! method ensure that connected  edges  have the same
  76 //! UV point on their common extremity.
  77 //!
  78 //! * Compare : Method to compare two vertices.
  79 //!
  80 //! * Compare : Method to compare two edges.
  81 //!
  82 //! * OuterWire : A method to find the outer wire of a
  83 //! face.
  84 //!
  85 //! * Map3DEdges : A method to map all the 3D Edges of
  86 //! a Shape.
  87 //!
  88 //! * Dump : A method to dump a BRep object.
  89 class BRepTools
  90 {
  91 public:
  92
  93   DEFINE_STANDARD_ALLOC
  94
  95
  96   //! Returns in UMin,  UMax, VMin,  VMax  the  bounding
  97   //! values in the parametric space of F.
  98   Standard_EXPORT static void UVBounds (const TopoDS_Face& F, Standard_Real& UMin, Standard_Real& UMax, Standard_Real& VMin, Standard_Real& VMax);
  99
 100   //! Returns in UMin,  UMax, VMin,  VMax  the  bounding
 101   //! values of the wire in the parametric space of F.
 102   Standard_EXPORT static void UVBounds (const TopoDS_Face& F, const TopoDS_Wire& W, Standard_Real& UMin, Standard_Real& UMax, Standard_Real& VMin, Standard_Real& VMax);
 103
 104   //! Returns in UMin,  UMax, VMin,  VMax  the  bounding
 105   //! values of the edge in the parametric space of F.
 106   Standard_EXPORT static void UVBounds (const TopoDS_Face& F, const TopoDS_Edge& E, Standard_Real& UMin, Standard_Real& UMax, Standard_Real& VMin, Standard_Real& VMax);
 107
 108   //! Adds  to  the box <B>  the bounding values in  the
 109   //! parametric space of F.
 110   Standard_EXPORT static void AddUVBounds (const TopoDS_Face& F, Bnd_Box2d& B);
 111
 112   //! Adds  to the box  <B>  the bounding  values of the
 113   //! wire in the parametric space of F.
 114   Standard_EXPORT static void AddUVBounds (const TopoDS_Face& F, const TopoDS_Wire& W, Bnd_Box2d& B);
 115
 116   //! Adds to  the box <B>  the  bounding values  of the
 117   //! edge in the parametric space of F.
 118   Standard_EXPORT static void AddUVBounds (const TopoDS_Face& F, const TopoDS_Edge& E, Bnd_Box2d& B);
 119
 120   //! Update a vertex (nothing is done)
 121   Standard_EXPORT static void Update (const TopoDS_Vertex& V);
 122
 123   //! Update an edge, compute 2d bounding boxes.
 124   Standard_EXPORT static void Update (const TopoDS_Edge& E);
 125
 126   //! Update a wire (nothing is done)
 127   Standard_EXPORT static void Update (const TopoDS_Wire& W);
 128
 129   //! Update a Face, update UV points.
 130   Standard_EXPORT static void Update (const TopoDS_Face& F);
 131
 132   //! Update a shell (nothing is done)
 133   Standard_EXPORT static void Update (const TopoDS_Shell& S);
 134
 135   //! Update a solid (nothing is done)
 136   Standard_EXPORT static void Update (const TopoDS_Solid& S);
 137
 138   //! Update a composite solid (nothing is done)
 139   Standard_EXPORT static void Update (const TopoDS_CompSolid& C);
 140
 141   //! Update a compound (nothing is done)
 142   Standard_EXPORT static void Update (const TopoDS_Compound& C);
 143
 144   //! Update a shape, call the corect update.
 145   Standard_EXPORT static void Update (const TopoDS_Shape& S);
 146
 147   //! For  all the edges  of the face  <F> reset  the UV
 148   //! points to  ensure that  connected  faces  have the
 149   //! same point at there common extremity.
 150   Standard_EXPORT static void UpdateFaceUVPoints (const TopoDS_Face& F);
 151
 152   //! Removes all the triangulations of the faces of <S>
 153   //! and removes all polygons on triangulations of the
 154   //! edges.
 155   Standard_EXPORT static void Clean (const TopoDS_Shape& S);
 156
 157   //! Removes all the pcurves of the edges of <S> that
 158   //! refer to surfaces not belonging to any face of <S>
 159   Standard_EXPORT static void RemoveUnusedPCurves (const TopoDS_Shape& S);
 160
 161   //! verifies that each face from the shape <S> has got
 162   //! a triangulation  with a  deflection <= deflec  and
 163   //! the edges a discretisation on  this triangulation.
 164   Standard_EXPORT static Standard_Boolean Triangulation (const TopoDS_Shape& S, const Standard_Real deflec);
 165
 166   //! Returns  True if  the    distance between the  two
 167   //! vertices is lower than their tolerance.
 168   Standard_EXPORT static Standard_Boolean Compare (const TopoDS_Vertex& V1, const TopoDS_Vertex& V2);
 169
 170   //! Returns  True if  the    distance between the  two
 171   //! edges is lower than their tolerance.
 172   Standard_EXPORT static Standard_Boolean Compare (const TopoDS_Edge& E1, const TopoDS_Edge& E2);
 173
 174   //! Returns the outer most wire of <F>. Returns a Null
 175   //! wire if <F> has no wires.
 176   Standard_EXPORT static TopoDS_Wire OuterWire (const TopoDS_Face& F);
 177
 178   //! Stores in the map  <M> all the 3D topology edges
 179   //! of <S>.
 180   Standard_EXPORT static void Map3DEdges (const TopoDS_Shape& S, TopTools_IndexedMapOfShape& M);
 181
 182   //! Verifies that the edge  <E> is found two  times on
 183   //! the face <F> before calling BRep_Tool::IsClosed.
 184   Standard_EXPORT static Standard_Boolean IsReallyClosed (const TopoDS_Edge& E, const TopoDS_Face& F);
 185
 186   //! Dumps the topological structure and the geometry
 187   //! of <Sh> on the stream <S>.
 188   Standard_EXPORT static void Dump (const TopoDS_Shape& Sh, Standard_OStream& S);
 189
 190   //! Writes <Sh> on <S> in an ASCII format.
 191   Standard_EXPORT static void Write (const TopoDS_Shape& Sh, Standard_OStream& S, const Handle(Message_ProgressIndicator)& PR = NULL);
 192
 193   //! Reads a Shape  from <S> in  returns it in  <Sh>.
 194   //! <B> is used to build the shape.
 195   Standard_EXPORT static void Read (TopoDS_Shape& Sh, Standard_IStream& S, const BRep_Builder& B, const Handle(Message_ProgressIndicator)& PR = NULL);
 196
 197   //! Writes <Sh> in <File>.
 198   Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape& Sh, const Standard_CString File, const Handle(Message_ProgressIndicator)& PR = NULL);
 199
 200   //! Reads a Shape  from <File>,  returns it in  <Sh>.
 201   //! <B> is used to build the shape.
 202   Standard_EXPORT static Standard_Boolean Read (TopoDS_Shape& Sh, const Standard_CString File, const BRep_Builder& B, const Handle(Message_ProgressIndicator)& PR = NULL);
 203
 204
 205
 206
 207 protected:
 208
 209
 210
 211
 212
 213 private:
 214
 215
 216
 217
 218 friend class BRepTools_WireExplorer;
 219 friend class BRepTools_Modification;
 220 friend class BRepTools_Modifier;
 221 friend class BRepTools_TrsfModification;
 222 friend class BRepTools_NurbsConvertModification;
 223 friend class BRepTools_GTrsfModification;
 224 friend class BRepTools_Substitution;
 225 friend class BRepTools_Quilt;
 226 friend class BRepTools_ShapeSet;
 227 friend class BRepTools_ReShape;
 228
 229 };
 230
 231
 232
 233
 234
 235
 236
 237 #endif // _BRepTools_HeaderFile