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