1 // Copyright (C) 2007-2013 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.
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 #ifndef HYDROGUI_VTKPRSDISPLAYER_H
24 #define HYDROGUI_VTKPRSDISPLAYER_H
26 #include "HYDROGUI_AbstractDisplayer.h"
28 #include <vtkScalarBarActor.h>
30 class HYDROGUI_VTKPrsDriver;
33 * \class HYDROGUI_VTKPrsDisplayer
34 * \brief Class intended to create, display and update the presentations in VTK viewer.
36 class HYDROGUI_VTKPrsDisplayer : public HYDROGUI_AbstractDisplayer
41 * \param theModule module object
43 HYDROGUI_VTKPrsDisplayer( HYDROGUI_Module* theModule );
48 virtual ~HYDROGUI_VTKPrsDisplayer();
51 * \brief Force the specified objects to be updated.
52 * \param theObjs sequence of objects to update
53 * \param theViewerId viewer identifier
55 void SetToUpdate( const HYDROData_SequenceOfObjects& theObjs,
56 const int theViewerId );
59 * \brief Get the applicable viewer type.
61 virtual QString GetType() const;
64 * \brief Set the range of Z values for the color legend bar.
66 void SetZRange( double theRange[] );
69 * \brief Get the range of Z values for the color legend bar.
71 double* GetZRange() const;
75 * \brief Erase all viewer objects.
76 * \param theViewerId viewer identifier
78 void EraseAll( const int theViewerId );
81 * \brief Erase the specified viewer objects.
82 * \param theObjs sequence of objects to erase
83 * \param theViewerId viewer identifier
85 void Erase( const HYDROData_SequenceOfObjects& theObjs,
86 const int theViewerId );
89 * \brief Display the specified viewer objects.
90 * \param theObjs sequence of objects to display
91 * \param theViewerId viewer identifier
92 * \param theIsForced flag used to update all objects, including the unchanged ones
93 * \param theDoFitAll flag used to fit the view to all visible objects; do not fit by default
95 void Display( const HYDROData_SequenceOfObjects& theObjs,
96 const int theViewerId,
97 const bool theIsForced,
98 const bool theDoFitAll );
102 * \brief Purge all invalid objects in the viewer.
103 * \param theViewerId viewer identifier
105 void purgeObjects( const int theViewerId );
109 * \brief Get the presentation driver for the specified data object.
110 * \param theObj data object
112 HYDROGUI_VTKPrsDriver* getDriver( const Handle(HYDROData_Entity)& theObj );
114 HYDROGUI_VTKPrsDriver* myDriver;
116 vtkNew< vtkScalarBarActor > myScalarBar; //!< The colors legend presentation