1 // Copyright (C) 2007-2008 CEA/DEN, EDF R&D, 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.
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
22 // SMESH SMESH : idl implementation based on 'SMESH' unit's calsses
23 // File : StdMeshers_ProjectionSource1D.hxx
24 // Author : Edward AGAPOV
27 #ifndef _SMESH_ProjectionSource1D_HXX_
28 #define _SMESH_ProjectionSource1D_HXX_
30 #include "SMESH_StdMeshers.hxx"
32 #include "SMESH_Hypothesis.hxx"
33 #include "Utils_SALOME_Exception.hxx"
35 #include <TopoDS_Vertex.hxx>
39 // =========================================================
41 * This hypothesis specifies a meshed edge to take a mesh pattern from
42 * and optionally association of vertices between the source edge and a
43 * target one (where a hipothesis is assigned to)
45 // =========================================================
47 class STDMESHERS_EXPORT StdMeshers_ProjectionSource1D: public SMESH_Hypothesis
51 StdMeshers_ProjectionSource1D( int hypId, int studyId, SMESH_Gen * gen );
53 virtual ~StdMeshers_ProjectionSource1D();
56 * Sets source <edge> to take a mesh pattern from
58 void SetSourceEdge(const TopoDS_Shape& edge)
59 throw ( SALOME_Exception );
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)
88 throw ( SALOME_Exception );
91 * Returns the vertex associated with the target vertex.
92 * Result may be nil if association not set
94 TopoDS_Vertex GetSourceVertex() const { return _sourceVertex; }
97 * Returns the vertex associated with the source vertex.
98 * Result may be nil if association not set
100 TopoDS_Vertex GetTargetVertex() const { return _targetVertex; }
103 * \brief Test if vertex association defined
104 * \retval bool - test result
106 bool HasVertexAssociation() const
107 { return ( !_sourceVertex.IsNull() && !_targetVertex.IsNull() ); }
110 * \brief Return all parameters
112 void GetStoreParams(TopoDS_Shape& s1,
114 TopoDS_Shape& s3) const;
117 * \brief Set all parameters without notifying on modification
119 void RestoreParams(const TopoDS_Shape& s1,
120 const TopoDS_Shape& s2,
121 const TopoDS_Shape& s3,
124 virtual std::ostream & SaveTo(std::ostream & save);
125 virtual std::istream & LoadFrom(std::istream & load);
126 friend std::ostream & operator <<(std::ostream & save, StdMeshers_ProjectionSource1D & hyp);
127 friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource1D & hyp);
130 * \brief Initialize parameters by the mesh built on the geometry
131 * \param theMesh - the built mesh
132 * \param theShape - the geometry of interest
133 * \retval bool - true if parameter values have been successfully defined
135 * Implementation does noting
137 virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
140 * \brief Initialize my parameter values by linear size of mesh element.
141 * \retval bool - true if parameter values have been successfully defined
143 virtual bool SetParametersByElementSize( double elemLenght, const SMESH_Mesh* theMesh=0);
147 TopoDS_Shape _sourceEdge;
148 SMESH_Mesh* _sourceMesh;
149 TopoDS_Vertex _sourceVertex;
150 TopoDS_Vertex _targetVertex;