Salome HOME
Merge from V6_main_20120808 08Aug12
[modules/smesh.git] / src / OBJECT / SMESH_Object.h
1 // Copyright (C) 2007-2012  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.
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 OBJECT : interactive object for SMESH visualization
24 //  File   : SMESH_Object.h
25 //  Author : Nicolas REJNERI
26 //  Module : SMESH
27 //  $Header$
28 //
29 #ifndef SMESH_OBJECT_H
30 #define SMESH_OBJECT_H
31
32 #ifdef WNT
33  #if defined SMESHOBJECT_EXPORTS || defined SMESHObject_EXPORTS
34   #define SMESHOBJECT_EXPORT __declspec( dllexport )
35  #else
36   #define SMESHOBJECT_EXPORT __declspec( dllimport )
37  #endif
38 #else
39  #define SMESHOBJECT_EXPORT
40 #endif
41
42 #include <boost/shared_ptr.hpp>
43 #include <vtkSystemIncludes.h>
44
45 #include "SMESH_Controls.hxx"
46 #include "SMDSAbs_ElementType.hxx"
47
48 class SMDS_Mesh;
49 class vtkUnstructuredGrid;
50
51 /*
52   Class       : SMESH_VisualObj
53   Description : Base class for all mesh objects to be visuilised
54 */
55 class SMESHOBJECT_EXPORT SMESH_VisualObj
56 {
57 public:
58   virtual bool Update( int theIsClear = true ) = 0;
59   virtual bool NulData() = 0;
60   virtual void UpdateFunctor( const SMESH::Controls::FunctorPtr& theFunctor ) = 0;
61   virtual int GetElemDimension( const int theObjId ) = 0;
62
63   virtual int GetNbEntities( const SMDSAbs_ElementType theType) const = 0;
64   virtual SMDS_Mesh* GetMesh() const = 0;
65
66   virtual bool GetEdgeNodes( const int theElemId,
67                              const int theEdgeNum,
68                              int&      theNodeId1,
69                              int&      theNodeId2 ) const = 0;
70   virtual bool              IsValid() const = 0;
71   
72   virtual vtkUnstructuredGrid* GetUnstructuredGrid() = 0;
73   
74   virtual vtkIdType GetNodeObjId( int theVTKID ) = 0;
75   virtual vtkIdType GetNodeVTKId( int theObjID ) = 0;
76   virtual vtkIdType GetElemObjId( int theVTKID ) = 0;
77   virtual vtkIdType GetElemVTKId( int theObjID ) = 0;
78   virtual void              ClearEntitiesFlags() = 0;
79   virtual bool              GetEntitiesFlag() = 0;
80   virtual unsigned int      GetEntitiesState() = 0;
81 };
82
83 typedef boost::shared_ptr<SMESH_VisualObj> TVisualObjPtr;
84
85 #endif