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.
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.
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
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROData_Channel_HeaderFile
20 #define HYDROData_Channel_HeaderFile
22 #include "HYDROData_ArtificialObject.h"
24 #include <TopoDS_Face.hxx>
25 #include <TopoDS_Wire.hxx>
27 class Handle(HYDROData_Polyline3D);
28 class Handle(HYDROData_Profile);
29 class TopTools_SequenceOfShape;
30 class TopTools_ListOfShape;
32 DEFINE_STANDARD_HANDLE(HYDROData_Channel, HYDROData_ArtificialObject)
34 /**\class HYDROData_Channel
38 class HYDROData_Channel : public HYDROData_ArtificialObject
46 TopoDS_Wire myLeftBank;
47 TopoDS_Wire myRightBank;
54 * Enumeration of tags corresponding to the persistent object parameters.
58 DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
65 DEFINE_STANDARD_RTTI(HYDROData_Channel);
70 * Creates the presentations(2D and 3D) by given guide line and profile.
72 HYDRODATA_EXPORT static bool CreatePresentations( const Handle(HYDROData_Polyline3D)& theGuideLine,
73 const Handle(HYDROData_Profile)& theProfile,
74 PrsDefinition& thePrs );
79 * Returns the kind of this object. Must be redefined in all objects of known type.
81 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_CHANNEL;}
84 * Dump object to Python script representation.
86 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
89 * Returns the list of all reference objects of this object.
91 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
94 * Returns the top shape of the object.
96 HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
99 * Returns the 3d shape of the object.
101 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
104 * Returns the left edge of the channel.
106 HYDRODATA_EXPORT virtual TopoDS_Shape GetLeftShape() const;
109 * Returns the right edge of the channel.
111 HYDRODATA_EXPORT virtual TopoDS_Shape GetRightShape() const;
114 * Update the shape presentations of stream.
115 * Call this method whenever you made changes for channel data.
117 HYDRODATA_EXPORT virtual void Update();
120 * Checks that object has 2D presentation. Reimlemented to retun true.
122 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
125 * Returns default filling color for new channel.
127 HYDRODATA_EXPORT static QColor DefaultFillingColor();
130 * Returns default border color for new channel.
132 HYDRODATA_EXPORT static QColor DefaultBorderColor();
136 // Public methods to work with Channel
139 * Sets reference guide line object for channel.
141 HYDRODATA_EXPORT virtual bool SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine );
144 * Returns reference guide line object of channel.
146 HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetGuideLine() const;
149 * Remove reference guide line object from channel.
151 HYDRODATA_EXPORT virtual void RemoveGuideLine();
155 * Sets reference profile object for channel.
157 HYDRODATA_EXPORT virtual bool SetProfile( const Handle(HYDROData_Profile)& theProfile );
160 * Returns reference profile object of channel.
162 HYDRODATA_EXPORT virtual Handle(HYDROData_Profile) GetProfile() const;
165 * Remove reference profile object from channel.
167 HYDRODATA_EXPORT virtual void RemoveProfile();
173 * Returns default filling color for new object.
175 HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
178 * Returns default border color for new object.
180 HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
183 * Returns the type of child altitude object.
184 * Reimplemented to create chanel altitude object.
186 HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
190 friend class HYDROData_Iterator;
193 * Creates new object in the internal data structure. Use higher level objects
194 * to create objects with real content.
196 HYDRODATA_EXPORT HYDROData_Channel();
199 * Destructs properties of the object and object itself, removes it from the document.
201 virtual HYDRODATA_EXPORT ~HYDROData_Channel();