src/HYDROCurveCreator/CurveCreator_ICurve.hxx

   1 // Copyright (C) 2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 // File:        CurveCreator_ICurve.hxx
  21 // Author:      Alexander KOVALEV and Alexander SOLOVYOV
  22
  23 #ifndef _CurveCreator_ICurve_HeaderFile
  24 #define _CurveCreator_ICurve_HeaderFile
  25
  26 #include "CurveCreator_Macro.hxx"
  27 #include <deque>
  28 #include <vector>
  29
  30 class Handle_AIS_InteractiveObject;
  31
  32 namespace CurveCreator
  33 {
  34   //! Type of the section
  35   enum SectionType
  36   {
  37     Polyline,
  38     Spline,
  39   };
  40
  41   //! Dimension of the curve
  42   enum Dimension
  43   {
  44     Dim2d = 2,
  45     Dim3d = 3
  46   };
  47
  48 };
  49
  50 /**
  51  *  The CurveCreator_ICurve object is represented as one or more sets of
  52  *  connected points; thus CurveCreator_ICurve object can contain several
  53  *  not connected curves (polylines or b-splines), each such curve has two
  54  *  only ends "start and end points" in other words non-manifold curves
  55  *  are not supported.
  56  */
  57 class CURVECREATOR_EXPORT CurveCreator_ICurve
  58 {
  59 public:
  60   typedef std::pair<int,int> SectionToPoint;
  61   typedef std::deque<SectionToPoint> SectionToPointList;
  62
  63   typedef std::deque< std::pair< SectionToPoint,std::deque< float > > > SectionToPointCoordsList;
  64
  65 public:
  66   /***********************************************/
  67   /***          Undo/Redo methods              ***/
  68   /***********************************************/
  69
  70   //! Get number of available undo operations
  71   virtual int getNbUndo() const = 0;
  72
  73   //! Undo previous operation
  74   virtual bool undo() = 0;
  75
  76   //! Get number of available redo operations
  77   virtual int getNbRedo() const = 0;
  78
  79   //! Redo last previously "undone" operation
  80   virtual bool redo() = 0;
  81
  82
  83   /***********************************************/
  84   /***           Section methods               ***/
  85   /***********************************************/
  86
  87   //! Clear the polyline (remove all sections)
  88   virtual bool clear() = 0;
  89
  90   //! Join range of sections to one section (join all sections if -1 is passed in one of arguments)
  91   virtual bool join( const int theISectionTo = -1,
  92                      const int theISectionFrom = -1 ) = 0;
  93
  94   //! Get number of sections
  95   virtual int getNbSections() const = 0;
  96
  97   //! Add a new section.
  98   virtual int addSection( const std::string& theName,
  99                            const CurveCreator::SectionType theType,
 100                            const bool theIsClosed ) = 0;
 101
 102   //! Removes the given sections.
 103   virtual bool removeSection( const int theISection ) = 0;
 104
 105   //! Get "closed" flag of the specified section
 106   virtual bool isClosed( const int theISection ) const = 0;
 107
 108   /**
 109    *  Set "closed" flag of the specified section (all sections if
 110    *  \a theISection is -1).
 111    */
 112   virtual bool setClosed( const int theISection,
 113                           const bool theIsClosed ) = 0;
 114
 115   //! Returns specifyed section name
 116   virtual std::string getSectionName( const int theISection ) const = 0;
 117
 118   /** Set name of the specified section */
 119   virtual bool setSectionName( const int theISection,
 120                                const std::string& theName ) = 0;
 121
 122   //! Get type of the specified section
 123   virtual CurveCreator::SectionType getSectionType( const int theISection ) const = 0;
 124
 125   /**
 126    *  Set type of the specified section (or all sections
 127    *  if \a theISection is -1).
 128    */
 129   virtual bool setSectionType( const int theISection,
 130                                const CurveCreator::SectionType theType ) = 0;
 131
 132
 133   /***********************************************/
 134   /***           Point methods                 ***/
 135   /***********************************************/
 136
 137   //! Get the dimension.
 138   virtual CurveCreator::Dimension getDimension() const = 0;
 139
 140   /**
 141    *  Insert one or several points to the specified section starting from the given theIPnt index
 142    *  (or add these at the end of section points if \a theIPnt is -1).
 143    */
 144   virtual bool addPoints( const std::deque<float>& theCoords,
 145                           const int theISection,
 146                           const int theIPnt = -1 ) = 0;
 147
 148   //! Set coordinates of specified point
 149   virtual bool setPoint( const int theISection,
 150                          const int theIPnt,
 151                          const std::deque<float>& theNewCoords ) = 0;
 152
 153   //! Set coordinates of specified points from different sections
 154   virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords) = 0;
 155
 156   //! Remove point with given id
 157   virtual bool removePoint( const int theISection, const int theIPnt = -1 ) = 0;
 158   //! Remove several points from different sections
 159   virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs) = 0;
 160
 161   //! Get coordinates of specified point
 162   virtual std::deque<float> getPoint( const int theISection,
 163                                       const int theIPnt ) const = 0;
 164
 165   /**
 166    * Get points of a section (the total points in Curve if theISection is equal to -1)..
 167    */
 168   virtual std::deque<float> getPoints( const int theISection = -1 ) const = 0;
 169
 170   /**
 171    *  Get number of points in specified section or (the total number of points
 172    *  in Curve if theISection is equal to -1).
 173    */
 174   virtual int getNbPoints( const int theISection ) const = 0;
 175
 176
 177   /***********************************************/
 178   /***       Presentation methods              ***/
 179   /***********************************************/
 180
 181   virtual Handle_AIS_InteractiveObject getAISObject( const bool theNeedToBuild = false ) const = 0;
 182
 183 protected:
 184   virtual void constructAISObject() = 0;
 185
 186 };
 187
 188 #endif