]> SALOME platform Git repositories - modules/smesh.git/blob - src/StdMeshers/StdMeshers_ProjectionSource1D.hxx
Salome HOME
f8e9ff02da502a2086ff9b07535c33b3c373a7fd
[modules/smesh.git] / src / StdMeshers / StdMeshers_ProjectionSource1D.hxx
1 // Copyright (C) 2007-2023  CEA, EDF, 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, or (at your option) any later version.
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 classes
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, 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
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
89   /*!
90    * Returns the vertex associated with the target vertex.
91    * Result may be nil if association not set
92    */
93   TopoDS_Vertex GetSourceVertex() const { return _sourceVertex; }
94
95   /*!
96    * Returns the vertex associated with the source vertex.
97    * Result may be nil if association not set
98    */
99   TopoDS_Vertex GetTargetVertex() const { return _targetVertex; }
100
101   /*!
102    * \brief Test if vertex association defined
103     * \retval bool - test result
104    */
105   bool HasVertexAssociation() const
106   { return ( !_sourceVertex.IsNull() && !_targetVertex.IsNull() ); }
107
108   /*!
109    * \brief Return all parameters
110    */
111   void GetStoreParams(TopoDS_Shape& s1,
112                       TopoDS_Shape& s2,
113                       TopoDS_Shape& s3) const;
114
115   /*!
116    * \brief Set all parameters without notifying on modification
117    */
118   void RestoreParams(const TopoDS_Shape& s1,
119                      const TopoDS_Shape& s2,
120                      const TopoDS_Shape& s3,
121                      SMESH_Mesh*         mesh);
122
123   virtual std::ostream & SaveTo(std::ostream & save);
124   virtual std::istream & LoadFrom(std::istream & load);
125   friend std::ostream & operator <<(std::ostream & save, StdMeshers_ProjectionSource1D & hyp);
126   friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource1D & hyp);
127
128   /*!
129    * \brief Initialize parameters by the mesh built on the geometry
130     * \param theMesh - the built mesh
131     * \param theShape - the geometry of interest
132     * \retval bool - true if parameter values have been successfully defined
133     *
134     * Implementation does noting
135    */
136   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
137
138   /*!
139    * \brief Initialize my parameter values by default parameters.
140    *  \retval bool - true if parameter values have been successfully defined
141    */
142   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
143
144 protected:
145
146   TopoDS_Shape  _sourceEdge;
147   SMESH_Mesh*   _sourceMesh;
148   TopoDS_Vertex _sourceVertex;
149   TopoDS_Vertex _targetVertex;
150 };
151
152 #endif