1 // Copyright (C) 2007-2023 CEA, EDF, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SMESH SMESH : idl implementation based on 'SMESH' unit's classes
24 // File : StdMeshers_ProjectionSource1D.hxx
25 // Author : Edward AGAPOV
28 #ifndef _SMESH_ProjectionSource1D_HXX_
29 #define _SMESH_ProjectionSource1D_HXX_
31 #include "SMESH_StdMeshers.hxx"
33 #include "SMESH_Hypothesis.hxx"
34 #include "Utils_SALOME_Exception.hxx"
36 #include <TopoDS_Vertex.hxx>
40 // =========================================================
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)
46 // =========================================================
48 class STDMESHERS_EXPORT StdMeshers_ProjectionSource1D: public SMESH_Hypothesis
52 StdMeshers_ProjectionSource1D( int hypId, SMESH_Gen * gen );
54 virtual ~StdMeshers_ProjectionSource1D();
57 * Sets source <edge> to take a mesh pattern from
59 void SetSourceEdge(const TopoDS_Shape& edge);
62 * Returns the source edge or a group containing edges
64 TopoDS_Shape GetSourceEdge() const { return _sourceEdge; }
67 * Returns true the source edge is a group of edges
69 bool IsCompoundSource() const
70 { return !_sourceEdge.IsNull() && _sourceEdge.ShapeType() == TopAbs_COMPOUND; }
73 * Sets source <mesh> to take a mesh pattern from
75 void SetSourceMesh(SMESH_Mesh* mesh);
80 SMESH_Mesh* GetSourceMesh() const { return _sourceMesh; }
83 * Sets vertex association between the source edge and the target one.
84 * This parameter is optional
86 void SetVertexAssociation(const TopoDS_Shape& sourceVertex,
87 const TopoDS_Shape& targetVertex);
90 * Returns the vertex associated with the target vertex.
91 * Result may be nil if association not set
93 TopoDS_Vertex GetSourceVertex() const { return _sourceVertex; }
96 * Returns the vertex associated with the source vertex.
97 * Result may be nil if association not set
99 TopoDS_Vertex GetTargetVertex() const { return _targetVertex; }
102 * \brief Test if vertex association defined
103 * \retval bool - test result
105 bool HasVertexAssociation() const
106 { return ( !_sourceVertex.IsNull() && !_targetVertex.IsNull() ); }
109 * \brief Return all parameters
111 void GetStoreParams(TopoDS_Shape& s1,
113 TopoDS_Shape& s3) const;
116 * \brief Set all parameters without notifying on modification
118 void RestoreParams(const TopoDS_Shape& s1,
119 const TopoDS_Shape& s2,
120 const TopoDS_Shape& s3,
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);
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
134 * Implementation does noting
136 virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
139 * \brief Initialize my parameter values by default parameters.
140 * \retval bool - true if parameter values have been successfully defined
142 virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
146 TopoDS_Shape _sourceEdge;
147 SMESH_Mesh* _sourceMesh;
148 TopoDS_Vertex _sourceVertex;
149 TopoDS_Vertex _targetVertex;