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 // 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"
32 #include <SALOME_InteractiveObject.hxx>
40 class SALOME_OCCViewType;
42 #include <TopoDS_Shape.hxx>
43 #include <Quantity_Color.hxx>
44 #include <LightApp_Displayer.h>
45 #include <LightApp_Study.h>
46 #include <Aspect_TypeOfMarker.hxx>
47 #include <TCollection_AsciiString.hxx>
53 #include <SALOMEconfig.h>
54 #include CORBA_CLIENT_HEADER(GEOM_Gen)
56 #define GEOM_ALLOBJECTS -1 // Selection of all objects is activated
57 #define GEOM_PREVIEW -2 // Definition for preview selection
58 #define GEOM_ALLSHAPES -3 // Selection of all shapes is activated
59 #define GEOM_ALLGEOM -4 // Selection of all geom objects is activated
61 typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;
63 class TColStd_MapOfInteger;
64 class LightApp_SelectionMgr;
65 class SalomeApp_Study;
66 class SalomeApp_Application;
67 class SUIT_SelectionFilter;
68 class Handle_GEOM_AISShape;
70 //class SALOME_Selection;
72 class GEOMGUI_EXPORT GEOM_Displayer : public LightApp_Displayer
77 GEOM_Displayer( SalomeApp_Study* app );
79 virtual ~GEOM_Displayer();
81 virtual bool canBeDisplayed( const QString& /*entry*/, const QString& /*viewer_type*/ ) const;
83 /* Display/Erase object methods */
84 void Display ( const Handle(SALOME_InteractiveObject)& theIO,
85 const bool updateViewer = true,
86 SALOME_View* theViewFrame = 0 );
88 // This overloaded Display() method can be useful for operations
89 // not using dialog boxes.
90 void Display ( GEOM::GEOM_BaseObject_ptr theObj,
91 const bool updateViewer = true );
93 void Redisplay ( const Handle(SALOME_InteractiveObject)& theIO,
94 const bool updateViewer = true,
95 const bool checkActiveViewer = true );
97 void Redisplay ( const Handle(SALOME_InteractiveObject)& theIO,
98 const bool theUpdateViewer,
99 SALOME_View* theViewFrame );
101 void Erase ( const Handle(SALOME_InteractiveObject)& theIO,
102 const bool forced = false,
103 const bool updateViewer = true,
104 SALOME_View* theViewFrame = 0 );
106 void Erase ( GEOM::GEOM_BaseObject_ptr theObj,
107 const bool forced = false,
108 const bool updateViewer = true,
109 SALOME_View* theViewFrame = 0);
111 void EraseWithChildren(const Handle(SALOME_InteractiveObject)& theIO,
112 const bool eraseOnlyChildren = false);
114 /* Display/Erase list of objects methods */
116 void Display ( const SALOME_ListIO& theIOList,
117 const bool updateViewer = true );
119 void Erase ( const SALOME_ListIO& theIOList,
120 const bool forced = false,
121 const bool updateViewer = true );
123 void Redisplay ( const SALOME_ListIO& theIOList,
124 const bool updateViewer = true,
125 const bool checkActiveViewer = true );
127 void Redisplay ( const SALOME_ListIO& theIOList,
128 const bool theUpdateViewer,
129 SALOME_View* theViewFrame );
131 /* build presentation accordint to the current viewer type*/
132 SALOME_Prs* BuildPrs ( GEOM::GEOM_Object_ptr );
133 SALOME_Prs* BuildPrs ( const TopoDS_Shape& );
135 /* Set color for shape displaying. If it is equal -1 then default color is used.
136 Available values are from Quantity_NameOfColor enumeration */
137 void SetColor ( const int );
139 int GetColor () const;
140 bool HasColor () const;
142 /* Set texture for shape displaying. */
143 void SetTexture ( const std::string& );
144 bool HasTexture () const;
145 std::string GetTexture () const;
147 /* Set width for shape displaying. If it is equal -1 then default width is used. */
148 void SetWidth ( const double );
150 double GetWidth () const;
151 bool HasWidth () const;
153 /* Set width for iso-lines displaying. If it is equal -1 then default width is used. */
154 void SetIsosWidth ( const int );
155 int GetIsosWidth () const;
156 bool HasIsosWidth () const;
158 /* Set display mode shape displaying. If it is equal -1 then display mode is used. */
159 int SetDisplayMode( const int );
160 int GetDisplayMode() const;
161 int UnsetDisplayMode();
162 bool HasDisplayMode() const;
164 /* Sets name - for temporary objects only */
165 void SetName( const char* theName );
168 /* Reimplemented from SALOME_Displayer */
169 virtual void Update( SALOME_OCCPrs* );
170 virtual void Update( SALOME_VTKPrs* );
171 virtual void BeforeDisplay( SALOME_View*, const SALOME_OCCPrs* );
172 virtual void AfterDisplay ( SALOME_View*, const SALOME_OCCPrs* );
173 virtual void AfterErase ( SALOME_View*, const SALOME_OCCPrs* );
175 /* This methos is used for activisation/deactivisation of objects to be displayed*/
176 void SetToActivate( const bool );
177 bool ToActivate() const;
179 /* Activate/Deactivate selection*/
180 void LocalSelection( const Handle(SALOME_InteractiveObject)&, const int );
181 void LocalSelection( const SALOME_ListIO& theIOList, const int );
182 void GlobalSelection( const int = GEOM_ALLOBJECTS, const bool = false );
183 void GlobalSelection( const TColStd_MapOfInteger&, const bool = false, const QList<int>* = 0 );
185 SalomeApp_Study* getStudy() const;
187 static SALOMEDS::Color getUniqueColor( const QList<SALOMEDS::Color>& );
188 static SALOMEDS::Color getPredefinedUniqueColor();
190 /*Get color of the geom object*/
191 static SALOMEDS::Color getColor(GEOM::GEOM_Object_var aGeomObject, bool& hasColor);
193 /* Get minimum or maximum enclosed shape type */
194 static int getMinMaxShapeType( const TopoDS_Shape& shape, bool ismin );
196 /* Check if the object is a vertex or a compound of vertices */
197 static bool isCompoundOfVertices( const TopoDS_Shape& theShape );
200 /* Builds presentation of not published object */
201 virtual SALOME_Prs* buildSubshapePresentation(const TopoDS_Shape& aShape,
205 /* Update visibility and parameters of the currently selected field step's color scale */
206 void UpdateColorScale( const bool theIsRedisplayFieldSteps = false, const bool updateViewer = true );
209 /* internal methods */
210 /* Builds presentation according to the current viewer type */
211 virtual SALOME_Prs* buildPresentation( const QString&, SALOME_View* = 0 );
213 /* Sets interactive object */
214 void setIO( const Handle(SALOME_InteractiveObject)& theIO );
217 void setShape( const TopoDS_Shape& theShape );
219 /* Sets field step information */
220 void setFieldStepInfo( const GEOM::field_data_type theFieldDataType,
221 const int theFieldDimension,
222 const QList<QVariant>& theFieldStepData,
223 const TCollection_AsciiString& theFieldStepName,
224 const double theFieldStepRangeMin,
225 const double theFieldStepRangeMax );
227 /* Resets internal data */
228 void internalReset();
230 void clearTemporary( LightApp_SelectionMgr* theSelMgr );
232 SUIT_SelectionFilter* getFilter( const int theMode );
233 SUIT_SelectionFilter* getComplexFilter( const QList<int>* );
235 Quantity_Color qColorFromResources( const QString&, const QColor& );
236 QColor colorFromResources( const QString&, const QColor& );
237 void updateShapeProperties( const Handle(GEOM_AISShape)&, bool );
238 void updateActorProperties( GEOM_Actor*, bool );
239 void updateDimensions( const Handle(SALOME_InteractiveObject)&, SALOME_OCCPrs*, const gp_Ax3& );
241 PropMap getObjectProperties( SalomeApp_Study*, const QString&, SALOME_View* = 0 );
242 PropMap getDefaultPropertyMap();
244 /* Methods for reading the field step information */
245 void readFieldStepInfo( GEOM::GEOM_FieldStep_var theGeomFieldStep );
246 QList<QVariant> groupFieldData( const QList<QVariant>& theFieldStepData,
247 const int theFieldNbComponents,
248 const bool theIsString,
249 double& theFieldStepRangeMin,
250 double& theFieldStepRangeMax );
252 // Note: the method is copied from Aspect_ColorScale class
253 static Standard_Integer HueFromValue( const Standard_Integer aValue,
254 const Standard_Integer aMin,
255 const Standard_Integer aMax );
257 // Note: the method is copied from Aspect_ColorScale class
258 static Standard_Boolean FindColor( const Standard_Real aValue,
259 const Standard_Real aMin,
260 const Standard_Real aMax,
261 const Standard_Integer ColorsCount,
262 Quantity_Color& aColor );
265 Handle(SALOME_InteractiveObject) myIO;
266 TopoDS_Shape myShape;
267 GEOM::field_data_type myFieldDataType;
268 int myFieldDimension;
269 QList<QVariant> myFieldStepData;
270 TCollection_AsciiString myFieldStepName;
271 double myFieldStepRangeMin;
272 double myFieldStepRangeMax;
274 std::string myTexture;
276 SALOME_View* myViewFrame;
279 Quantity_Color myShadingColor;
285 bool myHasDisplayMode;
286 Aspect_TypeOfMarker myTypeOfMarker;
287 double myScaleOfMarker;
290 SalomeApp_Application* myApp;
291 friend class GEOM_Swig;
294 #endif // GEOM_DISPLAYER_H