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"
31 #include "CurveCreator_AISCurve.hxx"
33 #include <AIS_Point.hxx>
34 #include <AIS_Line.hxx>
35 #include <AIS_InteractiveObject.hxx>
40 struct CurveCreator_Section;
41 class CurveCreator_Displayer;
44 * The CurveCreator_Curve object is represented as one or more sets of
45 * connected points; thus CurveCreator_Curve object can contain several
46 * not connected curves (polylines or b-splines), each such curve has two
47 * only ends � start and end points � in other words non-manifold curves
50 class CURVECREATOR_EXPORT CurveCreator_Curve : public CurveCreator_ICurve
53 typedef std::list<CurveCreator_Diff> ListDiff;
56 //! Constructor of the curve.
57 /** The dimension is explicitly specified in the constructor
58 * and cannot be changed later.
60 CurveCreator_Curve(const CurveCreator::Dimension theDimension);
63 virtual ~CurveCreator_Curve();
65 //! Get the dimension.
66 virtual CurveCreator::Dimension getDimension() const;
68 //! Return unique section name
69 virtual std::string getUniqSectionName() const;
71 //! Set curve creator Displayer object
72 virtual void setDisplayer( CurveCreator_Displayer* theDisplayer );
74 //! Return curve creator Displayer object
75 CurveCreator_Displayer* getDisplayer();
77 //! Remove curve creator Displayer object
78 virtual void removeDisplayer();
80 /** Set depth of undo operations (unlimited if \a theDepth is -1
81 * or disabled if \a theDepth is 0)
83 virtual void setUndoDepth(const int theDepth = -1);
85 //! Get depth of undo operations.
86 virtual int getUndoDepth() const;
88 virtual void startOperation();
89 virtual void finishOperation();
92 * This method converts the point index to the index in
93 * an array of coordinates.
95 virtual int toICoord(const int theIPnt) const;
97 ListAISObjects constructSection( int theISection ) const;
99 //! For internal use only! Undo/Redo are not used here.
100 virtual bool moveSectionInternal(const int theISection,
101 const int theNewIndex);
102 //! Move section to new position in list
103 virtual bool moveSection(const int theISection,
104 const int theNewIndex);
107 /** This method updates all undo/redo information required to be updated
108 * after curve modification operation. It returns false if undo/redo
109 * is disabled and true otherwise.
111 virtual bool addEmptyDiff();
113 public: // TODO: remove public
114 Handle_AIS_Point getAISPoint( int theISection, int theIPoint ) const;
115 Handle_AIS_Line getAISLine( int theISection, int theIPoint1, int theIPoint2 ) const;
116 void getCoordinates( int theISection, int theIPoint, double& theX, double& theY, double& theZ ) const;
117 protected: // TODO: remove public
118 void redisplayCurve();
120 void convert( const SectionToPointList &thePoints,
121 std::map<int, std::list<int> > &theConvPoints );
124 /************ Implementation of INTERFACE methods ************/
126 /***********************************************/
127 /*** Undo/Redo methods ***/
128 /***********************************************/
130 //! Get number of available undo operations
131 virtual int getNbUndo() const;
133 //! Undo previous operation
136 //! Get number of available redo operations
137 virtual int getNbRedo() const;
139 //! Redo last previously "undone" operation
143 /***********************************************/
144 /*** Section methods ***/
145 /***********************************************/
147 //! For internal use only! Undo/Redo are not used here.
148 virtual bool clearInternal();
149 //! Clear the polyline (remove all sections)
150 virtual bool clear();
152 //! For internal use only! Undo/Redo are not used here.
153 virtual bool joinInternal( const int theISectionTo = -1,
154 const int theISectionFrom = -1 );
155 //! Join range of sections to one section (join all sections if -1 is passed in one of arguments)
156 virtual bool join( const int theISectionTo = -1,
157 const int theISectionFrom = -1 );
159 //! Get number of sections
160 virtual int getNbSections() const;
162 //! For internal use only! Undo/Redo are not used here.
163 virtual int addSectionInternal( const std::string &theName,
164 const CurveCreator::SectionType theType,
165 const bool theIsClosed,
166 const CurveCreator::Coordinates &thePoints);
167 //! Add a new section.
168 virtual int addSection( const std::string &theName,
169 const CurveCreator::SectionType theType,
170 const bool theIsClosed );
171 //! Add a new section.
172 virtual int addSection( const std::string &theName,
173 const CurveCreator::SectionType theType,
174 const bool theIsClosed,
175 const CurveCreator::Coordinates &thePoints);
177 //! For internal use only! Undo/Redo are not used here.
178 virtual bool removeSectionInternal( const int theISection );
179 //! Removes the given sections.
180 virtual bool removeSection( const int theISection );
182 //! Get "closed" flag of the specified section
183 virtual bool isClosed( const int theISection ) const;
185 //! For internal use only! Undo/Redo are not used here.
186 virtual bool setClosedInternal( const int theISection,
187 const bool theIsClosed );
189 * Set "closed" flag of the specified section (all sections if
190 * \a theISection is -1).
192 virtual bool setClosed( const int theISection,
193 const bool theIsClosed );
195 //! Returns specifyed section name
196 virtual std::string getSectionName( const int theISection ) const;
198 //! For internal use only! Undo/Redo are not used here.
199 virtual bool setSectionNameInternal( const int theISection,
200 const std::string& theName );
201 /** Set name of the specified section */
202 virtual bool setSectionName( const int theISection,
203 const std::string& theName );
205 //! Get type of the specified section
206 virtual CurveCreator::SectionType getSectionType( const int theISection ) const;
208 //! For internal use only! Undo/Redo are not used here.
209 virtual bool setSectionTypeInternal( const int theISection,
210 const CurveCreator::SectionType theType );
212 * Set type of the specified section (or all sections
213 * if \a theISection is -1).
215 virtual bool setSectionType( const int theISection,
216 const CurveCreator::SectionType theType );
219 /***********************************************/
220 /*** Point methods ***/
221 /***********************************************/
223 //! For internal use only! Undo/Redo are not used here.
224 virtual bool addPointsInternal( const CurveCreator::SectionsMap &theSectionsMap );
226 * Add one point to the specified section starting from the given theIPnt index
227 * (or at the end of points if \a theIPnt is -1).
229 virtual bool addPoints( const CurveCreator::Coordinates &theCoords,
230 const int theISection,
231 const int theIPnt = -1 );
233 //! For internal use only! Undo/Redo are not used here.
234 virtual bool setPointInternal( const CurveCreator::SectionsMap &theSectionsMap );
235 //! Set coordinates of specified point
236 virtual bool setPoint( const int theISection,
238 const CurveCreator::Coordinates& theNewCoords );
240 //! Set coordinates of specified points from different sections
241 virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords);
243 //! For internal use only! Undo/Redo are not used here.
244 virtual bool removePointsInternal( const SectionToPointList &thePoints );
245 /** Remove point with given id */
246 virtual bool removePoint( const int theISection, const int theIPnt = -1 );
248 //! Remove several points from different sections with given ids
249 virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs);
251 //! Get coordinates of specified point
252 virtual CurveCreator::Coordinates getPoint( const int theISection,
253 const int theIPnt ) const;
256 * Get points of a section (the total points in Curve if theISection is equal to -1)..
258 virtual CurveCreator::Coordinates getPoints( const int theISection = -1 ) const;
262 * Get number of points in specified section or (the total number of points
263 * in Curve if theISection is equal to -1).
265 virtual int getNbPoints( const int theISection ) const;
268 /***********************************************/
269 /*** Presentation methods ***/
270 /***********************************************/
271 virtual ListAISObjects constructWire() const;
273 public: // TODO: remove
274 void getPoint( const int theSectionId, const int thePointId, gp_Pnt& thePoint ) const;
277 Handle(CurveCreator_AISCurve) myAISCurve;
279 CurveCreator::Sections mySections; //!< curve data
280 CurveCreator::Dimension myDimension; //!< curve dimension
281 CurveCreator_Displayer* myDisplayer; //!< curve displayer
287 ListDiff::iterator myCurrenPos;
288 ListDiff myListDiffs;