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