]> SALOME platform Git repositories - modules/smesh.git/blob - src/StdMeshers/StdMeshers_ProjectionSource2D.hxx
Salome HOME
0021825: Error in the example of "Projection Algorithms" in the user's guide
[modules/smesh.git] / src / StdMeshers / StdMeshers_ProjectionSource2D.hxx
1 // Copyright (C) 2007-2012  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_ProjectionSource2D.hxx
25 //  Author : Edward AGAPOV
26 //  Module : SMESH
27 //
28 #ifndef _SMESH_ProjectionSource2D_HXX_
29 #define _SMESH_ProjectionSource2D_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 face to take a mesh pattern from
43  * and optionally association of vertices between the source face and a
44  * target one (where a hipothesis is assigned to)
45  */
46 // =========================================================
47
48 class STDMESHERS_EXPORT StdMeshers_ProjectionSource2D: public SMESH_Hypothesis
49 {
50 public:
51   // Constructor
52   StdMeshers_ProjectionSource2D( int hypId, int studyId, SMESH_Gen * gen );
53   // Destructor
54   virtual ~StdMeshers_ProjectionSource2D();
55
56   /*!
57    * Sets a source <face> to take a mesh pattern from
58    */
59   void SetSourceFace(const TopoDS_Shape& face)
60     throw ( SALOME_Exception );
61
62   /*!
63    * Returns the source face or a group containing faces
64    */
65   TopoDS_Shape GetSourceFace() const;
66
67   /*!
68    * Returns true the source face is a group of faces
69    */
70   bool IsCompoundSource() const
71   { return !_sourceFace.IsNull() && _sourceFace.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 face and the target one.
85    * This parameter is optional.
86    * Two vertices must belong to one edge of a face
87    */
88   void SetVertexAssociation(const TopoDS_Shape& sourceVertex1,
89                             const TopoDS_Shape& sourceVertex2,
90                             const TopoDS_Shape& targetVertex1,
91                             const TopoDS_Shape& targetVertex2)
92     throw ( SALOME_Exception );
93
94   /*!
95    * Returns the <i>-th source vertex associated with the <i>-th target vertex.
96    * Result may be nil if association not set.
97    * Valid indices are 1 and 2
98    */
99   TopoDS_Vertex GetSourceVertex(int i) const throw ( SALOME_Exception );
100
101   /*!
102    * Returns the <i>-th target vertex associated with the <i>-th source vertex.
103    * Result may be nil if association not set.
104    * Valid indices are 1 and 2
105    */
106   TopoDS_Vertex GetTargetVertex(int i) const throw ( SALOME_Exception );
107
108   /*!
109    * \brief Test if vertex association defined
110     * \retval bool - test result
111    */
112   bool HasVertexAssociation() const
113   { return ( !_sourceVertex1.IsNull() && !_targetVertex1.IsNull() &&
114              !_sourceVertex2.IsNull() && !_targetVertex2.IsNull()); }
115
116   /*!
117    * \brief Return all parameters
118    */
119   void GetStoreParams(TopoDS_Shape& s1,
120                       TopoDS_Shape& s2,
121                       TopoDS_Shape& s3,
122                       TopoDS_Shape& s4,
123                       TopoDS_Shape& s5) const;
124
125   /*!
126    * \brief Set all parameters without notifying on modification
127    */
128   void RestoreParams(const TopoDS_Shape& s1,
129                      const TopoDS_Shape& s2,
130                      const TopoDS_Shape& s3,
131                      const TopoDS_Shape& s4,
132                      const TopoDS_Shape& s5,
133                      SMESH_Mesh*         mesh);
134
135   virtual std::ostream & SaveTo(std::ostream & save);
136   virtual std::istream & LoadFrom(std::istream & load);
137   friend std::ostream & operator <<(std::ostream & save, StdMeshers_ProjectionSource2D & hyp);
138   friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource2D & hyp);
139
140   /*!
141    * \brief Initialize parameters by the mesh built on the geometry
142     * \param theMesh - the built mesh
143     * \param theShape - the geometry of interest
144     * \retval bool - true if parameter values have been successfully defined
145     *
146     * Implementation does noting
147    */
148   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
149
150   /*!
151    * \brief Initialize my parameter values by default parameters.
152    *  \retval bool - true if parameter values have been successfully defined
153    */
154   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
155
156 protected:
157
158   TopoDS_Shape  _sourceFace;
159   SMESH_Mesh*   _sourceMesh;
160   TopoDS_Vertex _sourceVertex1;
161   TopoDS_Vertex _sourceVertex2;
162   TopoDS_Vertex _targetVertex1;
163   TopoDS_Vertex _targetVertex2;
164 };
165
166 #endif
167