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_InteractiveObject.hxx>
37 struct CurveCreator_Section;
38 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 //! 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();
114 void convert( const SectionToPointList &thePoints,
115 std::map<int, std::list<int> > &theConvPoints );
118 /************ Implementation of INTERFACE methods ************/
120 /***********************************************/
121 /*** Undo/Redo methods ***/
122 /***********************************************/
124 //! Get number of available undo operations
125 virtual int getNbUndo() const;
127 //! Undo previous operation
130 //! Get number of available redo operations
131 virtual int getNbRedo() const;
133 //! Redo last previously "undone" operation
137 /***********************************************/
138 /*** Section methods ***/
139 /***********************************************/
141 //! For internal use only! Undo/Redo are not used here.
142 virtual bool clearInternal();
143 //! Clear the polyline (remove all sections)
144 virtual bool clear();
146 //! For internal use only! Undo/Redo are not used here.
147 virtual bool joinInternal( const int theISectionTo = -1,
148 const int theISectionFrom = -1 );
149 //! Join range of sections to one section (join all sections if -1 is passed in one of arguments)
150 virtual bool join( const int theISectionTo = -1,
151 const int theISectionFrom = -1 );
153 //! Get number of sections
154 virtual int getNbSections() const;
156 //! For internal use only! Undo/Redo are not used here.
157 virtual int addSectionInternal( const std::string &theName,
158 const CurveCreator::SectionType theType,
159 const bool theIsClosed,
160 const CurveCreator::Coordinates &thePoints);
161 //! Add a new section.
162 virtual int addSection( const std::string &theName,
163 const CurveCreator::SectionType theType,
164 const bool theIsClosed );
165 //! Add a new section.
166 virtual int addSection( const std::string &theName,
167 const CurveCreator::SectionType theType,
168 const bool theIsClosed,
169 const CurveCreator::Coordinates &thePoints);
171 //! For internal use only! Undo/Redo are not used here.
172 virtual bool removeSectionInternal( const int theISection );
173 //! Removes the given sections.
174 virtual bool removeSection( const int theISection );
176 //! Get "closed" flag of the specified section
177 virtual bool isClosed( const int theISection ) const;
179 //! For internal use only! Undo/Redo are not used here.
180 virtual bool setClosedInternal( const int theISection,
181 const bool theIsClosed );
183 * Set "closed" flag of the specified section (all sections if
184 * \a theISection is -1).
186 virtual bool setClosed( const int theISection,
187 const bool theIsClosed );
189 //! Returns specifyed section name
190 virtual std::string getSectionName( const int theISection ) const;
192 //! For internal use only! Undo/Redo are not used here.
193 virtual bool setSectionNameInternal( const int theISection,
194 const std::string& theName );
195 /** Set name of the specified section */
196 virtual bool setSectionName( const int theISection,
197 const std::string& theName );
199 //! Get type of the specified section
200 virtual CurveCreator::SectionType getSectionType( const int theISection ) const;
202 //! For internal use only! Undo/Redo are not used here.
203 virtual bool setSectionTypeInternal( const int theISection,
204 const CurveCreator::SectionType theType );
206 * Set type of the specified section (or all sections
207 * if \a theISection is -1).
209 virtual bool setSectionType( const int theISection,
210 const CurveCreator::SectionType theType );
213 /***********************************************/
214 /*** Point methods ***/
215 /***********************************************/
217 //! For internal use only! Undo/Redo are not used here.
218 virtual bool addPointsInternal( const CurveCreator::SectionsMap &theSectionsMap );
220 * Add one point to the specified section starting from the given theIPnt index
221 * (or at the end of points if \a theIPnt is -1).
223 virtual bool addPoints( const CurveCreator::Coordinates &theCoords,
224 const int theISection,
225 const int theIPnt = -1 );
227 //! For internal use only! Undo/Redo are not used here.
228 virtual bool setPointInternal( const CurveCreator::SectionsMap &theSectionsMap );
229 //! Set coordinates of specified point
230 virtual bool setPoint( const int theISection,
232 const CurveCreator::Coordinates& theNewCoords );
234 //! Set coordinates of specified points from different sections
235 virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords);
237 //! For internal use only! Undo/Redo are not used here.
238 virtual bool removePointsInternal( const SectionToPointList &thePoints );
239 /** Remove point with given id */
240 virtual bool removePoint( const int theISection, const int theIPnt = -1 );
242 //! Remove several points from different sections with given ids
243 virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs);
245 //! Get coordinates of specified point
246 virtual CurveCreator::Coordinates getPoint( const int theISection,
247 const int theIPnt ) const;
250 * Get points of a section (the total points in Curve if theISection is equal to -1)..
252 virtual CurveCreator::Coordinates getPoints( const int theISection = -1 ) const;
256 * Get number of points in specified section or (the total number of points
257 * in Curve if theISection is equal to -1).
259 virtual int getNbPoints( const int theISection ) const;
262 /***********************************************/
263 /*** Presentation methods ***/
264 /***********************************************/
265 virtual ListAISObjects constructWire();
268 * Get the curve AIS object
270 virtual Handle_AIS_InteractiveObject getAISObject() const;
274 CurveCreator::Sections mySections; //!< curve data
275 CurveCreator::Dimension myDimension; //!< curve dimension
276 CurveCreator_Displayer* myDisplayer; //!< curve displayer
277 AIS_Shape* myAISShape; //!< AIS shape
283 ListDiff::iterator myCurrenPos;
284 ListDiff myListDiffs;