]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_ImmersibleZone.h
Salome HOME
Merge branch 'BR_LAND_COVER_MAP' of ssh://git.salome-platform.org/modules/hydro into...
[modules/hydro.git] / src / HYDROData / HYDROData_ImmersibleZone.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_ImmersibleZone_HeaderFile
20 #define HYDROData_ImmersibleZone_HeaderFile
21
22 #include <HYDROData_NaturalObject.h>
23
24 DEFINE_STANDARD_HANDLE(HYDROData_ImmersibleZone, HYDROData_NaturalObject)
25
26 class Handle(HYDROData_PolylineXY);
27
28 /**\class HYDROData_ImmersibleZone
29  * \brief 
30  *
31  */
32 class HYDROData_ImmersibleZone : public HYDROData_NaturalObject
33 {
34 protected:
35   /**
36    * Enumeration of tags corresponding to the persistent object parameters.
37    */
38   enum DataTag
39   {
40     DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve
41     DataTag_Polyline,     ///< reference polyline
42 };
43
44 public:
45   DEFINE_STANDARD_RTTI(HYDROData_ImmersibleZone);
46
47   /**
48    * Returns the kind of this object. Must be redefined in all objects of known type.
49    */
50   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_IMMERSIBLE_ZONE;}
51
52   /**
53    * Dump object to Python script representation.
54    */
55   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
56
57   /**
58    * Returns the list of all reference objects of this object.
59    */
60   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
61
62   /**
63    * Update the immersible zone object.
64    * Call this method whenever you made changes for object data.
65    */
66   HYDRODATA_EXPORT virtual void Update();
67
68   /**
69    * Checks that object has 2D presentation. Reimlemented to retun true.
70    */
71   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
72
73   /**
74    * Returns the 3d shape of the object.
75    */
76   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
77
78   /**
79    * Returns default filling color for new zone.
80    */
81   HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
82
83   /**
84    * Returns default border color for new zone.
85    */
86   HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
87
88   /**
89    * Sets reference polyline object for zone.
90    */
91   HYDRODATA_EXPORT virtual void SetPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
92
93   /**
94    * Returns reference polyline object of zone.
95    */
96   HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetPolyline() const;
97
98   /**
99    * Remove reference polyline object of zone.
100    */
101   HYDRODATA_EXPORT virtual void RemovePolyline();
102
103   HYDRODATA_EXPORT TopoDS_Shape generateTopShape() const;
104   HYDRODATA_EXPORT static TopoDS_Shape generateTopShape( const Handle(HYDROData_PolylineXY)& );
105
106 private:
107
108   /**
109    * Create all necessary child group objects.
110    */
111   HYDRODATA_EXPORT void createGroupObjects();
112
113 protected:
114
115   friend class HYDROData_Iterator;
116
117   /**
118    * Creates new object in the internal data structure. Use higher level objects 
119    * to create objects with real content.
120    */
121   HYDRODATA_EXPORT HYDROData_ImmersibleZone();
122
123   /**
124    * Destructs properties of the object and object itself, removes it from the document.
125    */
126   virtual HYDRODATA_EXPORT ~HYDROData_ImmersibleZone();
127 };
128
129 #endif