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_ProjectionSource3D.hxx
25 // Author : Edward AGAPOV
29 #ifndef _SMESH_ProjectionSource3D_HXX_
30 #define _SMESH_ProjectionSource3D_HXX_
32 #include "SMESH_Hypothesis.hxx"
33 #include "Utils_SALOME_Exception.hxx"
35 #include <TopoDS_Vertex.hxx>
39 // =========================================================
41 * This hypothesis specifies a meshed shell or solid to take a mesh pattern from
42 * and optionally association of vertices between the source shape and a
43 * target one (where a hipothesis is assigned to)
45 // =========================================================
47 class StdMeshers_ProjectionSource3D: public SMESH_Hypothesis
51 StdMeshers_ProjectionSource3D( int hypId, int studyId, SMESH_Gen * gen );
53 virtual ~StdMeshers_ProjectionSource3D();
56 * Sets a source <shape> to take a mesh pattern from
58 void SetSource3DShape(const TopoDS_Shape& shape)
59 throw ( SALOME_Exception );
62 * Returns the source shape
64 TopoDS_Shape GetSource3DShape() const;
67 * Sets source <mesh> to take a mesh pattern from
69 void SetSourceMesh(SMESH_Mesh* mesh);
74 SMESH_Mesh* GetSourceMesh() const { return _sourceMesh; }
77 * Sets vertex association between the source shape and the target one.
78 * This parameter is optional.
79 * Two vertices must belong to one edge of a shape
81 void SetVertexAssociation(const TopoDS_Shape& sourceVertex1,
82 const TopoDS_Shape& sourceVertex2,
83 const TopoDS_Shape& targetVertex1,
84 const TopoDS_Shape& targetVertex2)
85 throw ( SALOME_Exception );
88 * Returns the <i>-th source vertex associated with the <i>-th target vertex.
89 * Result may be nil if association not set.
91 TopoDS_Vertex GetSourceVertex(int i) const throw ( SALOME_Exception );
94 * Returns the <i>-th target vertex associated with the <i>-th source vertex.
95 * Result may be nil if association not set.
97 TopoDS_Vertex GetTargetVertex(int i) const throw ( SALOME_Exception );
100 * \brief Test if vertex association defined
101 * \retval bool - test result
103 bool HasVertexAssociation() const
104 { return ( !_sourceVertex1.IsNull() && !_targetVertex1.IsNull() &&
105 !_sourceVertex2.IsNull() && !_targetVertex2.IsNull()); }
108 * \brief Return all parameters
110 void GetStoreParams(TopoDS_Shape& s1,
114 TopoDS_Shape& s5) 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,
122 const TopoDS_Shape& s4,
123 const TopoDS_Shape& s5,
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_ProjectionSource3D & hyp);
129 friend std::istream & operator >>(std::istream & load, StdMeshers_ProjectionSource3D & 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 _sourceShape;
144 SMESH_Mesh* _sourceMesh;
145 TopoDS_Vertex _sourceVertex1;
146 TopoDS_Vertex _sourceVertex2;
147 TopoDS_Vertex _targetVertex1;
148 TopoDS_Vertex _targetVertex2;