Salome HOME
Copyright update: 2016
[modules/smesh.git] / src / StdMeshers_I / StdMeshers_ProjectionSource3D_i.hxx
1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, 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_I : idl implementation based on 'SMESH' unit's calsses
24 //  File   : StdMeshers_ProjectionSource3D_i.hxx
25 //  Author : Edward AGAPOV
26 //  Module : SMESH
27 //  $Header$
28 //
29 #ifndef _SMESH_ProjectionSource3D_I_HXX_
30 #define _SMESH_ProjectionSource3D_I_HXX_
31
32 #include <SALOMEconfig.h>
33 #include CORBA_SERVER_HEADER(SMESH_BasicHypothesis)
34 #include CORBA_SERVER_HEADER(SMESH_Mesh)
35
36 #include "SMESH_Hypothesis_i.hxx"
37 #include "StdMeshers_ProjectionSource3D.hxx"
38
39 class SMESH_Gen;
40
41 // =========================================================
42 /*!
43  * This hypothesis specifies a meshed shell or solid to take a mesh pattern from
44  * and optionally association of vertices between the source shape and a
45  * target one (where a hipothesis is assigned to)
46  */
47 // =========================================================
48
49 class StdMeshers_ProjectionSource3D_i:
50   public virtual POA_StdMeshers::StdMeshers_ProjectionSource3D,
51   public virtual SMESH_Hypothesis_i
52 {
53 public:
54   // Constructor
55   StdMeshers_ProjectionSource3D_i( PortableServer::POA_ptr thePOA,
56                                    int                     theStudyId,
57                                    ::SMESH_Gen*            theGenImpl );
58   // Destructor
59   virtual ~StdMeshers_ProjectionSource3D_i();
60
61   /*!
62    * Sets a source <shape> to take a mesh pattern from
63    */
64   void SetSource3DShape(GEOM::GEOM_Object_ptr shape)
65     throw ( SALOME::SALOME_Exception );
66
67   /*!
68    * Returns the source shape
69    */
70   GEOM::GEOM_Object_ptr GetSource3DShape();
71
72   /*!
73    * Sets source <mesh> to take a mesh pattern from
74    */
75   void SetSourceMesh(SMESH::SMESH_Mesh_ptr mesh)
76     throw ( SALOME::SALOME_Exception );
77
78   /*!
79    * Return source mesh
80    */
81   SMESH::SMESH_Mesh_ptr GetSourceMesh();
82
83   /*!
84    * Sets vertex association between the source shape and the target one.
85    * This parameter is optional.
86    * Two vertices must belong to one edge of a shape
87    */
88   void SetVertexAssociation(GEOM::GEOM_Object_ptr sourceVertex1,
89                             GEOM::GEOM_Object_ptr sourceVertex2,
90                             GEOM::GEOM_Object_ptr targetVertex1,
91                             GEOM::GEOM_Object_ptr targetVertex2)
92     throw ( SALOME::SALOME_Exception );
93
94   /*!
95    * Returns the <i>-th source vertex associated with the <i>-th target vertex.
96    * Result may be nil if association not set.
97    * Valid indices are 1 and 2
98    */
99   GEOM::GEOM_Object_ptr GetSourceVertex(CORBA::Long i);
100
101   /*!
102    * Returns the <i>-th target vertex associated with the <i>-th source vertex.
103    * Result may be nil if association not set.
104    */
105   GEOM::GEOM_Object_ptr GetTargetVertex(CORBA::Long i);
106
107   // Get implementation
108   ::StdMeshers_ProjectionSource3D* GetImpl();
109
110   // Verify whether hypothesis supports given entity type 
111   CORBA::Boolean IsDimSupported( SMESH::Dimension type );
112
113
114   // Redefined Persistence
115   virtual char* SaveTo();
116   virtual void  LoadFrom( const char* theStream );
117
118 private:
119   // keep entries because the same shape can be published several times with
120   // different names and in this case a correct name can't be restored by a TopoDS_Shape
121   // kept by ::StdMeshers_ProjectionSource3D
122   enum { SRC_SHAPE3D=0, SRC_VERTEX1, SRC_VERTEX2, TGT_VERTEX1, TGT_VERTEX2, NB_SHAPES };
123   std::string           myShapeEntries[NB_SHAPES];
124   SMESH::SMESH_Mesh_var myCorbaMesh;
125 };
126
127 #endif
128