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>
38 struct CurveCreator_Section;
39 class CurveCreator_Displayer;
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 //! Remove curve creator Displayer object
73 virtual void removeDisplayer();
75 /** Set depth of undo operations (unlimited if \a theDepth is -1
76 * or disabled if \a theDepth is 0)
78 virtual void setUndoDepth(const int theDepth = -1);
80 //! Get depth of undo operations.
81 virtual int getUndoDepth() const;
83 virtual void startOperation();
84 virtual void finishOperation();
87 * This method converts the point index to the index in
88 * an array of coordinates.
90 virtual int toICoord(const int theIPnt) const;
92 ListAISObjects constructSection( int theISection ) const;
95 /** This method updates all undo/redo information required to be updated
96 * after curve modification operation. It returns false if undo/redo
97 * is disabled and true otherwise.
99 virtual bool addEmptyDiff();
101 Handle_AIS_Point getAISPoint( int theISection, int theIPoint ) const;
102 Handle_AIS_Line getAISLine( int theISection, int theIPoint1, int theIPoint2 ) const;
103 void getCoordinates( int theISection, int theIPoint, double& theX, double& theY, double& theZ ) const;
105 void redisplayCurve();
108 /************ Implementation of INTERFACE methods ************/
110 /***********************************************/
111 /*** Undo/Redo methods ***/
112 /***********************************************/
114 //! Get number of available undo operations
115 virtual int getNbUndo() const;
117 //! Undo previous operation
120 //! Get number of available redo operations
121 virtual int getNbRedo() const;
123 //! Redo last previously "undone" operation
127 /***********************************************/
128 /*** Section methods ***/
129 /***********************************************/
131 //! For internal use only! Undo/Redo are not used here.
132 virtual bool clearInternal();
133 //! Clear the polyline (remove all sections)
134 virtual bool clear();
136 //! For internal use only! Undo/Redo are not used here.
137 virtual bool joinInternal( const int theISectionTo = -1,
138 const int theISectionFrom = -1 );
139 //! Join range of sections to one section (join all sections if -1 is passed in one of arguments)
140 virtual bool join( const int theISectionTo = -1,
141 const int theISectionFrom = -1 );
143 //! Get number of sections
144 virtual int getNbSections() const;
146 //! For internal use only! Undo/Redo are not used here.
147 virtual int addSectionInternal( const std::string &theName,
148 const CurveCreator::SectionType theType,
149 const bool theIsClosed,
150 const CurveCreator::Coordinates &thePoints);
151 //! Add a new section.
152 virtual int addSection( const std::string &theName,
153 const CurveCreator::SectionType theType,
154 const bool theIsClosed );
155 //! Add a new section.
156 virtual int addSection( const std::string &theName,
157 const CurveCreator::SectionType theType,
158 const bool theIsClosed,
159 const CurveCreator::Coordinates &thePoints);
161 //! For internal use only! Undo/Redo are not used here.
162 virtual bool removeSectionInternal( const int theISection );
163 //! Removes the given sections.
164 virtual bool removeSection( const int theISection );
166 //! Get "closed" flag of the specified section
167 virtual bool isClosed( const int theISection ) const;
169 //! For internal use only! Undo/Redo are not used here.
170 virtual bool setClosedInternal( const int theISection,
171 const bool theIsClosed );
173 * Set "closed" flag of the specified section (all sections if
174 * \a theISection is -1).
176 virtual bool setClosed( const int theISection,
177 const bool theIsClosed );
179 //! Returns specifyed section name
180 virtual std::string getSectionName( const int theISection ) const;
182 //! For internal use only! Undo/Redo are not used here.
183 virtual bool setSectionNameInternal( const int theISection,
184 const std::string& theName );
185 /** Set name of the specified section */
186 virtual bool setSectionName( const int theISection,
187 const std::string& theName );
189 //! Get type of the specified section
190 virtual CurveCreator::SectionType getSectionType( const int theISection ) const;
192 //! For internal use only! Undo/Redo are not used here.
193 virtual bool setSectionTypeInternal( const int theISection,
194 const CurveCreator::SectionType theType );
196 * Set type of the specified section (or all sections
197 * if \a theISection is -1).
199 virtual bool setSectionType( const int theISection,
200 const CurveCreator::SectionType theType );
203 /***********************************************/
204 /*** Point methods ***/
205 /***********************************************/
207 //! For internal use only! Undo/Redo are not used here.
208 virtual bool addPointsInternal( const CurveCreator::Coordinates &theCoords,
209 const std::vector<int> &theISections,
210 const std::vector<int> &theIPnts );
212 * Add one point to the specified section starting from the given theIPnt index
213 * (or at the end of points if \a theIPnt is -1).
215 virtual bool addPoints( const CurveCreator::Coordinates &theCoords,
216 const int theISection,
217 const int theIPnt = -1 );
219 //! For internal use only! Undo/Redo are not used here.
220 virtual bool setPointInternal( const int theISection,
222 const CurveCreator::Coordinates& theNewCoords );
223 //! Set coordinates of specified point
224 virtual bool setPoint( const int theISection,
226 const CurveCreator::Coordinates& theNewCoords );
228 //! For internal use only! Undo/Redo are not used here.
229 virtual bool removePointsInternal( const std::vector<int> &theISections,
230 const std::vector<int> &theIPnts );
231 /** Remove point with given id */
232 virtual bool removePoint( const int theISection, const int theIPnt = -1 );
234 //! Get coordinates of specified point
235 virtual CurveCreator::Coordinates getPoint( const int theISection,
236 const int theIPnt ) const;
239 * Get points of a section (the total points in Curve if theISection is equal to -1)..
241 virtual CurveCreator::Coordinates getPoints( const int theISection = -1 ) const;
245 * Get number of points in specified section or (the total number of points
246 * in Curve if theISection is equal to -1).
248 virtual int getNbPoints( const int theISection ) const;
251 /***********************************************/
252 /*** Presentation methods ***/
253 /***********************************************/
254 virtual ListAISObjects constructWire() const;
259 CurveCreator::Sections mySections; //!< curve data
260 CurveCreator::Dimension myDimension; //!< curve dimension
261 CurveCreator_Displayer* myDisplayer; //!< curve displayer
267 ListDiff::iterator myCurrenPos;
268 ListDiff myListDiffs;