1 // Copyright (C) 2014-2015 EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 // Lesser General Public License for more details.
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROGUI_OCCDISPLAYER_H
20 #define HYDROGUI_OCCDISPLAYER_H
22 #include "HYDROGUI_AbstractDisplayer.h"
25 class AIS_InteractiveContext;
27 class OCCViewer_ViewManager;
28 class OCCViewer_Viewer;
31 * \class HYDROGUI_OCCDisplayer
32 * \brief Class intended to create, display and update the presentations on OCC viewer.
34 class HYDROGUI_OCCDisplayer : public HYDROGUI_AbstractDisplayer
39 * \param theModule module object
41 HYDROGUI_OCCDisplayer( HYDROGUI_Module* theModule );
46 virtual ~HYDROGUI_OCCDisplayer();
50 * \brief Force the specified objects to be updated.
51 * \param theObjs sequence of objects to update
52 * \param theViewerId viewer identifier
54 void SetToUpdate( const HYDROData_SequenceOfObjects& theObjs,
55 const int theViewerId );
58 * \brief Get the applicable viewer type.
60 virtual QString GetType() const;
63 * \brief Add the z layer for preview and returns its index.
64 * \param theMgr OCC view manager
66 int AddPreviewZLayer( OCCViewer_ViewManager* theMgr );
69 * \brief Removes the z layer.
70 * \param theMgr OCC view manager
71 * \param theLayer a layer index
73 void RemoveZLayer( OCCViewer_ViewManager* theMgr,
76 void SetToUpdateColorScale();
79 * \brief Get color scale for the viewer.
80 * \param theViewerId viewer identifier
81 * \return the color scale
83 Handle(AIS_ColorScale) GetColorScale( const int theViewerId );
86 void UpdatePolylines( int theViewerId, int theType, int theSize );
88 void UpdateColorScale( const OCCViewer_Viewer* );
92 * \brief Erase all viewer objects.
93 * \param theViewerId viewer identifier
95 void EraseAll( const int theViewerId );
98 * \brief Erase the specified viewer objects.
99 * \param theObjs sequence of objects to erase
100 * \param theViewerId viewer identifier
102 void Erase( const HYDROData_SequenceOfObjects& theObjs,
103 const int theViewerId );
106 * \brief Display the specified viewer objects.
107 * \param theObjs sequence of objects to display
108 * \param theViewerId viewer identifier
109 * \param theIsForced flag used to update all objects, including the unchanged ones
110 * \param theDoFitAll flag used to fit the view to all visible objects; do not fit by default
112 void Display( const HYDROData_SequenceOfObjects& theObjs,
113 const int theViewerId,
114 const bool theIsForced,
115 const bool theDoFitAll );
117 * \brief Purge all invalid objects in the viewer.
118 * \param theViewerId viewer identifier
120 void purgeObjects( const int theViewerId );
124 * \brief Creates new OCC shape.
125 * \param theViewerId viewer identifier
126 * \param theContext context of OCC viewer
127 * \param theObject data model object
128 * \return pointer to new created shape
130 HYDROGUI_Shape* createShape( const int theViewerId,
131 const Handle(AIS_InteractiveContext)& theContext,
132 const Handle(HYDROData_Entity)& theObject );
135 * \brief Display the specified object.
136 * \param theObject the object to display
137 * \param theViewer the viewer for displaying
138 * \param theIsForced the flag used to update the object shape
139 * \return true in case of success
141 bool Display( const Handle(HYDROData_Entity)& theObject,
142 const OCCViewer_Viewer* theViewer,
143 const bool theIsForced );
146 * \brief Set Z layer to the shape corresponding to the HYDRO data object.
147 * \param theViewer the viewer for Z layer setting
148 * \param theObject the HYDRO object
149 * \param theZLayerId the Z layer ID
151 void SetZLayer( const OCCViewer_Viewer* theViewer,
152 const Handle(HYDROData_Entity)& theObject,
153 const int theZLayerId );
156 bool myToUpdateColorScale;
158 QMap<int, Handle(AIS_ColorScale)> myColorScales;