Salome HOME
95c6c79f32c9eb72f3161c3ed8198a885db7edc2
[modules/smesh.git] / src / OBJECT / SMESH_Actor.h
1 //  Copyright (C) 2007-2010  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_Actor.h
25 //  Author : Nicolas REJNERI
26 //  Module : SMESH
27 //
28 #ifndef SMESH_ACTOR_H
29 #define SMESH_ACTOR_H
30
31 #include <SALOME_Actor.h>
32 #include "SMESH_Object.h"
33
34 #include <vtkCommand.h>
35
36 class vtkUnstructuredGrid;
37
38 class SMESH_ScalarBarActor;
39
40 class vtkPlane;
41 class vtkImplicitBoolean;
42
43 #ifndef DISABLE_PLOT2DVIEWER
44 class SPlot2d_Histogram;
45 #endif
46
47 namespace SMESH
48 {
49   const vtkIdType DeleteActorEvent = vtkCommand::UserEvent + 100;
50 }
51
52 class SMESHOBJECT_EXPORT SMESH_Actor: public SALOME_Actor
53 {
54   static SMESH_Actor* New() { return NULL;}
55
56  public:
57   vtkTypeMacro(SMESH_Actor,SALOME_Actor);
58   static SMESH_Actor* New(TVisualObjPtr theVisualObj, 
59                           const char* theEntry, 
60                           const char* theName,
61                           int theIsClear);
62   
63   virtual void SetSufaceColor(vtkFloatingPointType r,vtkFloatingPointType g,vtkFloatingPointType b) = 0;
64   virtual void GetSufaceColor(vtkFloatingPointType& r,vtkFloatingPointType& g,vtkFloatingPointType& b) = 0;
65   
66   virtual void SetBackSufaceColor(vtkFloatingPointType r,vtkFloatingPointType g,vtkFloatingPointType b) = 0;
67   virtual void GetBackSufaceColor(vtkFloatingPointType& r,vtkFloatingPointType& g,vtkFloatingPointType& b) = 0;
68   
69   virtual void SetEdgeColor(vtkFloatingPointType r,vtkFloatingPointType g,vtkFloatingPointType b) = 0;
70   virtual void GetEdgeColor(vtkFloatingPointType& r,vtkFloatingPointType& g,vtkFloatingPointType& b) = 0;
71
72   virtual void SetNodeColor(vtkFloatingPointType r,vtkFloatingPointType g,vtkFloatingPointType b) = 0;
73   virtual void GetNodeColor(vtkFloatingPointType& r,vtkFloatingPointType& g,vtkFloatingPointType& b) = 0;
74
75   virtual void Set0DColor(vtkFloatingPointType r,vtkFloatingPointType g,vtkFloatingPointType b) = 0;
76   virtual void Get0DColor(vtkFloatingPointType& r,vtkFloatingPointType& g,vtkFloatingPointType& b) = 0;
77
78   virtual void SetHighlightColor(vtkFloatingPointType r,vtkFloatingPointType g,vtkFloatingPointType b) = 0;
79   virtual void GetHighlightColor(vtkFloatingPointType& r,vtkFloatingPointType& g,vtkFloatingPointType& b) = 0;
80
81   virtual void SetPreHighlightColor(vtkFloatingPointType r,vtkFloatingPointType g,vtkFloatingPointType b) = 0;
82   virtual void GetPreHighlightColor(vtkFloatingPointType& r,vtkFloatingPointType& g,vtkFloatingPointType& b) = 0;
83  
84   virtual vtkFloatingPointType GetLineWidth() = 0;
85   virtual void SetLineWidth(vtkFloatingPointType theVal) = 0;
86
87   virtual void Set0DSize(vtkFloatingPointType size) = 0;
88   virtual vtkFloatingPointType Get0DSize() = 0;
89
90   enum EReperesent { ePoint, eEdge, eSurface};
91   
92   enum EEntityMode { e0DElements = 0x01, eEdges = 0x02, eFaces = 0x04, eVolumes = 0x08, eAllEntity = 0x0f};
93
94   enum EQuadratic2DRepresentation { eLines = 0x01, eArcs = 0x02 };
95
96   virtual void SetEntityMode(unsigned int theMode) = 0;
97   virtual unsigned int GetEntityMode() const = 0;
98
99   virtual void SetQuadratic2DRepresentation(EQuadratic2DRepresentation) = 0;
100   virtual EQuadratic2DRepresentation GetQuadratic2DRepresentation() = 0;
101
102   virtual void SetPointRepresentation(bool theIsPointsVisible) = 0;
103   virtual bool GetPointRepresentation() = 0;
104
105   virtual vtkUnstructuredGrid* GetUnstructuredGrid() = 0;
106
107   virtual void SetShrinkFactor(vtkFloatingPointType theValue) = 0;
108
109   virtual void SetPointsLabeled(bool theIsPointsLabeled) = 0;
110   virtual bool GetPointsLabeled() = 0;
111
112   virtual void SetCellsLabeled(bool theIsCellsLabeled) = 0;
113   virtual bool GetCellsLabeled() = 0;
114
115   virtual void SetFacesOriented(bool theIsFacesOriented) = 0;
116   virtual bool GetFacesOriented() = 0;
117
118   virtual void SetFacesOrientationColor(vtkFloatingPointType theColor[3]) = 0;
119   virtual void GetFacesOrientationColor(vtkFloatingPointType theColor[3]) = 0;
120
121   virtual void SetFacesOrientationScale(vtkFloatingPointType theScale) = 0;
122   virtual vtkFloatingPointType GetFacesOrientationScale() = 0;
123
124   virtual void SetFacesOrientation3DVectors(bool theState) = 0;
125   virtual bool GetFacesOrientation3DVectors() = 0;
126
127   enum eControl{eNone, eLength, eLength2D, eFreeBorders, eFreeEdges, eFreeNodes,
128                 eFreeFaces, eMultiConnection, eArea, eTaper, eAspectRatio,
129                 eMinimumAngle, eWarping, eSkew, eAspectRatio3D, eMultiConnection2D, eVolume3D,
130                 eMaxElementLength2D, eMaxElementLength3D, eBareBorderFace, eBareBorderVolume,
131                 eOverConstrainedFace, eOverConstrainedVolume};
132   virtual void SetControlMode(eControl theMode) = 0;
133   virtual eControl GetControlMode() = 0;
134   virtual SMESH::Controls::FunctorPtr GetFunctor() = 0;
135
136   virtual SMESH_ScalarBarActor* GetScalarBarActor() = 0;
137
138   virtual void RemoveAllClippingPlanes() = 0; 
139   virtual vtkIdType GetNumberOfClippingPlanes() = 0; 
140   virtual vtkPlane* GetClippingPlane(vtkIdType theID) = 0; 
141   virtual vtkIdType AddClippingPlane(vtkPlane* thePlane) = 0; 
142
143   virtual TVisualObjPtr GetObject() = 0;
144
145   virtual void SetControlsPrecision( const long ) = 0;
146   virtual long GetControlsPrecision() const = 0;
147
148   virtual void UpdateScalarBar() = 0;
149   virtual void UpdateDistribution() = 0;
150
151 #ifndef DISABLE_PLOT2DVIEWER
152   virtual SPlot2d_Histogram* GetPlot2Histogram() = 0;
153   virtual SPlot2d_Histogram* UpdatePlot2Histogram() = 0;
154 #endif
155 };
156
157
158 #endif //SMESH_ACTOR_H