1 // Copyright (C) 2013-2016 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;
41 * The CurveCreator_Curve object is represented as one or more sets of
42 * connected points; thus CurveCreator_Curve object can contain several
43 * not connected curves (polylines or b-splines), each such curve has two
44 * only ends "start and end points" in other words non-manifold curves
47 class CURVECREATOR_EXPORT CurveCreator_Curve : public CurveCreator_ICurve
50 typedef std::list<CurveCreator_Diff> ListDiff;
53 //! Constructor of the curve.
54 /** The dimension is explicitly specified in the constructor
55 * and cannot be changed later.
57 CurveCreator_Curve(const CurveCreator::Dimension theDimension);
60 virtual ~CurveCreator_Curve();
62 //! Get the dimension.
63 virtual CurveCreator::Dimension getDimension() const;
65 //! Return unique section name
66 virtual std::string getUniqSectionName() const;
68 //! Set curve creator Displayer object
69 virtual void setDisplayer( CurveCreator_Displayer* theDisplayer );
71 //! Return curve creator Displayer object
72 CurveCreator_Displayer* getDisplayer();
74 //! Remove curve creator Displayer object
75 virtual void removeDisplayer();
77 /** Set depth of undo operations (unlimited if \a theDepth is -1
78 * or disabled if \a theDepth is 0)
80 virtual void setUndoDepth(const int theDepth = -1);
82 //! Get depth of undo operations.
83 virtual int getUndoDepth() const;
85 virtual void startOperation();
86 virtual void finishOperation();
89 * This method converts the point index to the index in
90 * an array of coordinates.
92 virtual int toICoord(const int theIPnt) const;
94 //! For internal use only! Undo/Redo are not used here.
95 virtual bool moveSectionInternal(const int theISection,
96 const int theNewIndex);
97 //! Move section to new position in list
98 virtual bool moveSection(const int theISection,
99 const int theNewIndex);
102 /** This method updates all undo/redo information required to be updated
103 * after curve modification operation. It returns false if undo/redo
104 * is disabled and true otherwise.
106 virtual bool addEmptyDiff();
108 public: // TODO: remove public
109 void getCoordinates( int theISection, int theIPoint, double& theX, double& theY, double& theZ ) const;
110 protected: // TODO: remove public
111 void redisplayCurve();
114 /************ Implementation of INTERFACE methods ************/
116 /***********************************************/
117 /*** Undo/Redo methods ***/
118 /***********************************************/
120 //! Get number of available undo operations
121 virtual int getNbUndo() const;
123 //! Undo previous operation
126 //! Get number of available redo operations
127 virtual int getNbRedo() const;
129 //! Redo last previously "undone" operation
133 /***********************************************/
134 /*** Section methods ***/
135 /***********************************************/
137 //! For internal use only! Undo/Redo are not used here.
138 virtual bool clearInternal();
139 //! Clear the polyline (remove all sections)
140 virtual bool clear();
142 //! For internal use only! Undo/Redo are not used here.
143 virtual bool joinInternal( const std::list<int>& theSections );
145 //! Join list of sections to one section (join all if the list is empty)
146 // The first section in the list is a leader, another sections are joined to it
147 virtual bool join( const std::list<int>& theSections );
149 //! Get number of sections
150 virtual int getNbSections() const;
152 //! For internal use only! Undo/Redo are not used here.
153 virtual int addSectionInternal( const std::string &theName,
154 const CurveCreator::SectionType theType,
155 const bool theIsClosed,
156 const CurveCreator::Coordinates &thePoints);
157 //! Add a new section.
158 virtual int addSection( const std::string &theName,
159 const CurveCreator::SectionType theType,
160 const bool theIsClosed );
161 //! Add a new section.
162 virtual int addSection( const std::string &theName,
163 const CurveCreator::SectionType theType,
164 const bool theIsClosed,
165 const CurveCreator::Coordinates &thePoints);
167 //! For internal use only! Undo/Redo are not used here.
168 virtual bool removeSectionInternal( const int theISection );
169 //! Removes the given sections.
170 virtual bool removeSection( const int theISection );
172 //! Get "closed" flag of the specified section
173 virtual bool isClosed( const int theISection ) const;
175 //! For internal use only! Undo/Redo are not used here.
176 virtual bool setClosedInternal( const int theISection,
177 const bool theIsClosed );
179 * Set "closed" flag of the specified section (all sections if
180 * \a theISection is -1).
182 virtual bool setClosed( const int theISection,
183 const bool theIsClosed );
185 //! Returns specifyed section name
186 virtual std::string getSectionName( const int theISection ) const;
188 //! For internal use only! Undo/Redo are not used here.
189 virtual bool setSectionNameInternal( const int theISection,
190 const std::string& theName );
191 /** Set name of the specified section */
192 virtual bool setSectionName( const int theISection,
193 const std::string& theName );
195 //! Get type of the specified section
196 virtual CurveCreator::SectionType getSectionType( const int theISection ) const;
198 //! For internal use only! Undo/Redo are not used here.
199 virtual bool setSectionTypeInternal( const int theISection,
200 const CurveCreator::SectionType theType );
202 * Set type of the specified section (or all sections
203 * if \a theISection is -1).
205 virtual bool setSectionType( const int theISection,
206 const CurveCreator::SectionType theType );
208 //! A virtual method.
209 const CurveCreator_ISection* getSection(const int theSectionIndex) const
211 if (theSectionIndex >= 0 && theSectionIndex < mySections.size())
213 return (CurveCreator_ISection*)mySections[theSectionIndex];
218 //! A virtual method.
219 CurveCreator_ISection* getSection(const int theSectionIndex)
221 return (CurveCreator_ISection*)mySections[theSectionIndex];
224 /***********************************************/
225 /*** Point methods ***/
226 /***********************************************/
228 //! For internal use only! Undo/Redo are not used here.
229 virtual bool addPointsInternal( const CurveCreator::SectionsMap &theSectionsMap );
231 * Add one point to the specified section starting from the given theIPnt index
232 * (or at the end of points if \a theIPnt is -1).
234 virtual bool addPoints( const CurveCreator::Coordinates &theCoords,
235 const int theISection,
236 const int theIPnt = -1 );
238 //! For internal use only! Undo/Redo are not used here.
239 virtual bool setPointInternal( const CurveCreator::SectionsMap &theSectionsMap );
240 //! Set coordinates of specified point
241 virtual bool setPoint( const int theISection,
243 const CurveCreator::Coordinates& theNewCoords );
245 //! Set coordinates of specified points from different sections
246 virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords,
247 const bool theIsToSaveDiff = true );
249 //! For internal use only! Undo/Redo are not used here.
250 virtual bool removePointsInternal( const SectionToPointList &thePoints );
251 /** Remove point with given id */
252 virtual bool removePoint( const int theISection, const int theIPnt = -1 );
254 //! Remove several points from different sections with given ids
255 virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs);
257 //! Get coordinates of specified point
258 virtual CurveCreator::Coordinates getPoint( const int theISection,
259 const int theIPnt ) const;
262 * Get points of a section (the total points in Curve if theISection is equal to -1)..
264 virtual CurveCreator::Coordinates getPoints( const int theISection = -1 ) const;
268 * Get number of points in specified section or (the total number of points
269 * in Curve if theISection is equal to -1).
271 virtual int getNbPoints( const int theISection ) const;
274 * Set skip sorting flag. If the flag is true - points sorting will be skipped.
276 virtual void setSkipSorting( const bool theIsToSkip );
279 * Indicates whether the points can be sorted.
281 virtual bool canPointsBeSorted();
284 * Saves points coordinates difference.
285 * \param theOldCoords the old points coordinates
287 virtual void saveCoordDiff( const SectionToPointCoordsList &theOldCoords );
289 /***********************************************/
290 /*** Presentation methods ***/
291 /***********************************************/
293 * Get the curve AIS object
295 virtual Handle(AIS_InteractiveObject) getAISObject( const bool theNeedToBuild = false ) const;
299 * Removes the points from the section. It sortes the points and remove them
300 * in the decreasing order
301 * \param theSectionId a section index
302 * \param thePointIds a list of section points
304 bool removeSectionPoints( const int theSectionId,
305 const std::list<int>& thePointIds );
307 * Converts the list of pairs of section to point into map of a section to list of points
308 * \param thePoints an source list
309 * \param theConvPoints a converted map
311 void convert( const SectionToPointList &thePoints,
312 std::map<int, std::list<int> > &theConvPoints );
315 virtual void constructAISObject();
322 CurveCreator::Sections mySections; //!< curve data
323 CurveCreator::Dimension myDimension; //!< curve dimension
324 CurveCreator_Displayer* myDisplayer; //!< curve displayer
330 ListDiff::iterator myCurrenPos;
331 ListDiff myListDiffs;
334 AIS_Shape* myAISShape; //!< AIS shape