]> SALOME platform Git repositories - modules/smesh.git/blob - src/StdMeshers/StdMeshers_ProjectionSource1D.hxx
Salome HOME
0021096: EDF 1729 SMESH: Create a Projection 1D-2D algorithm
[modules/smesh.git] / src / StdMeshers / StdMeshers_ProjectionSource1D.hxx
1 // Copyright (C) 2007-2011  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
23 //  SMESH SMESH : idl implementation based on 'SMESH' unit's calsses
24 //  File   : StdMeshers_ProjectionSource1D.hxx
25 //  Author : Edward AGAPOV
26 //  Module : SMESH
27 //
28 #ifndef _SMESH_ProjectionSource1D_HXX_
29 #define _SMESH_ProjectionSource1D_HXX_
30
31 #include "SMESH_StdMeshers.hxx"
32
33 #include "SMESH_Hypothesis.hxx"
34 #include "Utils_SALOME_Exception.hxx"
35
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_EXPORT 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 or a group containing edges
64    */
65   TopoDS_Shape GetSourceEdge() const { return _sourceEdge; }
66
67   /*!
68    * Returns true the source edge is a group of edges
69    */
70   bool IsCompoundSource() const
71   { return !_sourceEdge.IsNull() && _sourceEdge.ShapeType() == TopAbs_COMPOUND; }
72
73   /*!
74    * Sets source <mesh> to take a mesh pattern from
75    */
76   void SetSourceMesh(SMESH_Mesh* mesh);
77
78   /*!
79    * Return source mesh
80    */
81   SMESH_Mesh* GetSourceMesh() const { return _sourceMesh; }
82
83   /*!
84    * Sets vertex association between the source edge and the target one.
85    * This parameter is optional
86    */
87   void SetVertexAssociation(const TopoDS_Shape& sourceVertex,
88                             const TopoDS_Shape& targetVertex)
89     throw ( SALOME_Exception );
90
91   /*!
92    * Returns the vertex associated with the target vertex.
93    * Result may be nil if association not set
94    */
95   TopoDS_Vertex GetSourceVertex() const { return _sourceVertex; }
96
97   /*!
98    * Returns the vertex associated with the source vertex.
99    * Result may be nil if association not set
100    */
101   TopoDS_Vertex GetTargetVertex() const { return _targetVertex; }
102
103   /*!
104    * \brief Test if vertex association defined
105     * \retval bool - test result
106    */
107   bool HasVertexAssociation() const
108   { return ( !_sourceVertex.IsNull() && !_targetVertex.IsNull() ); }
109
110   /*!
111    * \brief Return all parameters
112    */
113   void GetStoreParams(TopoDS_Shape& s1,
114                       TopoDS_Shape& s2,
115                       TopoDS_Shape& s3) const;
116
117   /*!
118    * \brief Set all parameters without notifying on modification
119    */
120   void RestoreParams(const TopoDS_Shape& s1,
121                      const TopoDS_Shape& s2,
122                      const TopoDS_Shape& s3,
123                      SMESH_Mesh*         mesh);
124
125   virtual std::ostream & SaveTo(std::ostream & save);
126   virtual std::istream & LoadFrom(std::istream & load);
127   friend std::ostream & operator <<(std::ostream & save, StdMeshers_ProjectionSource1D & hyp);
128   friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource1D & hyp);
129
130   /*!
131    * \brief Initialize parameters by the mesh built on the geometry
132     * \param theMesh - the built mesh
133     * \param theShape - the geometry of interest
134     * \retval bool - true if parameter values have been successfully defined
135     *
136     * Implementation does noting
137    */
138   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
139
140   /*!
141    * \brief Initialize my parameter values by default parameters.
142    *  \retval bool - true if parameter values have been successfully defined
143    */
144   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
145
146 protected:
147
148   TopoDS_Shape  _sourceEdge;
149   SMESH_Mesh*   _sourceMesh;
150   TopoDS_Vertex _sourceVertex;
151   TopoDS_Vertex _targetVertex;
152 };
153
154 #endif