]> SALOME platform Git repositories - modules/smesh.git/blob - src/StdMeshers/StdMeshers_ProjectionSource3D.hxx
Salome HOME
0022106: EDF 2464 SMESH : Split quadrangles in 4 triangles
[modules/smesh.git] / src / StdMeshers / StdMeshers_ProjectionSource3D.hxx
1 // Copyright (C) 2007-2013  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_ProjectionSource3D.hxx
25 //  Author : Edward AGAPOV
26 //  Module : SMESH
27 //
28 #ifndef _SMESH_ProjectionSource3D_HXX_
29 #define _SMESH_ProjectionSource3D_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 shell or solid to take a mesh pattern from
43  * and optionally association of vertices between the source shape and a
44  * target one (where a hipothesis is assigned to)
45  */
46 // =========================================================
47
48 class STDMESHERS_EXPORT StdMeshers_ProjectionSource3D:  public SMESH_Hypothesis
49 {
50 public:
51   // Constructor
52   StdMeshers_ProjectionSource3D( int hypId, int studyId, SMESH_Gen * gen );
53   // Destructor
54   virtual ~StdMeshers_ProjectionSource3D();
55
56   /*!
57    * Sets a source <shape> to take a mesh pattern from
58    */
59   void SetSource3DShape(const TopoDS_Shape& shape)
60     throw ( SALOME_Exception );
61
62   /*!
63    * Returns the source shape
64    */
65   TopoDS_Shape GetSource3DShape() const;
66
67   /*!
68    * Sets source <mesh> to take a mesh pattern from
69    */
70   void SetSourceMesh(SMESH_Mesh* mesh);
71
72   /*!
73    * Return source mesh
74    */
75   SMESH_Mesh* GetSourceMesh() const { return _sourceMesh; }
76
77   /*!
78    * Sets vertex association between the source shape and the target one.
79    * This parameter is optional.
80    * Two vertices must belong to one edge of a shape
81    */
82   void SetVertexAssociation(const TopoDS_Shape& sourceVertex1,
83                             const TopoDS_Shape& sourceVertex2,
84                             const TopoDS_Shape& targetVertex1,
85                             const TopoDS_Shape& targetVertex2)
86     throw ( SALOME_Exception );
87
88   /*!
89    * Returns the <i>-th source vertex associated with the <i>-th target vertex.
90    * Result may be nil if association not set.
91    */
92   TopoDS_Vertex GetSourceVertex(int i) const throw ( SALOME_Exception );
93
94   /*!
95    * Returns the <i>-th target vertex associated with the <i>-th source vertex.
96    * Result may be nil if association not set.
97    */
98   TopoDS_Vertex GetTargetVertex(int i) const throw ( SALOME_Exception );
99
100   /*!
101    * \brief Test if vertex association defined
102     * \retval bool - test result
103    */
104   bool HasVertexAssociation() const
105   { return ( !_sourceVertex1.IsNull() && !_targetVertex1.IsNull() &&
106              !_sourceVertex2.IsNull() && !_targetVertex2.IsNull()); }
107
108   /*!
109    * \brief Return all parameters
110    */
111   void GetStoreParams(TopoDS_Shape& s1,
112                       TopoDS_Shape& s2,
113                       TopoDS_Shape& s3,
114                       TopoDS_Shape& s4,
115                       TopoDS_Shape& s5) 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                      const TopoDS_Shape& s4,
124                      const TopoDS_Shape& s5,
125                      SMESH_Mesh*         mesh);
126
127   virtual std::ostream & SaveTo(std::ostream & save);
128   virtual std::istream & LoadFrom(std::istream & load);
129   friend std::ostream & operator <<(std::ostream & save, StdMeshers_ProjectionSource3D & hyp);
130   friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource3D & hyp);
131
132   /*!
133    * \brief Initialize parameters by the mesh built on the geometry
134     * \param theMesh - the built mesh
135     * \param theShape - the geometry of interest
136     * \retval bool - true if parameter values have been successfully defined
137     *
138     * Implementation does noting
139    */
140   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
141
142   /*!
143    * \brief Initialize my parameter values by default parameters.
144    *  \retval bool - true if parameter values have been successfully defined
145    */
146   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
147
148 protected:
149
150   TopoDS_Shape  _sourceShape;
151   SMESH_Mesh*   _sourceMesh;
152   TopoDS_Vertex _sourceVertex1;
153   TopoDS_Vertex _sourceVertex2;
154   TopoDS_Vertex _targetVertex1;
155   TopoDS_Vertex _targetVertex2;
156
157 };
158
159 #endif
160