Salome HOME
Increment version: 9.1.0
[modules/smesh.git] / src / OBJECT / SMESH_ActorDef.h
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 OBJECT : interactive object for SMESH visualization
24 //  File   : SMESH_ActorDef.h
25 //  Author : Nicolas REJNERI
26 //  Module : SMESH
27 //
28 #ifndef SMESH_ACTORDEF_H
29 #define SMESH_ACTORDEF_H
30
31 #include "SMESH_Actor.h"
32 #include "SMESH_Object.h"
33
34 #include <vtkSmartPointer.h>
35
36 template <class T>
37 class TVTKSmartPtr: public vtkSmartPointer<T>
38 {
39 public:
40   TVTKSmartPtr() {}
41   TVTKSmartPtr(T* r, bool theIsOwner = false): vtkSmartPointer<T>(r) { 
42     if(r && theIsOwner) 
43       r->Delete();
44   }
45   TVTKSmartPtr& operator()(T* r, bool theIsOwner = false){ 
46     vtkSmartPointer<T>::operator=(r); 
47     if(r && theIsOwner) 
48       r->Delete();
49     return *this;
50   }
51   TVTKSmartPtr& operator=(T* r){ vtkSmartPointer<T>::operator=(r); return *this;}
52   T* Get() const { return this->GetPointer();}
53 };
54
55
56 class vtkProperty;
57 class vtkShrinkFilter;
58 class vtkPolyDataMapper;
59 class vtkUnstructuredGrid;
60 class vtkMergeFilter;
61 class vtkPolyData;
62 class vtkMapper;
63 class vtkActor2D;
64 class vtkLookupTable;
65 class vtkPlane;
66 class vtkImplicitBoolean;
67 class vtkTimeStamp;
68 class vtkPlaneCollection;
69
70 class SMESH_DeviceActor;
71 class SMESH_NodeLabelActor;
72 class SMESH_CellLabelActor;
73 class SMESH_ScalarBarActor;
74
75 #ifndef DISABLE_PLOT2DVIEWER
76 class SPlot2d_Histogram;
77 #endif
78
79
80 class SMESH_ActorDef : public SMESH_Actor
81 {
82   friend class SMESH_VisualObj;
83   friend class SMESH_Actor;
84
85  public:
86   vtkTypeMacro(SMESH_ActorDef,SMESH_Actor);
87   
88   virtual void Delete();
89
90   virtual void ReleaseGraphicsResources(vtkWindow *renWin);
91   virtual int RenderOpaqueGeometry(vtkViewport *viewport);
92   virtual int RenderTranslucentGeometry(vtkViewport *viewport);
93   virtual void Render(vtkRenderer *ren);
94
95   virtual void AddToRender(vtkRenderer* theRenderer); 
96   virtual void RemoveFromRender(vtkRenderer* theRenderer);
97
98   virtual void EnableSelection( bool enable );
99   virtual bool hasHighlight() { return true; }  
100   virtual void highlight(bool theHighlight);  
101   virtual void SetPreSelected(bool thePreselect = false);
102
103   virtual bool IsInfinitive();  
104
105   virtual void SetOpacity(double theValue);
106   virtual double GetOpacity();
107
108   virtual void SetSufaceColor(double r,double g,double b, int delta );
109   virtual void GetSufaceColor(double& r,double& g,double& b, int& delta);
110
111   virtual void SetVolumeColor(double r,double g,double b, int delta );
112   virtual void GetVolumeColor(double& r,double& g,double& b, int& delta);
113
114   virtual void SetEdgeColor(double r,double g,double b);
115   virtual void GetEdgeColor(double& r,double& g,double& b);
116
117   virtual void SetOutlineColor(double r,double g,double b);
118   virtual void GetOutlineColor(double& r,double& g,double& b);
119
120
121   virtual void SetNodeColor(double r,double g,double b);
122   virtual void GetNodeColor(double& r,double& g,double& b);
123
124   virtual void Set0DColor(double r,double g,double b);
125   virtual void Get0DColor(double& r,double& g,double& b);
126
127   virtual void SetBallColor(double r,double g,double b);
128   virtual void GetBallColor(double& r,double& g,double& b);
129
130   virtual void SetHighlightColor(double r,double g,double b);
131   virtual void GetHighlightColor(double& r,double& g,double& b);
132
133   virtual void SetPreHighlightColor(double r,double g,double b);
134   virtual void GetPreHighlightColor(double& r,double& g,double& b);
135  
136   virtual double GetLineWidth();
137   virtual void SetLineWidth(double theVal);
138
139   virtual double GetOutlineWidth();
140   virtual void SetOutlineWidth(double theVal);
141
142   virtual void Set0DSize(double size);
143   virtual double Get0DSize();
144
145   virtual void SetBallSize(double size);
146   virtual double GetBallSize();
147
148   virtual void SetBallScale(double size);
149   virtual double GetBallScale();
150
151   virtual int GetNodeObjId(int theVtkID);
152   virtual double* GetNodeCoord(int theObjID);
153   virtual int GetNodeVtkId(int theObjID);
154
155   virtual int GetElemObjId(int theVtkID);
156   virtual vtkCell* GetElemCell(int theObjID);
157
158   virtual int GetObjDimension( const int theObjId );
159
160   virtual void SetVisibility(int theMode);
161   void SetVisibility(int theMode, bool theIsUpdateRepersentation);
162
163   virtual void SetRepresentation(int theMode);
164   
165   virtual unsigned int GetEntityMode() const { return myEntityMode;}
166   virtual void SetEntityMode(unsigned int theMode);
167
168   virtual void SetPointRepresentation(bool theIsPointsVisible);
169   virtual bool GetPointRepresentation();
170
171   virtual double* GetBounds();
172   virtual void SetTransform(VTKViewer_Transform* theTransform); 
173
174   virtual vtkUnstructuredGrid* GetUnstructuredGrid();
175   virtual vtkDataSet* GetInput();
176   virtual vtkMapper* GetMapper();
177
178   virtual double GetShrinkFactor();
179   virtual void SetShrinkFactor(double theValue);
180
181   virtual bool IsShrunkable() { return myIsShrinkable;}
182   virtual bool IsShrunk() { return myIsShrunk;}
183   virtual void SetShrink(); 
184   virtual void UnShrink(); 
185
186   virtual void SetPointsLabeled(bool theIsPointsLabeled);
187   virtual bool GetPointsLabeled();
188
189   virtual void SetPointsFontProperties( SMESH::LabelFont family, int size, 
190                                         bool bold, bool italic, bool shadow,
191                                         double r, double g, double b );
192   virtual void SetCellsFontProperties( SMESH::LabelFont family, int size, 
193                                        bool bold, bool italic, bool shadow,
194                                        double r, double g, double b );
195   
196   virtual void SetCellsLabeled(bool theIsCellsLabeled);
197   virtual bool GetCellsLabeled();
198
199   virtual void SetFacesOriented(bool theIsFacesOriented);
200   virtual bool GetFacesOriented();
201
202   virtual void SetFacesOrientationColor(double r,double g,double b);
203   virtual void GetFacesOrientationColor(double& r,double& g,double& b);
204
205   virtual void SetFacesOrientationScale(double theScale);
206   virtual double GetFacesOrientationScale();
207
208   virtual void SetFacesOrientation3DVectors(bool theState);
209   virtual bool GetFacesOrientation3DVectors();
210
211   virtual void SetControlMode(eControl theMode);
212   virtual void SetControl(SMESH::Controls::FunctorPtr theFunctor);
213   virtual int GetNumberControlEntities();
214   virtual eControl GetControlMode(){ return myControlMode;}
215   virtual SMESH::Controls::FunctorPtr GetFunctor() { return myFunctor; }
216
217   virtual SMESH_ScalarBarActor* GetScalarBarActor(){ return myScalarBarActor;}
218
219   virtual void RemoveAllClippingPlanes();
220   virtual vtkIdType GetNumberOfClippingPlanes();
221   virtual vtkPlane* GetClippingPlane(vtkIdType theID);
222   virtual vtkIdType AddClippingPlane(vtkPlane* thePlane); 
223   virtual void AddOpenGLClippingPlane(vtkPlane* thePlane);
224   virtual void SetOpenGLClippingPlane();
225
226   virtual TVisualObjPtr GetObject() { return myVisualObj;}
227
228   virtual void SetControlsPrecision( const long p ) { myControlsPrecision = p; }
229   virtual long GetControlsPrecision() const { return myControlsPrecision; }
230
231   virtual void UpdateScalarBar();
232   virtual void UpdateDistribution();
233
234 #ifndef DISABLE_PLOT2DVIEWER
235   virtual SPlot2d_Histogram* GetPlot2Histogram() { return my2dHistogram; }
236   virtual SPlot2d_Histogram* UpdatePlot2Histogram();
237 #endif
238
239
240   virtual void SetQuadratic2DRepresentation(EQuadratic2DRepresentation);
241   virtual EQuadratic2DRepresentation GetQuadratic2DRepresentation();
242   
243   virtual void SetMarkerStd( VTK::MarkerType, VTK::MarkerScale );
244   virtual void SetMarkerTexture( int, VTK::MarkerTexture );
245
246  protected:
247   void SetControlMode(eControl theMode, bool theCheckEntityMode);
248   void SetImplicitFunctionUsed(bool theIsImplicitFunctionUsed);
249   bool IsImplicitFunctionUsed() const;
250
251   TVisualObjPtr myVisualObj;
252   vtkTimeStamp* myTimeStamp;
253
254   SMESH_ScalarBarActor* myScalarBarActor;
255   vtkLookupTable* myLookupTable;
256
257   vtkProperty* mySurfaceProp;
258   vtkProperty* myBackSurfaceProp;
259   vtkProperty* myNormalVProp;
260   vtkProperty* myReversedVProp;
261   vtkProperty* myEdgeProp;
262   vtkProperty* myNodeProp;
263
264   SMESH_DeviceActor* myBaseActor;
265   SMESH_NodeLabelActor* myNodeActor;
266   SMESH_DeviceActor* myPickableActor;
267
268   vtkProperty* myHighlightProp;
269   vtkProperty* myOutLineProp;
270   vtkProperty* myPreselectProp;
271
272   SMESH_DeviceActor* myHighlitableActor;
273
274   eControl myControlMode;
275   SMESH::Controls::FunctorPtr myFunctor;
276   vtkProperty* my2DExtProp;
277   vtkProperty* my3DExtProp;
278   SMESH_CellLabelActor* my2DActor;
279   SMESH_DeviceActor* my2DExtActor;
280   SMESH_CellLabelActor* my3DActor;
281   SMESH_DeviceActor* my3DExtActor;
282   SMESH_DeviceActor* myControlActor;
283
284   vtkProperty* myNodeExtProp;
285   SMESH_DeviceActor* myNodeExtActor;
286
287   vtkProperty* my1DProp;
288   SMESH_CellLabelActor* my1DActor;
289   vtkProperty* my1DExtProp;
290   SMESH_DeviceActor* my1DExtActor;
291
292   vtkProperty* my0DProp;
293   SMESH_CellLabelActor* my0DActor;
294   vtkProperty* myBallProp;
295   SMESH_CellLabelActor* myBallActor;
296   vtkProperty* my0DExtProp;
297   SMESH_DeviceActor* my0DExtActor;
298
299   unsigned int myEntityMode;
300   unsigned int myEntityModeCache;
301   int  myRepresentationCache;
302   bool myIsEntityModeCache;
303   bool myIsPointsVisible;
304
305   bool myIsShrinkable;
306   bool myIsShrunk;
307   
308   vtkImplicitBoolean* myImplicitBoolean;
309   vtkPlaneCollection* myPlaneCollection;
310   typedef TVTKSmartPtr<vtkPlane> TPlanePtr;
311   typedef std::vector<TPlanePtr> TCippingPlaneCont;
312   TCippingPlaneCont myCippingPlaneCont;
313   long myControlsPrecision;
314
315 #ifndef DISABLE_PLOT2DVIEWER
316   SPlot2d_Histogram* my2dHistogram;
317 #endif
318
319   bool myIsFacesOriented;
320   
321   int myDeltaBrightness;
322   int myDeltaVBrightness;
323
324   VTK::MarkerTexture myMarkerTexture;
325
326   SMESH_ActorDef();
327   ~SMESH_ActorDef();
328
329   bool Init(TVisualObjPtr theVisualObj, 
330             const char* theEntry, 
331             const char* theName,
332             int theIsClear);
333
334   void SetIsShrunkable(bool theShrunkable);
335   void UpdateHighlight();
336   void Update();
337
338  private:
339   // hide the two parameter Render() method from the user and the compiler.
340   virtual void Render(vtkRenderer *, vtkMapper *) {};
341   virtual void ShallowCopy(vtkProp *prop);
342   virtual void SetMapper(vtkMapper *);
343   static SMESH_ActorDef* New();
344
345   // Not implemented.
346   SMESH_ActorDef(const SMESH_ActorDef&);  
347   void operator=(const SMESH_ActorDef&);
348 };
349
350
351 #endif //SMESH_ACTORDEF_H