]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_Channel.h
Salome HOME
copyrights in HYDRO files are updated
[modules/hydro.git] / src / HYDROData / HYDROData_Channel.h
1 // Copyright (C) 2007-2015  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 HYDROData_Channel_HeaderFile
24 #define HYDROData_Channel_HeaderFile
25
26 #include "HYDROData_ArtificialObject.h"
27
28 #include <TopoDS_Face.hxx>
29 #include <TopoDS_Wire.hxx>
30
31 class Handle(HYDROData_Polyline3D);
32 class Handle(HYDROData_Profile);
33 class TopTools_SequenceOfShape;
34 class TopTools_ListOfShape;
35
36 DEFINE_STANDARD_HANDLE(HYDROData_Channel, HYDROData_ArtificialObject)
37
38 /**\class HYDROData_Channel
39  * \brief 
40  *
41  */
42 class HYDROData_Channel : public HYDROData_ArtificialObject
43 {
44 public:
45
46   struct PrsDefinition
47   {
48     TopoDS_Shape myPrs3D;
49     TopoDS_Face  myPrs2D;
50     TopoDS_Wire  myLeftBank;
51     TopoDS_Wire  myRightBank;
52     TopoDS_Wire  myInlet;
53     TopoDS_Wire  myOutlet;
54   };
55
56 protected:
57   /**
58    * Enumeration of tags corresponding to the persistent object parameters.
59    */
60   enum DataTag
61   {
62     DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
63     DataTag_GuideLine, 
64     DataTag_Profile,
65   };
66
67 public:
68
69   DEFINE_STANDARD_RTTI(HYDROData_Channel);
70
71 public:
72
73   /**
74    * Creates the presentations(2D and 3D) by given guide line and profile.
75    */
76   HYDRODATA_EXPORT static bool CreatePresentations( const Handle(HYDROData_Polyline3D)& theGuideLine,
77                                                     const Handle(HYDROData_Profile)&    theProfile,
78                                                     PrsDefinition&                      thePrs );
79
80 public:
81
82   /**
83    * Returns the kind of this object. Must be redefined in all objects of known type.
84    */
85   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_CHANNEL;}
86
87   /**
88    * Dump object to Python script representation.
89    */
90   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
91
92   /**
93    * Returns the list of all reference objects of this object.
94    */
95   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
96
97   /**
98    * Returns the top shape of the object.
99    */
100   HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
101
102   /**
103    * Returns the 3d shape of the object.
104    */
105   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
106
107   /**
108    * Update the shape presentations of stream.
109    * Call this method whenever you made changes for channel data.
110    */
111   HYDRODATA_EXPORT virtual void Update();
112
113   /**
114    * Checks that object has 2D presentation. Reimlemented to retun true.
115    */
116   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
117
118   /**
119    * Returns default filling color for new channel.
120    */
121   HYDRODATA_EXPORT static QColor DefaultFillingColor();
122
123   /**
124    * Returns default border color for new channel.
125    */
126   HYDRODATA_EXPORT static QColor DefaultBorderColor();
127
128
129 public:      
130   // Public methods to work with Channel
131   
132   /**
133    * Sets reference guide line object for channel.
134    */
135   HYDRODATA_EXPORT virtual bool SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine );
136
137   /**
138    * Returns reference guide line object of channel.
139    */
140   HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetGuideLine() const;
141
142   /**
143    * Remove reference guide line object from channel.
144    */
145   HYDRODATA_EXPORT virtual void RemoveGuideLine();
146
147
148   /**
149    * Sets reference profile object for channel.
150    */
151   HYDRODATA_EXPORT virtual bool SetProfile( const Handle(HYDROData_Profile)& theProfile );
152
153   /**
154    * Returns reference profile object of channel.
155    */
156   HYDRODATA_EXPORT virtual Handle(HYDROData_Profile) GetProfile() const;
157
158   /**
159    * Remove reference profile object from channel.
160    */
161   HYDRODATA_EXPORT virtual void RemoveProfile();
162
163
164 protected:
165
166   /**
167    * Returns default filling color for new object.
168    */
169   HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
170
171   /**
172    * Returns default border color for new object.
173    */
174   HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
175
176   /**
177    * Returns the type of child altitude object.
178    * Reimplemented to create chanel altitude object.
179    */
180   HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
181
182 protected:
183
184   friend class HYDROData_Iterator;
185
186   /**
187    * Creates new object in the internal data structure. Use higher level objects 
188    * to create objects with real content.
189    */
190   HYDRODATA_EXPORT HYDROData_Channel();
191
192   /**
193    * Destructs properties of the object and object itself, removes it from the document.
194    */
195   virtual HYDRODATA_EXPORT ~HYDROData_Channel();
196 };
197
198 #endif