1 // Copyright (C) 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SALOME OBJECT : implementation of interactive object visualization for OCC and VTK viewers
24 // File : SALOME_Actor.h
25 // Author : Nicolas REJNERI
27 #ifndef VTKVIEVER_ACTOR_H
28 #define VTKVIEVER_ACTOR_H
30 #include "VTKViewer.h"
35 #include <vtkLODActor.h>
36 #include <vtkProperty.h>
45 class vtkPassThroughFilter;
47 class VTKViewer_Transform;
48 class VTKViewer_GeometryFilter;
49 class VTKViewer_TransformFilter;
51 extern int VTKViewer_POINT_SIZE;
52 extern int VTKViewer_LINE_WIDTH;
56 namespace Representation
59 const Type Points = VTK_POINTS;
60 const Type Wireframe = VTK_WIREFRAME;
61 const Type Surface = VTK_SURFACE;
62 const Type Insideframe = Surface + 1;
63 const Type SurfaceWithEdges = Insideframe + 1;
68 #pragma warning ( disable:4251 )
71 /*! \class vtkLODActor
72 * \brief For more information see <a href="http://www.vtk.org/">VTK documentation</a>
74 class VTKVIEWER_EXPORT VTKViewer_Actor : public vtkLODActor
77 static VTKViewer_Actor* New();
79 vtkTypeMacro(VTKViewer_Actor,vtkLODActor)
81 //----------------------------------------------------------------------------
87 //! Name the #VTKViewer_Actor
90 setName(const char* theName);
92 //----------------------------------------------------------------------------
96 SetOpacity(double theOpacity);
98 //! Get current opacity
110 //! Get current color
120 SetColor(const double theRGB[3]);
125 SetMaterial(std::vector<vtkProperty*> theProps);
127 //! Get current front material
132 //! Get current back material
137 //----------------------------------------------------------------------------
138 // For selection mapping purpose
139 //! Maps VTK index of a node to corresponding object index
142 GetNodeObjId(int theVtkID);
144 //! Get coordinates of a node for given object index
147 GetNodeCoord(int theObjID);
149 //! Maps object index of a node to corresponding VTK index
152 GetNodeVtkId(int theObjID);
154 //! Maps VTK index of a cell to corresponding object index
157 GetElemObjId(int theVtkID);
159 //! Get corresponding #vtkCell for given object index
162 GetElemCell(int theObjID);
164 //----------------------------------------------------------------------------
165 //! Get dimension of corresponding mesh element
168 GetObjDimension( const int theObjId );
170 //! To insert some additional filters and then sets the given #vtkMapper
173 SetMapper(vtkMapper* theMapper);
175 //! Allows to get initial #vtkDataSet
180 //! Apply view transformation
183 SetTransform(VTKViewer_Transform* theTransform);
185 //! To calculatate last modified time
190 //----------------------------------------------------------------------------
191 //! Set representation (VTK_SURFACE, VTK_POINTS, VTK_WIREFRAME and so on)
194 SetRepresentation(int theMode);
196 //! Get current representation mode
201 //! Get current display mode (obsolete)
206 //! Set display mode (obsolete)
209 setDisplayMode(int theMode);
211 //----------------------------------------------------------------------------
212 //! Set infinive flag
214 Infinitive means actor without size (point for example),
215 which is not taken into account in calculation of boundaries of the scene
218 SetInfinitive(bool theIsInfinite);
220 //! Get infinive flag
225 //! To calcualte current bounding box
230 //! To calcualte current bounding box
232 GetBounds(double bounds[6]);
234 //----------------------------------------------------------------------------
245 SetSize( const double );
249 SetCamera( vtkCamera* );
251 //----------------------------------------------------------------------------
252 //! Set ResolveCoincidentTopology flag
254 SetResolveCoincidentTopology(bool theIsResolve);
256 //! Set ResolveCoincidentTopology parameters
258 SetPolygonOffsetParameters(double factor,
261 //! Get current ResolveCoincidentTopology parameters
263 GetPolygonOffsetParameters(double& factor,
266 //! Get default ResolveCoincidentTopology parameters
269 GetDefaultPolygonOffsetParameters(double& factor,
274 Render(vtkRenderer *, vtkMapper *);
276 //----------------------------------------------------------------------------
277 //! Get current shrink factor
282 //! Is the actor is shrunkable
287 //! Is the actor is shrunk
292 //! Insert shrink filter into pipeline
297 //! Remove shrink filter from pipeline
302 //----------------------------------------------------------------------------
303 //! To publish the actor an all its internal devices
306 AddToRender(vtkRenderer* theRendere);
308 //! To remove the actor an all its internal devices
311 RemoveFromRender(vtkRenderer* theRendere);
313 //! Used to obtain all dependent actors
316 GetChildActors(vtkActorCollection*);
318 //----------------------------------------------------------------------------
319 //! Is notified on enabling/disabling selection
322 EnableSelection( bool /*enable*/ ) {}
324 //! Ask, if the descendant of the VTKViewer_Actor will implement its own highlight or not
329 //! Ask, if the VTKViewer_Actor is already highlighted
334 //! Ask, if the VTKViewer_Actor is already preselected
339 //! Set preselection mode
342 SetPreSelected(bool thePreselect = false);
344 //----------------------------------------------------------------------------
345 //! Just to update visibility of the highlight devices
348 highlight(bool theHighlight);
351 SetPreviewProperty(vtkProperty* theProperty);
353 //----------------------------------------------------------------------------
354 //! Setting for displaying quadratic elements
355 virtual void SetQuadraticArcMode(bool theFlag);
356 virtual bool GetQuadraticArcMode() const;
358 virtual void SetQuadraticArcAngle(double theMaxAngle);
359 virtual double GetQuadraticArcAngle() const;
361 //----------------------------------------------------------------------------
362 //! Return pointer to the dataset, which used to calculation of the bounding box of the actor
363 virtual vtkDataSet* GetHighlightedDataSet();
366 //----------------------------------------------------------------------------
367 bool myIsResolveCoincidentTopology;
368 double myPolygonOffsetFactor;
369 double myPolygonOffsetUnits;
378 VTKViewer_GeometryFilter *myGeomFilter;
379 VTKViewer_TransformFilter *myTransformFilter;
380 std::vector<vtkPassThroughFilter*> myPassFilter;
382 int myRepresentation;
383 vtkProperty *myProperty;
386 InitPipeLine(vtkMapper* theMapper);
392 vtkProperty *PreviewProperty;
393 bool myIsPreselected;
394 bool myIsHighlighted;
398 #pragma warning ( default:4251 )
401 #endif // VTKVIEVER_ACTOR_H