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_OCCDISPLAYER_H
24 #define HYDROGUI_OCCDISPLAYER_H
26 #include <HYDROData_Entity.h>
28 class HYDROGUI_Module;
30 class Handle(AIS_InteractiveContext);
33 * \class HYDROGUI_OCCDisplayer
34 * \brief Class intended to create, display and update the presentations on OCC viewer.
36 class HYDROGUI_OCCDisplayer
41 * \param theModule module object
43 HYDROGUI_OCCDisplayer( HYDROGUI_Module* theModule );
48 virtual ~HYDROGUI_OCCDisplayer();
52 * \brief Force the specified objects to be updated.
53 * \param theObjs sequence of objects to update
54 * \param theViewerId viewer identifier
56 void SetToUpdate( const HYDROData_SequenceOfObjects& theObjs,
57 const int theViewerId );
60 * \brief Update all objects in the viewer.
61 * \param theViewerId viewer identifier
62 * \param theIsInit flag used for initial update
63 * \param theIsForced flag used to update all objects, including the unchanged ones
65 void UpdateAll( const int theViewerId,
67 const bool theIsForced );
71 * \brief Erase all viewer objects.
72 * \param theViewerId viewer identifier
74 void EraseAll( const int theViewerId );
77 * \brief Update and display all objects in the viewer.
78 * \param theViewerId viewer identifier
79 * \param theIsForced flag used to update all objects, including the unchanged ones
81 void DisplayAll( const int theViewerId,
82 const bool theIsForced );
85 * \brief Update the specified viewer objects.
86 * \param theObjs sequence of objects to update
87 * \param theViewerId viewer identifier
88 * \param theIsForced flag used to update all objects, including the unchanged ones
90 void Update( const HYDROData_SequenceOfObjects& theObjs,
91 const int theViewerId,
92 const bool theIsForced );
95 * \brief Erase the specified viewer objects.
96 * \param theObjs sequence of objects to erase
97 * \param theViewerId viewer identifier
99 void Erase( const HYDROData_SequenceOfObjects& theObjs,
100 const int theViewerId );
103 * \brief Display the specified viewer objects.
104 * \param theObjs sequence of objects to display
105 * \param theViewerId viewer identifier
106 * \param theIsForced flag used to update all objects, including the unchanged ones
108 void Display( const HYDROData_SequenceOfObjects& theObjs,
109 const int theViewerId,
110 const bool theIsForced );
114 * \brief Purge all invalid objects in the viewer.
115 * \param theViewerId viewer identifier
117 void purgeObjects( const int theViewerId );
120 * \brief Creates new OCC shape.
121 * \param theViewerId viewer identifier
122 * \param theContext context of OCC viwer
123 * \param theObject data model object
124 * \return pointer to new created shape
126 HYDROGUI_Shape* createShape( const int theViewerId,
127 const Handle(AIS_InteractiveContext)& theContext,
128 const Handle(HYDROData_Entity)& theObject );
131 HYDROGUI_Module* myModule;