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_ICurve.hxx
21 // Author: Alexander KOVALEV and Alexander SOLOVYOV
23 #ifndef _CurveCreator_ICurve_HeaderFile
24 #define _CurveCreator_ICurve_HeaderFile
26 #include "CurveCreator_Macro.hxx"
31 class Handle_AIS_InteractiveObject;
33 namespace CurveCreator
35 //! Type of the section
42 //! Dimension of the curve
52 * The CurveCreator_ICurve object is represented as one or more sets of
53 * connected points; thus CurveCreator_ICurve object can contain several
54 * not connected curves (polylines or b-splines), each such curve has two
55 * only ends "start and end points" in other words non-manifold curves
58 class CURVECREATOR_EXPORT CurveCreator_ICurve
61 typedef std::pair<int,int> SectionToPoint;
62 typedef std::deque<SectionToPoint> SectionToPointList;
64 typedef std::deque< std::pair< SectionToPoint,std::deque< float > > > SectionToPointCoordsList;
67 /***********************************************/
68 /*** Undo/Redo methods ***/
69 /***********************************************/
71 //! Get number of available undo operations
72 virtual int getNbUndo() const = 0;
74 //! Undo previous operation
75 virtual bool undo() = 0;
77 //! Get number of available redo operations
78 virtual int getNbRedo() const = 0;
80 //! Redo last previously "undone" operation
81 virtual bool redo() = 0;
84 /***********************************************/
85 /*** Section methods ***/
86 /***********************************************/
88 //! Clear the polyline (remove all sections)
89 virtual bool clear() = 0;
91 //! Join range of sections to one section (join all sections if -1 is passed in one of arguments)
92 virtual bool join( const int theISectionTo = -1,
93 const int theISectionFrom = -1 ) = 0;
95 //! Get number of sections
96 virtual int getNbSections() const = 0;
98 //! Add a new section.
99 virtual int addSection( const std::string& theName,
100 const CurveCreator::SectionType theType,
101 const bool theIsClosed ) = 0;
103 //! Removes the given sections.
104 virtual bool removeSection( const int theISection ) = 0;
106 //! Get "closed" flag of the specified section
107 virtual bool isClosed( const int theISection ) const = 0;
110 * Set "closed" flag of the specified section (all sections if
111 * \a theISection is -1).
113 virtual bool setClosed( const int theISection,
114 const bool theIsClosed ) = 0;
116 //! Returns specifyed section name
117 virtual std::string getSectionName( const int theISection ) const = 0;
119 /** Set name of the specified section */
120 virtual bool setSectionName( const int theISection,
121 const std::string& theName ) = 0;
123 //! Get type of the specified section
124 virtual CurveCreator::SectionType getSectionType( const int theISection ) const = 0;
127 * Set type of the specified section (or all sections
128 * if \a theISection is -1).
130 virtual bool setSectionType( const int theISection,
131 const CurveCreator::SectionType theType ) = 0;
134 /***********************************************/
135 /*** Point methods ***/
136 /***********************************************/
138 //! Get the dimension.
139 virtual CurveCreator::Dimension getDimension() const = 0;
142 * Insert one or several points to the specified section starting from the given theIPnt index
143 * (or add these at the end of section points if \a theIPnt is -1).
145 virtual bool addPoints( const std::deque<float>& theCoords,
146 const int theISection,
147 const int theIPnt = -1 ) = 0;
149 //! Set coordinates of specified point
150 virtual bool setPoint( const int theISection,
152 const std::deque<float>& theNewCoords ) = 0;
154 //! Set coordinates of specified points from different sections
155 virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords) = 0;
157 //! Remove point with given id
158 virtual bool removePoint( const int theISection, const int theIPnt = -1 ) = 0;
159 //! Remove several points from different sections
160 virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs) = 0;
162 //! Get coordinates of specified point
163 virtual std::deque<float> getPoint( const int theISection,
164 const int theIPnt ) const = 0;
167 * Get points of a section (the total points in Curve if theISection is equal to -1)..
169 virtual std::deque<float> getPoints( const int theISection = -1 ) const = 0;
172 * Get number of points in specified section or (the total number of points
173 * in Curve if theISection is equal to -1).
175 virtual int getNbPoints( const int theISection ) const = 0;
178 /***********************************************/
179 /*** Presentation methods ***/
180 /***********************************************/
182 virtual Handle_AIS_InteractiveObject getAISObject( const bool theNeedToBuild = false ) const = 0;
185 virtual void constructAISObject() = 0;