src/StdMeshers/StdMeshers_ProjectionSource3D.hxx

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