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