src/GEOMImpl/GEOMImpl_Block6Explorer.hxx

   1 //  Copyright (C) 2007-2010  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  File   : GEOMImpl_Block6Explorer.hxx
  24 //  Module : GEOMImpl
  25 //
  26 #ifndef GEOMImpl_Block6Explorer_HeaderFile
  27 #define GEOMImpl_Block6Explorer_HeaderFile
  28
  29 #include <TopoDS_Shape.hxx>
  30 #include <TopoDS_Wire.hxx>
  31 #include <TopTools_Array1OfShape.hxx>
  32 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
  33 #include <gp_Trsf.hxx>
  34
  35   //  Class GEOMImpl_Block6Explorer gives easy and fast access to a certain sub-elements of hexahedral solid
  36   //  Each face   can be accessed by its global ID [1-6]
  37   //  Each edge   can be accessed by its global ID [1-12] or by its local NB [1-4] inside certain face
  38   //  Each vertex can be accessed by its global ID [1-8] or  by its local NB [1-4] inside certain face
  39   //  Numeration of the sub-shapes is defined in constructors, see they comments
  40   //
  41   //                  face 2       face 4          |           4 face     2 face                   |
  42   //                       |           /           |            \         |                        |
  43   //                      \|/        |/_           |            _\|      \|/                       |
  44   //                       '         '             |              '       '                        |
  45   //                    8_______7__7               |               7__7_______8                    |
  46   //                   /|         /|               |               |\         |\                   |
  47   //                  8 12       6 11              |              11 6       12 8                  |
  48   //                 /  |       /  |               |               |  \       |  \                 |
  49   //               5/______5__6/   |               |               |   \6__5______\5               |
  50   //  face 5 --->  |    |     |    |  <--- 6 face  |  face 6 --->  |    |     |    |  <--- 5 face  |
  51   //               |    |__3__|____|               |               |____|__3__|    |               |
  52   //               |   /4     |   /3               |               3\   |     4\   |               |
  53   //               |  /       |  /                 |                 \  |       \  |               |
  54   //               9 4       10 2                  |                  2 10       4 9               |
  55   //               |/__1______|/                   |                   \|______1__\|               |
  56   //               1          2                    |                    2          1               |
  57   //            _.        .                        |                        .       ._             |
  58   //            /|       /|\                       |                       /|\      |\             |
  59   //           /          |                        |                        |         \            |
  60   //          3 face      1 face                   |                   face 1     face 3           |
  61   //                                               |                                               |
  62   //  Picture 1 (right orientation)                |  Picture 2 (left orientation)                 |
  63   //                                                                                               |
  64   //  For the moment, the orientation of numbering is not controlled
  65
  66   // Faces: 1 - bottom, 2 - top, 3 - front, 4 - back, 5 - left (right), 6 - right (left)
  67
  68   //
  69   //                             4_______3__3         2 ______2__3
  70   //                            /          /          |          |
  71   //                           4          2           1          3
  72   //                          /          /            |          |
  73   //                        1/______1__2/             |          |
  74   //                                                  |          |
  75   //                                                  | __4______|
  76   //                           face 2       face 4    1          4
  77   //                                |           /
  78   //                               \|/        |/_
  79   //                                '         '
  80   //        3                    8_______7__7                    3
  81   //       /|                   /|         /|                   /|
  82   //      3 2                  8 12       6 11                 3 2
  83   //     /  |                 /  |       /  |                 /  |
  84   //   4/   |               5/______5__6/   |               4/   |
  85   //   |    |  face 5 --->  |    |     |    |  <--- 6 face  |    |
  86   //   |    |               |    |__3__|____|               |    |
  87   //   |   /2               |   /4     |   /3               |   /2
  88   //   |  /                 |  /       |  /                 |  /
  89   //   4 1                  9 4       10 2                  4 1
  90   //   |/                   |/__1______|/                   |/
  91   //   1                    1          2                    1
  92   //                     _.        .
  93   //                     /|       /|\
  94   //                    /          |
  95   //   2 ______2__3    3 face      1 face
  96   //   |          |
  97   //   |          |               __3_______
  98   //   |          |             /4         /3
  99   //   |          |            /          /
 100   //   1          3           4          2
 101   //   | __4______|          /__1______ /
 102   //   1          4         1          2
 103   //
 104   //  Picture 3 (On periferal pictures the local
 105   //  numeration of edges and vertices is shown)
 106
 107 class GEOMImpl_Block6Explorer
 108 {
 109  public:
 110   // ---------- PUBLIC METHODS ----------
 111
 112   GEOMImpl_Block6Explorer ();
 113   // Constructor.
 114
 115   // Initialization by existing solid,
 116   // sub-elements regulate numeration
 117
 118   void InitByBlock (const TopoDS_Shape& theBlock);
 119   // Init by hexahedral solid. First face, edge and vertex is defined randomly
 120
 121   void InitByBlockAndFace (const TopoDS_Shape& theBlock,
 122                            const TopoDS_Shape& theFace);
 123   // Constructor from hexahedral solid, making theFace the first face.
 124   // First edge and vertex is defined randomly from theFace entities
 125
 126   void InitByBlockAndEdges (const TopoDS_Shape& theBlock,
 127                             const TopoDS_Shape& theEdge1,
 128                             const TopoDS_Shape& theEdge2);
 129   // Init by hexahedral solid, making theEdge1 the first, theEdge2 the fird.
 130   // First vertex is defined randomly from theEdge1 vertices
 131   // (Picture 1 and Picture 2 shows two possible cases)
 132
 133   void InitByBlockAndVertices (const TopoDS_Shape& theBlock,
 134                                const TopoDS_Shape& theVertex1,
 135                                const TopoDS_Shape& theVertex2,
 136                                const TopoDS_Shape& theVertex3);
 137   // Init by hexahedral solid, making theVertex1 the first,
 138   // theVertex2 the second and theVertex3 the fird vertices.
 139
 140   // Initialization by parts of solid to be built
 141
 142   void InitByTwoFaces (const TopoDS_Shape& theFace1,
 143                        const TopoDS_Shape& theFace2);
 144   // Init by two faces. TheFace1 will be the first,
 145   // theFace2 will be the second.
 146   // First edge and vertex is defined randomly from theFace1 entities.
 147
 148   // Access to vertices
 149   TopoDS_Shape GetVertex (const Standard_Integer theVertexID); // [1-8]
 150
 151   Standard_Integer GetVertexID (const TopoDS_Shape& theVertex);
 152
 153   Standard_Integer GetVertexID (const Standard_Integer theFaceID, // [1-6]
 154                                 const Standard_Integer theVertexNB); // [1-4]
 155
 156   Standard_Integer GetVertexOnEdgeID (const Standard_Integer theEdgeID, // [1-12]
 157                                       const Standard_Integer theVertexNB); // [1-2]
 158
 159   // Access to edges
 160   TopoDS_Shape GetEdge (const Standard_Integer theEdgeID, // [1-12]
 161                         const Standard_Boolean doMake = Standard_False);
 162
 163   Standard_Integer GetEdgeID (const TopoDS_Shape& theEdge);
 164
 165   Standard_Integer GetEdgeID (const Standard_Integer theFaceID, // [1-6]
 166                               const Standard_Integer theEdgeNB); // [1-4]
 167
 168   Standard_Integer FindEdgeID (const Standard_Integer theVertex1ID,
 169                                const Standard_Integer theVertex2ID);
 170
 171   Standard_Integer FindCommonEdgeID (const Standard_Integer theFace1ID,
 172                                      const Standard_Integer theFace2ID);
 173
 174   // Access to faces
 175   TopoDS_Shape GetFace (const Standard_Integer theFaceID, // [1-6]
 176                         const Standard_Boolean doMake = Standard_False);
 177
 178   Standard_Integer GetFaceID (const TopoDS_Shape& theFace);
 179
 180   Standard_Integer FindFaceID (const Standard_Integer theEdge1ID,
 181                                const Standard_Integer theEdge2ID);
 182
 183   Standard_Integer GetOppositeFaceID (const Standard_Integer theFaceID);
 184
 185   // Check Block
 186   Standard_Boolean IsSimilarFaces (const Standard_Integer theFace1ID,
 187                                    const Standard_Integer theFace2ID,
 188                                    const gp_Trsf          theTransformation);
 189   // returns true, if theFace1, transformed
 190   // by theTransformation, coincides with theFace2
 191  public:
 192   // ---------- STATIC PUBLIC METHODS ----------
 193   static void MapShapesAndAncestors (const TopoDS_Shape& S,
 194                                      const TopAbs_ShapeEnum TS,
 195                                      const TopAbs_ShapeEnum TA,
 196                                      TopTools_IndexedDataMapOfShapeListOfShape& M);
 197
 198   static Standard_Boolean IsSimilarEdges (const TopoDS_Shape& E1,
 199                                           const TopoDS_Shape& E2);
 200
 201   static Standard_Integer FindEdge (TopoDS_Shape&       theResult,
 202                                     const TopoDS_Shape& V1,
 203                                     const TopoDS_Shape& V2,
 204                                     const TopTools_IndexedDataMapOfShapeListOfShape& MVE,
 205                                     const Standard_Boolean findAll = Standard_False);
 206   // returns number of found edges
 207
 208   static Standard_Integer FindFace (TopoDS_Shape&       theResult,
 209                                     const TopoDS_Shape& V1,
 210                                     const TopoDS_Shape& V2,
 211                                     const TopoDS_Shape& V3,
 212                                     const TopoDS_Shape& V4,
 213                                     const TopTools_IndexedDataMapOfShapeListOfShape& MVF,
 214                                     const Standard_Boolean findAll = Standard_False);
 215   // returns number of found faces
 216
 217   static void MakeFace (const TopoDS_Wire&     theWire,
 218                         const Standard_Boolean isPlanarWanted,
 219                         TopoDS_Shape&          theResult);
 220
 221  private:
 222   // ---------- PRIVATE FIELDS ----------
 223
 224   TopTools_Array1OfShape myFaces;
 225   TopTools_Array1OfShape myEdges;
 226   TopTools_Array1OfShape myVertices;
 227 };
 228
 229 #endif