1 // Copyright (C) 2013-2019 CEA/DEN, EDF R&D, OPEN CASCADE
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 // File: CurveCreator_Curve.hxx
21 // Author: Sergey KHROMOV
23 #ifndef _CurveCreator_Curve_HeaderFile
24 #define _CurveCreator_Curve_HeaderFile
26 #include "CurveCreator_ICurve.hxx"
28 #include "CurveCreator_Macro.hxx"
29 #include "CurveCreator.hxx"
30 #include "CurveCreator_Diff.hxx"
35 struct CurveCreator_Section;
36 class CurveCreator_Displayer;
38 class AIS_InteractiveObject;
42 * The CurveCreator_Curve object is represented as one or more sets of
43 * connected points; thus CurveCreator_Curve object can contain several
44 * not connected curves (polylines or b-splines), each such curve has two
45 * only ends "start and end points" in other words non-manifold curves
48 class CURVECREATOR_EXPORT CurveCreator_Curve : public CurveCreator_ICurve
51 typedef std::list<CurveCreator_Diff> ListDiff;
54 //! Constructor of the curve.
55 /** The dimension is explicitly specified in the constructor
56 * and cannot be changed later.
58 CurveCreator_Curve(const CurveCreator::Dimension theDimension);
61 virtual ~CurveCreator_Curve();
63 //! Get the dimension.
64 virtual CurveCreator::Dimension getDimension() const;
66 //! Return unique section name
67 virtual std::string getUniqSectionName() const;
69 //! Set curve creator Displayer object
70 virtual void setDisplayer( CurveCreator_Displayer* theDisplayer );
72 //! Return curve creator Displayer object
73 CurveCreator_Displayer* getDisplayer();
75 //! Remove curve creator Displayer object
76 virtual void removeDisplayer();
78 /** Set depth of undo operations (unlimited if \a theDepth is -1
79 * or disabled if \a theDepth is 0)
81 virtual void setUndoDepth(const int theDepth = -1);
83 //! Get depth of undo operations.
84 virtual int getUndoDepth() const;
86 virtual void startOperation();
87 virtual void finishOperation();
90 * This method converts the point index to the index in
91 * an array of coordinates.
93 virtual int toICoord(const int theIPnt) const;
95 //! For internal use only! Undo/Redo are not used here.
96 virtual bool moveSectionInternal(const int theISection,
97 const int theNewIndex);
98 //! Move section to new position in list
99 virtual bool moveSection(const int theISection,
100 const int theNewIndex);
103 /** This method updates all undo/redo information required to be updated
104 * after curve modification operation. It returns false if undo/redo
105 * is disabled and true otherwise.
107 virtual bool addEmptyDiff();
109 public: // TODO: remove public
110 void getCoordinates( int theISection, int theIPoint, double& theX, double& theY, double& theZ ) const;
111 protected: // TODO: remove public
112 void redisplayCurve(bool preEraseAllObjects = true);
115 /************ Implementation of INTERFACE methods ************/
117 /***********************************************/
118 /*** Undo/Redo methods ***/
119 /***********************************************/
121 //! Get number of available undo operations
122 virtual int getNbUndo() const;
124 //! Undo previous operation
127 //! Get number of available redo operations
128 virtual int getNbRedo() const;
130 //! Redo last previously "undone" operation
134 /***********************************************/
135 /*** Section methods ***/
136 /***********************************************/
138 //! For internal use only! Undo/Redo are not used here.
139 virtual bool clearInternal();
140 //! Clear the polyline (remove all sections)
141 virtual bool clear();
143 //! set erase-all state
144 //! if true => erase all objects from viever, else remove only the current curve
145 void SetEraseAllState(bool toEraseAll);
147 //! get erase-all state
148 //! if true => erase all objects from viever, else remove only the current curve
149 bool GetEraseAllState() const;
151 //! For internal use only! Undo/Redo are not used here.
152 virtual bool joinInternal( const std::list<int>& theSections );
154 //! Join list of sections to one section (join all if the list is empty)
155 // The first section in the list is a leader, another sections are joined to it
156 virtual bool join( const std::list<int>& theSections );
158 //! Get number of sections
159 virtual int getNbSections() const;
161 //! For internal use only! Undo/Redo are not used here.
162 virtual int addSectionInternal( const std::string &theName,
163 const CurveCreator::SectionType theType,
164 const bool theIsClosed,
165 const CurveCreator::Coordinates &thePoints);
166 //! Add a new section.
167 virtual int addSection( const std::string &theName,
168 const CurveCreator::SectionType theType,
169 const bool theIsClosed );
170 //! Add a new section.
171 virtual int addSection( const std::string &theName,
172 const CurveCreator::SectionType theType,
173 const bool theIsClosed,
174 const CurveCreator::Coordinates &thePoints);
176 //! For internal use only! Undo/Redo are not used here.
177 virtual bool removeSectionInternal( const int theISection );
178 //! Removes the given sections.
179 virtual bool removeSection( const int theISection );
181 //! Get "closed" flag of the specified section
182 virtual bool isClosed( const int theISection ) const;
184 //! For internal use only! Undo/Redo are not used here.
185 virtual bool setClosedInternal( const int theISection,
186 const bool theIsClosed );
188 * Set "closed" flag of the specified section (all sections if
189 * \a theISection is -1).
191 virtual bool setClosed( const int theISection,
192 const bool theIsClosed );
194 //! Returns specifyed section name
195 virtual std::string getSectionName( const int theISection ) const;
197 //! For internal use only! Undo/Redo are not used here.
198 virtual bool setSectionNameInternal( const int theISection,
199 const std::string& theName );
200 /** Set name of the specified section */
201 virtual bool setSectionName( const int theISection,
202 const std::string& theName );
204 //! Get type of the specified section
205 virtual CurveCreator::SectionType getSectionType( const int theISection ) const;
207 //! For internal use only! Undo/Redo are not used here.
208 virtual bool setSectionTypeInternal( const int theISection,
209 const CurveCreator::SectionType theType );
211 * Set type of the specified section (or all sections
212 * if \a theISection is -1).
214 virtual bool setSectionType( const int theISection,
215 const CurveCreator::SectionType theType );
217 //! A virtual method.
218 const CurveCreator_ISection* getSection(const int theSectionIndex) const
220 if (theSectionIndex >= 0 && theSectionIndex < mySections.size())
222 return (CurveCreator_ISection*)mySections[theSectionIndex];
227 //! A virtual method.
228 CurveCreator_ISection* getSection(const int theSectionIndex)
230 return (CurveCreator_ISection*)mySections[theSectionIndex];
233 /***********************************************/
234 /*** Point methods ***/
235 /***********************************************/
237 //! For internal use only! Undo/Redo are not used here.
238 virtual bool addPointsInternal( const CurveCreator::SectionsMap &theSectionsMap );
240 * Add one point to the specified section starting from the given theIPnt index
241 * (or at the end of points if \a theIPnt is -1).
243 virtual bool addPoints( const CurveCreator::Coordinates &theCoords,
244 const int theISection,
245 const int theIPnt = -1 );
247 //! For internal use only! Undo/Redo are not used here.
248 virtual bool setPointInternal( const CurveCreator::SectionsMap &theSectionsMap );
249 //! Set coordinates of specified point
250 virtual bool setPoint( const int theISection,
252 const CurveCreator::Coordinates& theNewCoords );
254 //! Set coordinates of specified points from different sections
255 virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords,
256 const bool theIsToSaveDiff = true );
258 //! For internal use only! Undo/Redo are not used here.
259 virtual bool removePointsInternal( const SectionToPointList &thePoints );
260 /** Remove point with given id */
261 virtual bool removePoint( const int theISection, const int theIPnt = -1 );
263 //! Remove several points from different sections with given ids
264 virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs);
266 //! Get coordinates of specified point
267 virtual CurveCreator::Coordinates getPoint( const int theISection,
268 const int theIPnt ) const;
271 * Get points of a section (the total points in Curve if theISection is equal to -1)..
273 virtual Handle(TColgp_HArray1OfPnt) GetDifferentPoints( int theISection = -1 ) const;
275 CurveCreator::Coordinates getCoords( int theISection = -1 ) const;
279 * Get number of points in specified section or (the total number of points
280 * in Curve if theISection is equal to -1).
282 virtual int getNbPoints( const int theISection ) const;
285 * Set skip sorting flag. If the flag is true - points sorting will be skipped.
287 virtual void setSkipSorting( const bool theIsToSkip );
290 * Indicates whether the points can be sorted.
292 virtual bool canPointsBeSorted();
295 * Saves points coordinates difference.
296 * \param theOldCoords the old points coordinates
298 virtual void saveCoordDiff( const SectionToPointCoordsList &theOldCoords );
300 /***********************************************/
301 /*** Presentation methods ***/
302 /***********************************************/
304 * Get the curve AIS object
306 virtual Handle(AIS_InteractiveObject) getAISObject( const bool theNeedToBuild = false) const;
310 * Removes the points from the section. It sortes the points and remove them
311 * in the decreasing order
312 * \param theSectionId a section index
313 * \param thePointIds a list of section points
315 bool removeSectionPoints( const int theSectionId,
316 const std::list<int>& thePointIds );
318 * Converts the list of pairs of section to point into map of a section to list of points
319 * \param thePoints an source list
320 * \param theConvPoints a converted map
322 void convert( const SectionToPointList &thePoints,
323 std::map<int, std::list<int> > &theConvPoints );
326 virtual void constructAISObject();
333 CurveCreator::Sections mySections; //!< curve data
334 CurveCreator::Dimension myDimension; //!< curve dimension
335 CurveCreator_Displayer* myDisplayer; //!< curve displayer
336 Quantity_Color myPointAspectColor;
337 Quantity_Color myCurveColor;
344 ListDiff::iterator myCurrenPos;
345 ListDiff myListDiffs;
348 AIS_Shape* myAISShape; //!< AIS shape