src/StdMeshers/StdMeshers_ProjectionSource2D.hxx

   1 // Copyright (C) 2007-2021  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, or (at your option) any later version.
  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 //  SMESH SMESH : idl implementation based on 'SMESH' unit's classes
  24 //  File   : StdMeshers_ProjectionSource2D.hxx
  25 //  Author : Edward AGAPOV
  26 //  Module : SMESH
  27 //
  28 #ifndef _SMESH_ProjectionSource2D_HXX_
  29 #define _SMESH_ProjectionSource2D_HXX_
  30
  31 #include "SMESH_StdMeshers.hxx"
  32
  33 #include "SMESH_Hypothesis.hxx"
  34 #include "Utils_SALOME_Exception.hxx"
  35
  36 #include <TopoDS_Vertex.hxx>
  37
  38 class SMESH_Gen;
  39
  40 // =========================================================
  41 /*!
  42  * This hypothesis specifies a meshed face to take a mesh pattern from
  43  * and optionally association of vertices between the source face and a
  44  * target one (where a hipothesis is assigned to)
  45  */
  46 // =========================================================
  47
  48 class STDMESHERS_EXPORT StdMeshers_ProjectionSource2D: public SMESH_Hypothesis
  49 {
  50 public:
  51   // Constructor
  52   StdMeshers_ProjectionSource2D( int hypId, SMESH_Gen * gen );
  53   // Destructor
  54   virtual ~StdMeshers_ProjectionSource2D();
  55
  56   /*!
  57    * Sets a source <face> to take a mesh pattern from
  58    */
  59   void SetSourceFace(const TopoDS_Shape& face);
  60
  61   /*!
  62    * Returns the source face or a group containing faces
  63    */
  64   TopoDS_Shape GetSourceFace() const;
  65
  66   /*!
  67    * Returns true the source face is a group of faces
  68    */
  69   bool IsCompoundSource() const
  70   { return !_sourceFace.IsNull() && _sourceFace.ShapeType() == TopAbs_COMPOUND; }
  71
  72   /*!
  73    * Sets source <mesh> to take a mesh pattern from
  74    */
  75   void SetSourceMesh(SMESH_Mesh* mesh);
  76
  77   /*!
  78    * Return source mesh
  79    */
  80   SMESH_Mesh* GetSourceMesh() const { return _sourceMesh; }
  81
  82   /*!
  83    * Sets vertex association between the source face and the target one.
  84    * This parameter is optional.
  85    * Two vertices must belong to one edge of a face
  86    */
  87   void SetVertexAssociation(const TopoDS_Shape& sourceVertex1,
  88                             const TopoDS_Shape& sourceVertex2,
  89                             const TopoDS_Shape& targetVertex1,
  90                             const TopoDS_Shape& targetVertex2);
  91
  92   /*!
  93    * Returns the <i>-th source vertex associated with the <i>-th target vertex.
  94    * Result may be nil if association not set.
  95    * Valid indices are 1 and 2
  96    */
  97   TopoDS_Vertex GetSourceVertex(int i) const;
  98
  99   /*!
 100    * Returns the <i>-th target vertex associated with the <i>-th source vertex.
 101    * Result may be nil if association not set.
 102    * Valid indices are 1 and 2
 103    */
 104   TopoDS_Vertex GetTargetVertex(int i) const;
 105
 106   /*!
 107    * \brief Test if vertex association defined
 108     * \retval bool - test result
 109    */
 110   bool HasVertexAssociation() const
 111   { return ( !_sourceVertex1.IsNull() && !_targetVertex1.IsNull() &&
 112              !_sourceVertex2.IsNull() && !_targetVertex2.IsNull()); }
 113
 114   /*!
 115    * \brief Return all parameters
 116    */
 117   void GetStoreParams(TopoDS_Shape& s1,
 118                       TopoDS_Shape& s2,
 119                       TopoDS_Shape& s3,
 120                       TopoDS_Shape& s4,
 121                       TopoDS_Shape& s5) const;
 122
 123   /*!
 124    * \brief Set all parameters without notifying on modification
 125    */
 126   void RestoreParams(const TopoDS_Shape& s1,
 127                      const TopoDS_Shape& s2,
 128                      const TopoDS_Shape& s3,
 129                      const TopoDS_Shape& s4,
 130                      const TopoDS_Shape& s5,
 131                      SMESH_Mesh*         mesh);
 132
 133   virtual std::ostream & SaveTo(std::ostream & save);
 134   virtual std::istream & LoadFrom(std::istream & load);
 135   friend std::ostream & operator <<(std::ostream & save, StdMeshers_ProjectionSource2D & hyp);
 136   friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource2D & hyp);
 137
 138   /*!
 139    * \brief Initialize parameters by the mesh built on the geometry
 140     * \param theMesh - the built mesh
 141     * \param theShape - the geometry of interest
 142     * \retval bool - true if parameter values have been successfully defined
 143     *
 144     * Implementation does noting
 145    */
 146   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
 147
 148   /*!
 149    * \brief Initialize my parameter values by default parameters.
 150    *  \retval bool - true if parameter values have been successfully defined
 151    */
 152   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
 153
 154 protected:
 155
 156   TopoDS_Shape  _sourceFace;
 157   SMESH_Mesh*   _sourceMesh;
 158   TopoDS_Vertex _sourceVertex1;
 159   TopoDS_Vertex _sourceVertex2;
 160   TopoDS_Vertex _targetVertex1;
 161   TopoDS_Vertex _targetVertex2;
 162 };
 163
 164 #endif
 165