src/StdMeshers/StdMeshers_ProjectionSource1D.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_ProjectionSource1D.hxx
  24 //  Author : Edward AGAPOV
  25 //  Module : SMESH
  26 //
  27 #ifndef _SMESH_ProjectionSource1D_HXX_
  28 #define _SMESH_ProjectionSource1D_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 edge to take a mesh pattern from
  42    * and optionally association of vertices between the source edge and a
  43    * target one (where a hipothesis is assigned to)
  44    */
  45 // =========================================================
  46
  47 class STDMESHERS_EXPORT StdMeshers_ProjectionSource1D: public SMESH_Hypothesis
  48 {
  49 public:
  50   // Constructor
  51   StdMeshers_ProjectionSource1D( int hypId, int studyId, SMESH_Gen * gen );
  52   // Destructor
  53   virtual ~StdMeshers_ProjectionSource1D();
  54
  55   /*!
  56    * Sets source <edge> to take a mesh pattern from
  57    */
  58   void SetSourceEdge(const TopoDS_Shape& edge)
  59     throw ( SALOME_Exception );
  60
  61   /*!
  62    * Returns the source edge or a group containing edges
  63    */
  64   TopoDS_Shape GetSourceEdge() const { return _sourceEdge; }
  65
  66   /*!
  67    * Returns true the source edge is a group of edges
  68    */
  69   bool IsCompoundSource() const
  70   { return !_sourceEdge.IsNull() && _sourceEdge.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 edge and the target one.
  84    * This parameter is optional
  85    */
  86   void SetVertexAssociation(const TopoDS_Shape& sourceVertex,
  87                             const TopoDS_Shape& targetVertex)
  88     throw ( SALOME_Exception );
  89
  90   /*!
  91    * Returns the vertex associated with the target vertex.
  92    * Result may be nil if association not set
  93    */
  94   TopoDS_Vertex GetSourceVertex() const { return _sourceVertex; }
  95
  96   /*!
  97    * Returns the vertex associated with the source vertex.
  98    * Result may be nil if association not set
  99    */
 100   TopoDS_Vertex GetTargetVertex() const { return _targetVertex; }
 101
 102   /*!
 103    * \brief Test if vertex association defined
 104     * \retval bool - test result
 105    */
 106   bool HasVertexAssociation() const
 107   { return ( !_sourceVertex.IsNull() && !_targetVertex.IsNull() ); }
 108
 109   /*!
 110    * \brief Return all parameters
 111    */
 112   void GetStoreParams(TopoDS_Shape& s1,
 113                       TopoDS_Shape& s2,
 114                       TopoDS_Shape& s3) 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                      SMESH_Mesh*         mesh);
 123
 124   virtual std::ostream & SaveTo(std::ostream & save);
 125   virtual std::istream & LoadFrom(std::istream & load);
 126   friend std::ostream & operator <<(std::ostream & save, StdMeshers_ProjectionSource1D & hyp);
 127   friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource1D & hyp);
 128
 129   /*!
 130    * \brief Initialize parameters by the mesh built on the geometry
 131     * \param theMesh - the built mesh
 132     * \param theShape - the geometry of interest
 133     * \retval bool - true if parameter values have been successfully defined
 134     *
 135     * Implementation does noting
 136    */
 137   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
 138
 139   /*!
 140    * \brief Initialize my parameter values by default parameters.
 141    *  \retval bool - true if parameter values have been successfully defined
 142    */
 143   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
 144
 145 protected:
 146
 147   TopoDS_Shape  _sourceEdge;
 148   SMESH_Mesh*   _sourceMesh;
 149   TopoDS_Vertex _sourceVertex;
 150   TopoDS_Vertex _targetVertex;
 151 };
 152
 153 #endif