Salome HOME
d225d7cbbdc5df0c1873f22d5d651212e392c6b9
[modules/geom.git] / src / OBJECT / GEOM_AISShape.hxx
1 // Copyright (C) 2007-2023  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
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.
10 //
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.
15 //
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
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 #ifndef _GEOM_AISShape_HeaderFile
24 #define _GEOM_AISShape_HeaderFile
25
26 #include <SALOME_AISShape.hxx>
27 #include <SALOME_InteractiveObject.hxx>
28
29 #include <Standard.hxx>
30 #include <Standard_DefineHandle.hxx>
31 #include <PrsMgr_PresentationManager.hxx>
32 #include <TCollection_AsciiString.hxx>
33 #include <AIS_DisplayMode.hxx>
34
35 #include <QList>
36 #include <QVariant>
37
38 #include <SALOMEconfig.h>
39 #include CORBA_SERVER_HEADER(GEOM_Gen)
40
41 class TopoDS_Shape;
42
43 class GEOM_AISShape : public SALOME_AISShape
44 {
45 public:
46   //! Enumeration of display modes
47   typedef enum {
48     Wireframe        = AIS_WireFrame,       //!< wireframe
49     Shading          = AIS_Shaded,          //!< shadin
50     ShadingWithEdges,                       //!< shading with edges
51     TexturedShape,                          //!< texture
52     CustomHighlight                         //!< fields
53   } DispMode;
54
55   //! Enumeration of top level display modes
56   typedef enum {
57     TopShowAdditionalWActor = 0,
58     TopKeepCurrent, //!< Keep current display mode
59     TopWireFrame, 
60     TopShading, 
61     TopShadingWithEdges,
62   } TopLevelDispMode;
63   
64   Standard_EXPORT GEOM_AISShape(const TopoDS_Shape& shape, const Standard_CString aName);
65   Standard_EXPORT ~GEOM_AISShape();
66
67   Standard_EXPORT Standard_Boolean                 hasIO();
68   Standard_EXPORT void                             setIO(const Handle(SALOME_InteractiveObject)& name);
69   Standard_EXPORT Handle(SALOME_InteractiveObject) getIO();
70
71   Standard_EXPORT void             setName(const Standard_CString aName);
72   Standard_EXPORT Standard_CString getName();
73
74   Standard_EXPORT Standard_Boolean isTopLevel();
75   Standard_EXPORT void setTopLevel(Standard_Boolean);
76
77   Standard_EXPORT void highlightSubShapes(const TColStd_IndexedMapOfInteger& aIndexMap, const Standard_Boolean aHighlight );
78   
79   Standard_Boolean AcceptDisplayMode(const Standard_Integer theMode) const;
80
81   Standard_EXPORT void SetShadingColor(const Quantity_Color &aCol);
82   Standard_EXPORT void SetEdgesInShadingColor(const Quantity_Color &aCol);
83   Standard_EXPORT void SetLabelColor(const Quantity_Color &aCol);
84   Standard_EXPORT void SetDisplayVectors(bool isShow);
85   Standard_EXPORT void SetDisplayVertices(bool isShow);
86   Standard_EXPORT void SetDisplayName(bool isShow);
87
88   Standard_EXPORT virtual void Compute(const Handle(PrsMgr_PresentationManager3d)& aPresentationManager,
89                                        const Handle(Prs3d_Presentation)& aPresentation,
90                                        const Standard_Integer aMode = 0);
91   
92   Standard_EXPORT virtual bool isShowVectors() { return myDisplayVectors; }
93   Standard_EXPORT virtual bool isShowVertices() { return myDisplayVertices; }
94   Standard_EXPORT virtual bool isShowName() { return myDisplayName; }
95
96   Standard_EXPORT virtual Standard_Boolean switchTopLevel();
97   Standard_EXPORT virtual Standard_Boolean toActivate();
98         
99   Standard_EXPORT static Quantity_Color topLevelColor();
100   Standard_EXPORT static void           setTopLevelColor(const Quantity_Color c);
101
102   Standard_EXPORT static TopLevelDispMode topLevelDisplayMode();
103   Standard_EXPORT static void             setTopLevelDisplayMode(const TopLevelDispMode dm);
104
105   Standard_EXPORT void setPrevDisplayMode(const Standard_Integer mode);
106   Standard_EXPORT Standard_Integer prevDisplayMode() const {return myPrevDisplayMode;}
107
108   // Field step information
109   Standard_EXPORT void setFieldStepInfo( const GEOM::field_data_type theFieldDataType,
110                                          const int theFieldDimension,
111                                          const QList<QVariant>& theFieldStepData,
112                                          const TCollection_AsciiString& theFieldStepName,
113                                          const double theFieldStepRangeMin,
114                                          const double theFieldStepRangeMax );
115   Standard_EXPORT void getFieldStepInfo( GEOM::field_data_type& theFieldDataType,
116                                          int& theFieldDimension,
117                                          QList<QVariant>& theFieldStepData,
118                                          TCollection_AsciiString& theFieldStepName,
119                                          double& theFieldStepRangeMin,
120                                          double& theFieldStepRangeMax ) const;
121
122 protected: 
123   Standard_EXPORT void shadingMode(const Handle(PrsMgr_PresentationManager3d)& aPresentationManager,
124                                    const Handle(Prs3d_Presentation)& aPrs,
125                                    const Standard_Integer aMode);
126   
127   // Displaying the field data
128   Standard_EXPORT void drawField( const Handle(Prs3d_Presentation)& thePrs,
129                                   const bool theIsText = false,
130                                   const bool theIsHighlight = false );
131   
132   // Displaying the name of shape
133   Standard_EXPORT void drawName( const Handle(Prs3d_Presentation)& thePrs );
134
135   // Auxiliary method to compute a center of mass for the specified shape
136   Standard_EXPORT static Standard_Boolean computeMassCenter( const TopoDS_Shape& theShape,
137                                                              gp_Pnt& theCenter );
138   
139 private: 
140   Quantity_Color           myShadingColor;
141   Quantity_Color           myEdgesInShadingColor;
142   Quantity_Color           myLabelColor;
143
144   TCollection_AsciiString  myName;
145   bool                     myDisplayVectors;
146   bool                     myDisplayVertices;
147   bool                     myDisplayName;
148   Standard_Boolean         myTopLevel;
149   Standard_Integer         myPrevDisplayMode;
150
151   GEOM::field_data_type    myFieldDataType;
152   int                      myFieldDimension;
153   QList<QVariant>          myFieldStepData;
154   TCollection_AsciiString  myFieldStepName;
155   double                   myFieldStepRangeMin;
156   double                   myFieldStepRangeMax;
157
158   static TopLevelDispMode  myTopLevelDm;
159   static Quantity_Color    myTopLevelColor;
160
161 public:
162   DEFINE_STANDARD_RTTIEXT(GEOM_AISShape, SALOME_AISShape)
163 };
164
165 DEFINE_STANDARD_HANDLE(GEOM_AISShape, SALOME_AISShape)
166
167 #endif