src/StdMeshers/StdMeshers_ProjectionSource2D.hxx

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