src/StdMeshers/StdMeshers_ProjectionSource1D.hxx

   1 //  SMESH SMESH : idl implementation based on 'SMESH' unit's calsses
   2 //
   3 //  Copyright (C) 2003  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 //
  24 //  File   : StdMeshers_ProjectionSource1D.hxx
  25 //  Author : Edward AGAPOV
  26 //  Module : SMESH
  27 //  $Header$
  28
  29 #ifndef _SMESH_ProjectionSource1D_HXX_
  30 #define _SMESH_ProjectionSource1D_HXX_
  31
  32 #include "SMESH_StdMeshers.hxx"
  33
  34 #include "SMESH_Hypothesis.hxx"
  35 #include "Utils_SALOME_Exception.hxx"
  36
  37 #include <TopoDS_Edge.hxx>
  38 #include <TopoDS_Vertex.hxx>
  39
  40 class SMESH_Gen;
  41
  42 // =========================================================
  43   /*!
  44    * This hypothesis specifies a meshed edge to take a mesh pattern from
  45    * and optionally association of vertices between the source edge and a
  46    * target one (where a hipothesis is assigned to)
  47    */
  48 // =========================================================
  49
  50 class STDMESHERS_EXPORT StdMeshers_ProjectionSource1D: public SMESH_Hypothesis
  51 {
  52 public:
  53   // Constructor
  54   StdMeshers_ProjectionSource1D( int hypId, int studyId, SMESH_Gen * gen );
  55   // Destructor
  56   virtual ~StdMeshers_ProjectionSource1D();
  57
  58   /*!
  59    * Sets source <edge> to take a mesh pattern from
  60    */
  61   void SetSourceEdge(const TopoDS_Shape& edge)
  62     throw ( SALOME_Exception );
  63
  64   /*!
  65    * Returns the source edge
  66    */
  67   TopoDS_Edge GetSourceEdge() const { return _sourceEdge; }
  68
  69   /*!
  70    * Sets source <mesh> to take a mesh pattern from
  71    */
  72   void SetSourceMesh(SMESH_Mesh* mesh);
  73
  74   /*!
  75    * Return source mesh
  76    */
  77   SMESH_Mesh* GetSourceMesh() const { return _sourceMesh; }
  78
  79   /*!
  80    * Sets vertex association between the source edge and the target one.
  81    * This parameter is optional
  82    */
  83   void SetVertexAssociation(const TopoDS_Shape& sourceVertex,
  84                             const TopoDS_Shape& targetVertex)
  85     throw ( SALOME_Exception );
  86
  87   /*!
  88    * Returns the vertex associated with the target vertex.
  89    * Result may be nil if association not set
  90    */
  91   TopoDS_Vertex GetSourceVertex() const { return _sourceVertex; }
  92
  93   /*!
  94    * Returns the vertex associated with the source vertex.
  95    * Result may be nil if association not set
  96    */
  97   TopoDS_Vertex GetTargetVertex() const { return _targetVertex; }
  98
  99   /*!
 100    * \brief Test if vertex association defined
 101     * \retval bool - test result
 102    */
 103   bool HasVertexAssociation() const
 104   { return ( !_sourceVertex.IsNull() && !_targetVertex.IsNull() ); }
 105
 106   /*!
 107    * \brief Return all parameters
 108    */
 109   void GetStoreParams(TopoDS_Shape& s1,
 110                       TopoDS_Shape& s2,
 111                       TopoDS_Shape& s3) const;
 112
 113   /*!
 114    * \brief Set all parameters without notifying on modification
 115    */
 116   void RestoreParams(const TopoDS_Shape& s1,
 117                      const TopoDS_Shape& s2,
 118                      const TopoDS_Shape& s3,
 119                      SMESH_Mesh*         mesh);
 120
 121   virtual std::ostream & SaveTo(std::ostream & save);
 122   virtual std::istream & LoadFrom(std::istream & load);
 123   friend std::ostream & operator <<(std::ostream & save, StdMeshers_ProjectionSource1D & hyp);
 124   friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource1D & hyp);
 125
 126   /*!
 127    * \brief Initialize parameters by the mesh built on the geometry
 128     * \param theMesh - the built mesh
 129     * \param theShape - the geometry of interest
 130     * \retval bool - true if parameter values have been successfully defined
 131     *
 132     * Implementation does noting
 133    */
 134   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
 135
 136 protected:
 137
 138   TopoDS_Edge   _sourceEdge;
 139   SMESH_Mesh*   _sourceMesh;
 140   TopoDS_Vertex _sourceVertex;
 141   TopoDS_Vertex _targetVertex;
 142 };
 143
 144 #endif