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_PolylineXY_HeaderFile
20 #define HYDROData_PolylineXY_HeaderFile
22 #include "HYDROData_IPolyline.h"
24 DEFINE_STANDARD_HANDLE(HYDROData_PolylineXY, HYDROData_IPolyline)
31 /**\class HYDROData_PolylineXY
32 * \brief Class that stores/retreives information about the
33 * parametric profile points.
35 class HYDROData_PolylineXY : public HYDROData_IPolyline
39 * Enumeration of tags corresponding to the persistent object parameters.
43 DataTag_First = HYDROData_IPolyline::DataTag_First + 100, ///< first tag, to reserve
44 DataTag_GeomObjectEntry, ///< study entry of the imported GEOM object
48 DEFINE_STANDARD_RTTI(HYDROData_PolylineXY);
52 * Returns the kind of this object. Must be redefined in all objects of known type.
54 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_POLYLINEXY;}
57 * Dump object to Python script representation.
59 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
62 * Update the wire contour on the basis of the polyline data.
63 * Call this method whenever you made changes for polyline data.
65 HYDRODATA_EXPORT virtual void Update();
67 HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
70 * Checks that object has 2D presentation. Reimlemented to retun true.
72 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
75 * Returns data of object wrapped to QVariant.
76 * Reimplemented to wrap and return saved path.
78 HYDRODATA_EXPORT virtual QVariant GetDataVariant();
81 * Returns default wire color for new polyline.
83 HYDRODATA_EXPORT static QColor DefaultWireColor();
88 * Returns the presentation of polyline section in CAS maner.
90 HYDRODATA_EXPORT static TopoDS_Wire BuildWire( const SectionType& theType,
91 const bool& theIsClosed,
92 const NCollection_Sequence<gp_XYZ>& thePoints );
95 * Returns the presentation of polyline section in Qt maner.
97 HYDRODATA_EXPORT static void BuildPainterPath( QPainterPath& thePath,
98 const SectionType& theType,
99 const bool& theIsClosed,
100 const NCollection_Sequence<gp_XYZ>& thePoints );
105 * Imports shape from IOR.
106 * \param theIOR the IOR of Geom object
107 * \return \c true if shape has been successfully imported
109 HYDRODATA_EXPORT virtual bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );
112 * Stores the study entry of the imported GEOM object.
113 * \param theEntry GEOM object entry
115 HYDRODATA_EXPORT void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );
118 * Returns the imported GEOM object entry.
120 HYDRODATA_EXPORT TCollection_AsciiString GetGeomObjectEntry() const;
125 * Returns the 2D presentation of all points.
127 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
130 * Returns the 3D presentation of all points.
132 HYDRODATA_EXPORT virtual bool ImportShape( const TopoDS_Shape& theShape );
136 * Returns flag indicating that polyline can be edited or not.
138 HYDRODATA_EXPORT virtual bool IsEditable() const;
142 * Returns true if polyline is closed
143 * \param theIsSimpleCheck flag indicating the type of checking
144 * - if true then all wires checked on closures
145 * - if false then for positive result polyline should consist of
146 * only one wire and which must be closed
148 HYDRODATA_EXPORT bool IsClosed( const bool theIsSimpleCheck = true ) const;
151 * Returns the distance beetwen first and point with index thePointIndex
152 * at the section with index theSectionIndex. -1 is returned if error is occurred.
154 HYDRODATA_EXPORT double GetDistance( const int theSectionIndex,
155 const int thePointIndex ) const;
159 * Returns number of sections.
161 HYDRODATA_EXPORT virtual int NbSections() const;
164 * Adds new one section.
165 * \param theSectName name of the section
166 * \param theSectionType type of section
167 * \param theIsClosed flag indicates closures of section
169 HYDRODATA_EXPORT virtual void AddSection( const TCollection_AsciiString& theSectName,
170 const SectionType theSectionType,
171 const bool theIsClosed );
174 * Returns name of section with given index.
175 * \param theSectionIndex index of section
177 HYDRODATA_EXPORT virtual TCollection_AsciiString GetSectionName( const int theSectionIndex ) const;
180 * Set name for section with given index.
181 * \param theSectionIndex index of section
182 * \param theSectionName new section name
184 HYDRODATA_EXPORT virtual void SetSectionName( const int theSectionIndex,
185 const TCollection_AsciiString& theSectionName );
188 * Returns type of section with given index.
189 * \param theSectionIndex index of section
191 HYDRODATA_EXPORT virtual SectionType GetSectionType( const int theSectionIndex ) const;
194 * Set type for section with given index.
195 * \param theSectionIndex index of section
196 * \param theSectionType new section type
198 HYDRODATA_EXPORT virtual void SetSectionType( const int theSectionIndex,
199 const SectionType theSectionType );
202 * Returns true if section with given index is closed.
203 * \param theSectionIndex index of section
205 HYDRODATA_EXPORT virtual bool IsClosedSection( const int theSectionIndex ) const;
208 * Set closed flag for section with given index.
209 * \param theSectionIndex index of section
210 * \param theIsClosed new closures state
212 HYDRODATA_EXPORT virtual void SetSectionClosed( const int theSectionIndex,
213 const bool theIsClosed );
216 * Adds new one section.
217 * \param theSectName name of the section
218 * \param theSectionType type of section
219 * \param theIsClosed flag indicates closures of section
221 HYDRODATA_EXPORT virtual void GetSections( NCollection_Sequence<TCollection_AsciiString>& theSectNames,
222 NCollection_Sequence<SectionType>& theSectTypes,
223 NCollection_Sequence<bool>& theSectClosures ) const;
226 * Removes section with given index.
227 * \param theSectionIndex index of section
229 HYDRODATA_EXPORT virtual void RemoveSection( const int theSectionIndex );
232 * Removes all sections.
234 HYDRODATA_EXPORT virtual void RemoveSections();
238 * Adds new point for section with index "theSectionIndex".
239 * \param theSectionIndex index of section
240 * \param thePoint point to add
241 * \param theBeforeIndex if not equal -1 then insert point in this pos
243 HYDRODATA_EXPORT virtual void AddPoint( const int theSectionIndex,
244 const Point& thePoint,
245 const int thePointIndex = -1 );
248 * Replaces point for section with index "theSectionIndex".
249 * \param theSectionIndex index of section
250 * \param thePoint new point
251 * \param thePointIndex index of point to replace
253 HYDRODATA_EXPORT virtual void SetPoint( const int theSectionIndex,
254 const Point& thePoint,
255 const int thePointIndex );
258 * Replaces point for section with index "theSectionIndex".
259 * \param theSectionIndex index of section
260 * \param thePoints new points
262 HYDRODATA_EXPORT virtual void SetPoints( const int theSectionIndex,
263 const PointsList& thePoints );
266 * Removes point from section with index "theSectionIndex".
267 * \param theSectionIndex index of section
268 * \param thePointIndex index of point
270 HYDRODATA_EXPORT virtual void RemovePoint( const int theSectionIndex,
271 const int thePointIndex );
275 * Returns list of points.
276 * \param theSectionIndex if not equal -1 then list of points returned
277 * only for section with this index
278 * \return list of points
280 HYDRODATA_EXPORT virtual PointsList GetPoints( const int theSectionIndex = -1 ) const;
284 * Returns the painter path.
285 * Note: currently only the first section of the polyline data is taken into account.
286 * \return polyline painter path.
288 HYDRODATA_EXPORT virtual QPainterPath GetPainterPath() const;
291 * Transform the polyline points.
292 * @param theTrsf the transformation
294 HYDRODATA_EXPORT void Transform( const QTransform& theTrsf );
299 * Sets the flag indicating that polyline can be edited or not.
301 HYDRODATA_EXPORT virtual void setEditable( const bool theIsEditable );
305 friend class HYDROData_Profile;
306 friend class HYDROData_Iterator;
309 * Creates new object in the internal data structure. Use higher level objects
310 * to create objects with real content.
312 HYDRODATA_EXPORT HYDROData_PolylineXY();
315 * Destructs properties of the object and object itself, removes it from the document.
317 HYDRODATA_EXPORT ~HYDROData_PolylineXY();