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