1 // Copyright (C) 2007-2016 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 // GEOM GEOMGUI : GUI for Geometry component
24 // File : GEOM_Displayer.h
25 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
27 #ifndef GEOM_DISPLAYER_H
28 #define GEOM_DISPLAYER_H
30 #include "GEOM_GEOMGUI.hxx"
31 #include <GEOM_AISShape.hxx>
33 #include <SALOME_InteractiveObject.hxx>
41 class SALOME_OCCViewType;
43 #include <TopoDS_Shape.hxx>
44 #include <Quantity_Color.hxx>
45 #include <LightApp_Displayer.h>
46 #include <LightApp_Study.h>
47 #include <Aspect_TypeOfMarker.hxx>
48 #include <AIS_ColorScale.hxx>
49 #include <TCollection_AsciiString.hxx>
50 #include <TColStd_MapOfInteger.hxx>
55 #include <SALOMEconfig.h>
56 #include CORBA_CLIENT_HEADER(GEOM_Gen)
58 #define GEOM_ALLOBJECTS -1 // Selection of all objects is activated
59 #define GEOM_PREVIEW -2 // Definition for preview selection
60 #define GEOM_ALLSHAPES -3 // Selection of all shapes is activated
61 #define GEOM_ALLGEOM -4 // Selection of all geom objects is activated
63 typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;
65 class LightApp_SelectionMgr;
66 class SalomeApp_Study;
67 class SalomeApp_Application;
68 class SUIT_SelectionFilter;
71 class GEOMGUI_EXPORT GEOM_Displayer : public LightApp_Displayer
76 GEOM_Displayer( SalomeApp_Study* app );
78 virtual ~GEOM_Displayer();
80 virtual bool canBeDisplayed( const QString& /*entry*/, const QString& /*viewer_type*/ ) const;
82 /* Display/Erase object methods */
83 void Display ( const Handle(SALOME_InteractiveObject)& theIO,
84 const bool updateViewer = true,
85 SALOME_View* theViewFrame = 0 );
87 // This overloaded Display() method can be useful for operations
88 // not using dialog boxes.
89 void Display ( GEOM::GEOM_BaseObject_ptr theObj,
90 const bool updateViewer = true );
92 void Redisplay ( const Handle(SALOME_InteractiveObject)& theIO,
93 const bool updateViewer = true,
94 const bool checkActiveViewer = true );
96 void Redisplay ( const Handle(SALOME_InteractiveObject)& theIO,
97 const bool theUpdateViewer,
98 SALOME_View* theViewFrame );
100 void Erase ( const Handle(SALOME_InteractiveObject)& theIO,
101 const bool forced = false,
102 const bool updateViewer = true,
103 SALOME_View* theViewFrame = 0 );
105 void Erase ( GEOM::GEOM_BaseObject_ptr theObj,
106 const bool forced = false,
107 const bool updateViewer = true,
108 SALOME_View* theViewFrame = 0);
110 void EraseWithChildren(const Handle(SALOME_InteractiveObject)& theIO,
111 const bool eraseOnlyChildren = false);
113 /* Display/Erase list of objects methods */
115 void Display ( const SALOME_ListIO& theIOList,
116 const bool updateViewer = true );
118 void Erase ( const SALOME_ListIO& theIOList,
119 const bool forced = false,
120 const bool updateViewer = true );
122 void Redisplay ( const SALOME_ListIO& theIOList,
123 const bool updateViewer = true,
124 const bool checkActiveViewer = true );
126 void Redisplay ( const SALOME_ListIO& theIOList,
127 const bool theUpdateViewer,
128 SALOME_View* theViewFrame );
130 /* Update visibility state */
131 void UpdateVisibility( SALOME_View*, const SALOME_Prs*, bool );
133 /* build presentation accordint to the current viewer type*/
134 SALOME_Prs* BuildPrs ( GEOM::GEOM_Object_ptr );
135 SALOME_Prs* BuildPrs ( const TopoDS_Shape& );
137 /* Set color for shape displaying. If it is equal -1 then default color is used.
138 Available values are from Quantity_NameOfColor enumeration */
139 void SetColor ( const int );
141 int GetColor () const;
142 bool HasColor () const;
144 double SetTransparency ( const double );
145 double UnsetTransparency();
146 double GetTransparency () const;
147 bool HasTransparency () const;
149 /* Set texture for shape displaying. */
150 void SetTexture ( const std::string& );
151 bool HasTexture () const;
152 std::string GetTexture () const;
154 /* Set width for shape displaying. If it is equal -1 then default width is used. */
155 void SetWidth ( const double );
157 double GetWidth () const;
158 bool HasWidth () const;
160 /* Set width for iso-lines displaying. If it is equal -1 then default width is used. */
161 void SetIsosWidth ( const int );
162 int GetIsosWidth () const;
163 bool HasIsosWidth () const;
165 /* Set nb iso-libes for displaying. Use -1 to set default values. */
166 int SetNbIsos( const int );
168 int GetNbIsos() const;
169 bool HasNbIsos() const;
171 /* Set color for iso-lines displaying. If it is equal -1 then default color is used.
172 Available values are from Quantity_NameOfColor enumeration */
173 int SetIsosColor ( const int );
174 int UnsetIsosColor();
175 int GetIsosColor () const;
176 bool HasIsosColor () const;
178 /* Set display mode shape displaying. If it is equal -1 then display mode is used. */
179 int SetDisplayMode( const int );
180 int GetDisplayMode() const;
181 int UnsetDisplayMode();
182 bool HasDisplayMode() const;
184 /* Sets name - for temporary objects only */
185 void SetName( const char* theName );
188 /* Reimplemented from SALOME_Displayer */
189 virtual void Update( SALOME_OCCPrs* );
190 virtual void Update( SALOME_VTKPrs* );
191 virtual void BeforeDisplay( SALOME_View*, const SALOME_OCCPrs* );
192 virtual void AfterDisplay ( SALOME_View*, const SALOME_OCCPrs* );
193 virtual void BeforeErase ( SALOME_View*, const SALOME_OCCPrs* );
194 virtual void AfterErase ( SALOME_View*, const SALOME_OCCPrs* );
196 /* This methos is used for activisation/deactivisation of objects to be displayed*/
197 void SetToActivate( const bool );
198 bool ToActivate() const;
200 /* Activate/Deactivate selection*/
201 void LocalSelection( const Handle(SALOME_InteractiveObject)&, const std::list<int> );
202 void LocalSelection( const Handle(SALOME_InteractiveObject)&, const int );
203 void LocalSelection( const SALOME_ListIO& theIOList, const std::list<int> );
204 void LocalSelection( const SALOME_ListIO& theIOList, const int );
205 void GlobalSelection( const int = GEOM_ALLOBJECTS, const bool = false );
206 void GlobalSelection( const TColStd_MapOfInteger&, const bool = false, const QList<int>* = 0 );
208 SalomeApp_Study* getStudy() const;
210 static SALOMEDS::Color getUniqueColor( const QList<SALOMEDS::Color>& );
211 static SALOMEDS::Color getPredefinedUniqueColor();
213 /*Get color of the geom object*/
214 static SALOMEDS::Color getColor(GEOM::GEOM_Object_var aGeomObject, bool& hasColor);
216 /* Get minimum or maximum enclosed shape type */
217 static int getMinMaxShapeType( const TopoDS_Shape& shape, bool ismin );
219 /* Check if the object is a vertex or a compound of vertices */
220 static bool isCompoundOfVertices( const TopoDS_Shape& theShape );
223 /* Builds presentation of not published object */
224 virtual SALOME_Prs* buildSubshapePresentation(const TopoDS_Shape& aShape,
228 /* Update visibility and parameters of the currently selected field step's color scale */
229 void UpdateColorScale( const bool theIsRedisplayFieldSteps = false, const bool updateViewer = true );
230 void SetUpdateColorScale(bool toUpdate) { myUpdateColorScale = toUpdate; } // IPAL54049
233 /* internal methods */
234 /* Builds presentation according to the current viewer type */
235 virtual SALOME_Prs* buildPresentation( const QString&, SALOME_View* = 0 );
237 /* Sets interactive object */
238 void setIO( const Handle(SALOME_InteractiveObject)& theIO );
241 void setShape( const TopoDS_Shape& theShape );
243 /* Sets field step information */
244 void setFieldStepInfo( const GEOM::field_data_type theFieldDataType,
245 const int theFieldDimension,
246 const QList<QVariant>& theFieldStepData,
247 const TCollection_AsciiString& theFieldStepName,
248 const double theFieldStepRangeMin,
249 const double theFieldStepRangeMax );
251 /* Resets internal data */
252 void internalReset();
254 void clearTemporary( LightApp_SelectionMgr* theSelMgr );
256 SUIT_SelectionFilter* getFilter( const int theMode );
257 SUIT_SelectionFilter* getComplexFilter( const QList<int>* );
259 Quantity_Color qColorFromResources( const QString&, const QColor& );
260 QColor colorFromResources( const QString&, const QColor& );
261 void updateShapeProperties( const Handle(GEOM_AISShape)&, bool );
262 void updateActorProperties( GEOM_Actor*, bool );
263 void updateDimensions( const Handle(SALOME_InteractiveObject)&, SALOME_OCCPrs*, const gp_Ax3& );
264 void updateShapeAnnotations( const Handle(SALOME_InteractiveObject)&, SALOME_OCCPrs*, const gp_Ax3& );
266 PropMap getObjectProperties( SalomeApp_Study*, const QString&, SALOME_View* = 0 );
267 PropMap getDefaultPropertyMap();
269 /* Methods for reading the field step information */
270 void readFieldStepInfo( GEOM::GEOM_FieldStep_var theGeomFieldStep );
271 QList<QVariant> groupFieldData( const QList<QVariant>& theFieldStepData,
272 const int theFieldNbComponents,
273 const bool theIsString,
274 double& theFieldStepRangeMin,
275 double& theFieldStepRangeMax );
278 Handle(SALOME_InteractiveObject) myIO;
279 TopoDS_Shape myShape;
280 GEOM::field_data_type myFieldDataType;
281 int myFieldDimension;
282 QList<QVariant> myFieldStepData;
283 TCollection_AsciiString myFieldStepName;
284 double myFieldStepRangeMin;
285 double myFieldStepRangeMax;
287 std::string myTexture;
289 SALOME_View* myViewFrame;
290 Handle(AIS_ColorScale) myColorScale;
291 int myUpdateColorScale; // IPAL54049
294 Quantity_Color myShadingColor;
302 bool myHasDisplayMode;
303 Aspect_TypeOfMarker myTypeOfMarker;
304 double myScaleOfMarker;
305 double myTransparency;
306 bool myIsRedisplayed;
309 SalomeApp_Application* myApp;
310 friend class GEOM_Swig;
313 #endif // GEOM_DISPLAYER_H