1 // SMESH SMESH : idl implementation based on 'SMESH' unit's calsses
3 // Copyright (C) 2003 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.
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
24 // File : StdMeshers_ProjectionSource1D.hxx
25 // Author : Edward AGAPOV
29 #ifndef _SMESH_ProjectionSource1D_HXX_
30 #define _SMESH_ProjectionSource1D_HXX_
32 #include "SMESH_StdMeshers.hxx"
34 #include "SMESH_Hypothesis.hxx"
35 #include "Utils_SALOME_Exception.hxx"
37 #include <TopoDS_Vertex.hxx>
41 // =========================================================
43 * This hypothesis specifies a meshed edge to take a mesh pattern from
44 * and optionally association of vertices between the source edge and a
45 * target one (where a hipothesis is assigned to)
47 // =========================================================
49 class STDMESHERS_EXPORT StdMeshers_ProjectionSource1D: public SMESH_Hypothesis
53 StdMeshers_ProjectionSource1D( int hypId, int studyId, SMESH_Gen * gen );
55 virtual ~StdMeshers_ProjectionSource1D();
58 * Sets source <edge> to take a mesh pattern from
60 void SetSourceEdge(const TopoDS_Shape& edge)
61 throw ( SALOME_Exception );
64 * Returns the source edge or a group containing edges
66 TopoDS_Shape GetSourceEdge() const { return _sourceEdge; }
69 * Returns true the source edge is a group of edges
71 bool IsCompoundSource() const
72 { return !_sourceEdge.IsNull() && _sourceEdge.ShapeType() == TopAbs_COMPOUND; }
75 * Sets source <mesh> to take a mesh pattern from
77 void SetSourceMesh(SMESH_Mesh* mesh);
82 SMESH_Mesh* GetSourceMesh() const { return _sourceMesh; }
85 * Sets vertex association between the source edge and the target one.
86 * This parameter is optional
88 void SetVertexAssociation(const TopoDS_Shape& sourceVertex,
89 const TopoDS_Shape& targetVertex)
90 throw ( SALOME_Exception );
93 * Returns the vertex associated with the target vertex.
94 * Result may be nil if association not set
96 TopoDS_Vertex GetSourceVertex() const { return _sourceVertex; }
99 * Returns the vertex associated with the source vertex.
100 * Result may be nil if association not set
102 TopoDS_Vertex GetTargetVertex() const { return _targetVertex; }
105 * \brief Test if vertex association defined
106 * \retval bool - test result
108 bool HasVertexAssociation() const
109 { return ( !_sourceVertex.IsNull() && !_targetVertex.IsNull() ); }
112 * \brief Return all parameters
114 void GetStoreParams(TopoDS_Shape& s1,
116 TopoDS_Shape& s3) const;
119 * \brief Set all parameters without notifying on modification
121 void RestoreParams(const TopoDS_Shape& s1,
122 const TopoDS_Shape& s2,
123 const TopoDS_Shape& s3,
126 virtual std::ostream & SaveTo(std::ostream & save);
127 virtual std::istream & LoadFrom(std::istream & load);
128 friend std::ostream & operator <<(std::ostream & save, StdMeshers_ProjectionSource1D & hyp);
129 friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource1D & hyp);
132 * \brief Initialize parameters by the mesh built on the geometry
133 * \param theMesh - the built mesh
134 * \param theShape - the geometry of interest
135 * \retval bool - true if parameter values have been successfully defined
137 * Implementation does noting
139 virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
143 TopoDS_Shape _sourceEdge;
144 SMESH_Mesh* _sourceMesh;
145 TopoDS_Vertex _sourceVertex;
146 TopoDS_Vertex _targetVertex;