1 // Copyright (C) 2013 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.
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"
32 #include <AIS_Point.hxx>
33 #include <AIS_Line.hxx>
34 #include <AIS_InteractiveObject.hxx>
39 struct CurveCreator_Section;
40 class CurveCreator_Displayer;
43 * The CurveCreator_Curve object is represented as one or more sets of
44 * connected points; thus CurveCreator_Curve object can contain several
45 * not connected curves (polylines or b-splines), each such curve has two
46 * only ends � start and end points � in other words non-manifold curves
49 class CURVECREATOR_EXPORT CurveCreator_Curve : public CurveCreator_ICurve
52 typedef std::list<CurveCreator_Diff> ListDiff;
55 //! Constructor of the curve.
56 /** The dimension is explicitly specified in the constructor
57 * and cannot be changed later.
59 CurveCreator_Curve(const CurveCreator::Dimension theDimension);
62 virtual ~CurveCreator_Curve();
64 //! Get the dimension.
65 virtual CurveCreator::Dimension getDimension() const;
67 //! Return unique section name
68 virtual std::string getUniqSectionName() const;
70 //! Set curve creator Displayer object
71 virtual void setDisplayer( CurveCreator_Displayer* theDisplayer );
73 //! Return curve creator Displayer object
74 CurveCreator_Displayer* getDisplayer();
76 //! Remove curve creator Displayer object
77 virtual void removeDisplayer();
79 /** Set depth of undo operations (unlimited if \a theDepth is -1
80 * or disabled if \a theDepth is 0)
82 virtual void setUndoDepth(const int theDepth = -1);
84 //! Get depth of undo operations.
85 virtual int getUndoDepth() const;
87 virtual void startOperation();
88 virtual void finishOperation();
91 * This method converts the point index to the index in
92 * an array of coordinates.
94 virtual int toICoord(const int theIPnt) const;
96 ListAISObjects constructSection( int theISection ) const;
98 //! For internal use only! Undo/Redo are not used here.
99 virtual bool moveSectionInternal(const int theISection,
100 const int theNewIndex);
101 //! Move section to new position in list
102 virtual bool moveSection(const int theISection,
103 const int theNewIndex);
106 /** This method updates all undo/redo information required to be updated
107 * after curve modification operation. It returns false if undo/redo
108 * is disabled and true otherwise.
110 virtual bool addEmptyDiff();
112 Handle_AIS_Point getAISPoint( int theISection, int theIPoint ) const;
113 Handle_AIS_Line getAISLine( int theISection, int theIPoint1, int theIPoint2 ) const;
114 void getCoordinates( int theISection, int theIPoint, double& theX, double& theY, double& theZ ) const;
116 void redisplayCurve();
118 void convert( const SectionToPointList &thePoints,
119 std::map<int, std::list<int> > &theConvPoints );
122 /************ Implementation of INTERFACE methods ************/
124 /***********************************************/
125 /*** Undo/Redo methods ***/
126 /***********************************************/
128 //! Get number of available undo operations
129 virtual int getNbUndo() const;
131 //! Undo previous operation
134 //! Get number of available redo operations
135 virtual int getNbRedo() const;
137 //! Redo last previously "undone" operation
141 /***********************************************/
142 /*** Section methods ***/
143 /***********************************************/
145 //! For internal use only! Undo/Redo are not used here.
146 virtual bool clearInternal();
147 //! Clear the polyline (remove all sections)
148 virtual bool clear();
150 //! For internal use only! Undo/Redo are not used here.
151 virtual bool joinInternal( const int theISectionTo = -1,
152 const int theISectionFrom = -1 );
153 //! Join range of sections to one section (join all sections if -1 is passed in one of arguments)
154 virtual bool join( const int theISectionTo = -1,
155 const int theISectionFrom = -1 );
157 //! Get number of sections
158 virtual int getNbSections() const;
160 //! For internal use only! Undo/Redo are not used here.
161 virtual int addSectionInternal( const std::string &theName,
162 const CurveCreator::SectionType theType,
163 const bool theIsClosed,
164 const CurveCreator::Coordinates &thePoints);
165 //! Add a new section.
166 virtual int addSection( const std::string &theName,
167 const CurveCreator::SectionType theType,
168 const bool theIsClosed );
169 //! Add a new section.
170 virtual int addSection( const std::string &theName,
171 const CurveCreator::SectionType theType,
172 const bool theIsClosed,
173 const CurveCreator::Coordinates &thePoints);
175 //! For internal use only! Undo/Redo are not used here.
176 virtual bool removeSectionInternal( const int theISection );
177 //! Removes the given sections.
178 virtual bool removeSection( const int theISection );
180 //! Get "closed" flag of the specified section
181 virtual bool isClosed( const int theISection ) const;
183 //! For internal use only! Undo/Redo are not used here.
184 virtual bool setClosedInternal( const int theISection,
185 const bool theIsClosed );
187 * Set "closed" flag of the specified section (all sections if
188 * \a theISection is -1).
190 virtual bool setClosed( const int theISection,
191 const bool theIsClosed );
193 //! Returns specifyed section name
194 virtual std::string getSectionName( const int theISection ) const;
196 //! For internal use only! Undo/Redo are not used here.
197 virtual bool setSectionNameInternal( const int theISection,
198 const std::string& theName );
199 /** Set name of the specified section */
200 virtual bool setSectionName( const int theISection,
201 const std::string& theName );
203 //! Get type of the specified section
204 virtual CurveCreator::SectionType getSectionType( const int theISection ) const;
206 //! For internal use only! Undo/Redo are not used here.
207 virtual bool setSectionTypeInternal( const int theISection,
208 const CurveCreator::SectionType theType );
210 * Set type of the specified section (or all sections
211 * if \a theISection is -1).
213 virtual bool setSectionType( const int theISection,
214 const CurveCreator::SectionType theType );
217 /***********************************************/
218 /*** Point methods ***/
219 /***********************************************/
221 //! For internal use only! Undo/Redo are not used here.
222 virtual bool addPointsInternal( const CurveCreator::SectionsMap &theSectionsMap );
224 * Add one point to the specified section starting from the given theIPnt index
225 * (or at the end of points if \a theIPnt is -1).
227 virtual bool addPoints( const CurveCreator::Coordinates &theCoords,
228 const int theISection,
229 const int theIPnt = -1 );
231 //! For internal use only! Undo/Redo are not used here.
232 virtual bool setPointInternal( const CurveCreator::SectionsMap &theSectionsMap );
233 //! Set coordinates of specified point
234 virtual bool setPoint( const int theISection,
236 const CurveCreator::Coordinates& theNewCoords );
238 //! Set coordinates of specified points from different sections
239 virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords);
241 //! For internal use only! Undo/Redo are not used here.
242 virtual bool removePointsInternal( const SectionToPointList &thePoints );
243 /** Remove point with given id */
244 virtual bool removePoint( const int theISection, const int theIPnt = -1 );
246 //! Remove several points from different sections with given ids
247 virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs);
249 //! Get coordinates of specified point
250 virtual CurveCreator::Coordinates getPoint( const int theISection,
251 const int theIPnt ) const;
254 * Get points of a section (the total points in Curve if theISection is equal to -1)..
256 virtual CurveCreator::Coordinates getPoints( const int theISection = -1 ) const;
260 * Get number of points in specified section or (the total number of points
261 * in Curve if theISection is equal to -1).
263 virtual int getNbPoints( const int theISection ) const;
266 /***********************************************/
267 /*** Presentation methods ***/
268 /***********************************************/
269 virtual ListAISObjects constructWire() const;
274 CurveCreator::Sections mySections; //!< curve data
275 CurveCreator::Dimension myDimension; //!< curve dimension
276 CurveCreator_Displayer* myDisplayer; //!< curve displayer
282 ListDiff::iterator myCurrenPos;
283 ListDiff myListDiffs;