]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_Object.h
Salome HOME
3b653ce773979455844256d81b1983b459a8443c
[modules/hydro.git] / src / HYDROData / HYDROData_Object.h
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.
6 //
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.
11 //
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
15 //
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
17 //
18
19 #ifndef HYDROData_Object_HeaderFile
20 #define HYDROData_Object_HeaderFile
21
22 #include <HYDROData_Entity.h>
23
24 DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity)
25
26 class TopoDS_Shape;
27 class Handle(HYDROData_IAltitudeObject);
28 class Handle(HYDROData_DummyObject3D);
29 class Handle(HYDROData_ShapesGroup);
30
31 /**\class HYDROData_Object
32  * \brief The base class for all geometrical objects in the HYDRO module.
33  *
34  */
35 class HYDROData_Object : public HYDROData_Entity
36 {
37 protected:
38   /**
39    * Enumeration of tags corresponding to the persistent object parameters.
40    */
41   enum DataTag
42   {
43     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
44     DataTag_TopShape,
45     DataTag_Shape3D,
46     DataTag_AltitudeObject,      ///< reference altitude object
47     DataTag_FillingColor,        ///< filling color of geometrical object
48     DataTag_BorderColor,         ///< border color of geometrical object
49     DataTag_Object3D,            ///< child 3D object
50     DataTag_EdgesGroup,          ///< child group objects
51     DataTag_ChildAltitudeObject, ///< child altitude object
52     DataTag_IsSubmersible,       ///< the attribute "is submersible"
53   };
54
55 public:
56   DEFINE_STANDARD_RTTI(HYDROData_Object);
57
58   /**
59    * Updates the name of this object.
60    * Reimplemented to update the names child groups.
61    */
62   HYDRODATA_EXPORT virtual void SetName( const QString& theName );
63
64   /**
65    * Update the geometry object.
66    * Call this method whenever you made changes for object data.
67    */
68   HYDRODATA_EXPORT virtual void Update();
69
70   /**
71    * Returns the list of all reference objects of this object.
72    */
73   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
74
75   /**
76    * Sets the "MustBeUpdated" flag: if object is depended on updated features.
77    * Reimplemented to update the state of child 3D object.
78    */
79   HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
80
81
82   /**
83    * Sets the top(2d projection) shape of the object.
84    */
85   HYDRODATA_EXPORT virtual void SetTopShape( const TopoDS_Shape& theShape );
86
87   /**
88    * Returns the top shape of the object.
89    */
90   HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
91
92   /**
93    * Sets the 3d shape of the object.
94    */
95   HYDRODATA_EXPORT virtual void SetShape3D( const TopoDS_Shape& theShape );
96
97   /**
98    * Returns the 3d shape of the object.
99    */
100   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
101
102   /**
103    * Returns reference object which represent the 3D shape of object.
104    */
105   HYDRODATA_EXPORT virtual Handle(HYDROData_DummyObject3D) GetObject3D() const;
106
107
108   /**
109    * Returns sequence of object groups.
110    */
111   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGroups() const;
112
113   /**
114    * Returns group data model object by it id.
115    */
116   HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) GetGroup( const int theGroupId ) const;
117
118   /**
119    * Returns group id by data model object.
120    */
121   HYDRODATA_EXPORT virtual int GetGroupId( const Handle(HYDROData_ShapesGroup)& theGroup ) const;
122
123
124   /**
125    * Set reference altitude object for geometry object.
126    */
127   HYDRODATA_EXPORT virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude );
128
129   /**
130    * Returns reference altitude object of geometry object.
131    */
132   HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetAltitudeObject() const;
133
134   /**
135    * Clear the reference altitude object for geometry object.
136    */
137   HYDRODATA_EXPORT virtual void RemoveAltitudeObject();
138
139
140    /**
141    * Sets filling color for object.
142    */
143   HYDRODATA_EXPORT virtual void SetFillingColor( const QColor& theColor );
144
145   /**
146    * Returns filling color of object.
147    */
148   HYDRODATA_EXPORT virtual QColor GetFillingColor() const;
149
150    /**
151    * Sets border color for object.
152    */
153   HYDRODATA_EXPORT virtual void SetBorderColor( const QColor& theColor );
154
155   /**
156    * Returns border color of object.
157    */
158   HYDRODATA_EXPORT virtual QColor GetBorderColor() const;
159
160   HYDRODATA_EXPORT bool IsSubmersible() const;
161   HYDRODATA_EXPORT void SetIsSubmersible( bool ) const;
162
163 protected:
164
165   /**
166    * Creates new object in the internal data structure. Use higher level objects 
167    * to create objects with real content.
168    */
169   HYDRODATA_EXPORT HYDROData_Object();
170
171   /**
172    * Destructs properties of the object and object itself, removes it from the document.
173    */
174   virtual HYDRODATA_EXPORT ~HYDROData_Object();
175
176 protected:
177   HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
178   HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
179
180   /**
181    * Dump the initial object creation to a Python script.
182    * Reimplemented to dump the object colors.
183    */
184   HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
185
186
187   /**
188    * Checks and if necessary create child 3D object.
189    * Reimplement this function in your subclass if you 
190    * do not want to create child 3D object.
191    */
192   HYDRODATA_EXPORT virtual void checkAndSetObject3D();
193
194
195   /**
196    * Returns the type of child altitude object.
197    * Base implementation returns KIND_UNKNOWN, it means that child altitude 
198    * object will not be created inside of checkAndSetAltitudeObject() function.
199    * Reimplement this function in your subclass an return correct altitude
200    * object type if you want to create child altitude object.
201    */
202   HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
203
204   /**
205    * Checks and if necessary create child altitude object.
206    */
207   HYDRODATA_EXPORT virtual void checkAndSetAltitudeObject();
208
209   /**
210    * Return the child altitude object.
211    */
212   HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) getChildAltitudeObject() const;
213
214
215   /**
216    * Create new one child group object.
217    */
218   HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject();
219
220   /**
221    * Remove all child group objects.
222    */
223   HYDRODATA_EXPORT virtual void RemoveGroupObjects();
224
225   /**
226    * Removes the top shape from data label of the object.
227    */
228   HYDRODATA_EXPORT void RemoveTopShape();
229
230   /**
231    * Removes the 3d shape from data label of the object.
232    */
233   HYDRODATA_EXPORT void RemoveShape3D();
234 };
235
236 #endif