src/HYDROCurveCreator/CurveCreator_Curve.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_Curve.hxx
  21 // Author:      Sergey KHROMOV
  22
  23 #ifndef _CurveCreator_Curve_HeaderFile
  24 #define _CurveCreator_Curve_HeaderFile
  25
  26 #include "CurveCreator_ICurve.hxx"
  27
  28 #include "CurveCreator_Macro.hxx"
  29 #include "CurveCreator.hxx"
  30 #include "CurveCreator_Diff.hxx"
  31 #include "CurveCreator_AISCurve.hxx"
  32
  33 #include <AIS_Point.hxx>
  34 #include <AIS_Line.hxx>
  35 #include <AIS_InteractiveObject.hxx>
  36
  37 #include <list>
  38 #include <map>
  39
  40 struct CurveCreator_Section;
  41 class CurveCreator_Displayer;
  42
  43 /**
  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
  48  *  are not supported.
  49  */
  50 class CURVECREATOR_EXPORT CurveCreator_Curve : public CurveCreator_ICurve
  51 {
  52 protected:
  53   typedef std::list<CurveCreator_Diff> ListDiff;
  54
  55 public:
  56   //! Constructor of the curve.
  57   /** The dimension is explicitly specified in the constructor
  58    *  and cannot be changed later.
  59    */
  60   CurveCreator_Curve(const CurveCreator::Dimension theDimension);
  61
  62   //! Destructor.
  63   virtual ~CurveCreator_Curve();
  64
  65   //! Get the dimension.
  66   virtual CurveCreator::Dimension getDimension() const;
  67
  68   //! Return unique section name
  69   virtual std::string getUniqSectionName() const;
  70
  71   //! Set curve creator Displayer object
  72   virtual void setDisplayer( CurveCreator_Displayer* theDisplayer );
  73
  74   //! Return curve creator Displayer object
  75   CurveCreator_Displayer* getDisplayer();
  76
  77   //! Remove curve creator Displayer object
  78   virtual void removeDisplayer();
  79
  80   /** Set depth of undo operations (unlimited if \a theDepth is -1
  81    *  or disabled if \a theDepth is 0)
  82    */
  83   virtual void setUndoDepth(const int theDepth = -1);
  84
  85   //! Get depth of undo operations.
  86   virtual int getUndoDepth() const;
  87
  88   virtual void startOperation();
  89   virtual void finishOperation();
  90
  91   /**
  92    * This method converts the point index to the index in
  93    * an array of coordinates.
  94    */
  95   virtual int toICoord(const int theIPnt) const;
  96
  97   ListAISObjects constructSection( int theISection ) const;
  98
  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);
 105
 106 protected:
 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.
 110    */
 111   virtual bool addEmptyDiff();
 112
 113   Handle_AIS_Point getAISPoint( int theISection, int theIPoint ) const;
 114   Handle_AIS_Line  getAISLine( int theISection, int theIPoint1, int theIPoint2 ) const;
 115   void getCoordinates( int theISection, int theIPoint, double& theX, double& theY, double& theZ ) const;
 116
 117   void redisplayCurve();
 118
 119   void convert( const SectionToPointList &thePoints,
 120                 std::map<int, std::list<int> > &theConvPoints );
 121
 122 public:
 123   /************   Implementation of INTERFACE methods   ************/
 124
 125   /***********************************************/
 126   /***          Undo/Redo methods              ***/
 127   /***********************************************/
 128
 129   //! Get number of available undo operations
 130   virtual int getNbUndo() const;
 131
 132   //! Undo previous operation
 133   virtual bool undo();
 134
 135   //! Get number of available redo operations
 136   virtual int getNbRedo() const;
 137
 138   //! Redo last previously "undone" operation
 139   virtual bool redo();
 140
 141
 142   /***********************************************/
 143   /***           Section methods               ***/
 144   /***********************************************/
 145
 146   //! For internal use only! Undo/Redo are not used here.
 147   virtual bool clearInternal();
 148   //! Clear the polyline (remove all sections)
 149   virtual bool clear();
 150
 151   //! For internal use only! Undo/Redo are not used here.
 152   virtual bool joinInternal( const int theISectionTo = -1,
 153                              const int theISectionFrom = -1 );
 154   //! Join range of sections to one section (join all sections if -1 is passed in one of arguments)
 155   virtual bool join( const int theISectionTo = -1,
 156                      const int theISectionFrom = -1 );
 157
 158   //! Get number of sections
 159   virtual int getNbSections() const;
 160
 161   //! For internal use only! Undo/Redo are not used here.
 162   virtual int addSectionInternal( const std::string &theName,
 163                                   const CurveCreator::SectionType theType,
 164                                   const bool theIsClosed,
 165                                   const CurveCreator::Coordinates &thePoints);
 166   //! Add a new section.
 167   virtual int addSection( const std::string &theName,
 168                            const CurveCreator::SectionType theType,
 169                            const bool theIsClosed );
 170   //! Add a new section.
 171   virtual int addSection( const std::string &theName,
 172                            const CurveCreator::SectionType theType,
 173                            const bool theIsClosed,
 174                            const CurveCreator::Coordinates &thePoints);
 175
 176   //! For internal use only! Undo/Redo are not used here.
 177   virtual bool removeSectionInternal( const int theISection );
 178   //! Removes the given sections.
 179   virtual bool removeSection( const int theISection );
 180
 181   //! Get "closed" flag of the specified section
 182   virtual bool isClosed( const int theISection ) const;
 183
 184   //! For internal use only! Undo/Redo are not used here.
 185   virtual bool setClosedInternal( const int theISection,
 186                                   const bool theIsClosed );
 187   /**
 188    *  Set "closed" flag of the specified section (all sections if
 189    *  \a theISection is -1).
 190    */
 191   virtual bool setClosed( const int theISection,
 192                           const bool theIsClosed );
 193
 194   //! Returns specifyed section name
 195   virtual std::string getSectionName( const int theISection ) const;
 196
 197   //! For internal use only! Undo/Redo are not used here.
 198   virtual bool setSectionNameInternal( const int theISection,
 199                                        const std::string& theName );
 200   /** Set name of the specified section */
 201   virtual bool setSectionName( const int theISection,
 202                                const std::string& theName );
 203
 204   //! Get type of the specified section
 205   virtual CurveCreator::SectionType getSectionType( const int theISection ) const;
 206
 207   //! For internal use only! Undo/Redo are not used here.
 208   virtual bool setSectionTypeInternal( const int theISection,
 209                                        const CurveCreator::SectionType theType );
 210   /**
 211    *  Set type of the specified section (or all sections
 212    *  if \a theISection is -1).
 213    */
 214   virtual bool setSectionType( const int theISection,
 215                                const CurveCreator::SectionType theType );
 216
 217
 218   /***********************************************/
 219   /***           Point methods                 ***/
 220   /***********************************************/
 221
 222   //! For internal use only! Undo/Redo are not used here.
 223   virtual bool addPointsInternal( const CurveCreator::SectionsMap &theSectionsMap );
 224   /**
 225    *  Add one point to the specified section starting from the given theIPnt index
 226    *  (or at the end of points if \a theIPnt is -1).
 227    */
 228   virtual bool addPoints( const CurveCreator::Coordinates &theCoords,
 229                           const int theISection,
 230                           const int theIPnt = -1 );
 231
 232   //! For internal use only! Undo/Redo are not used here.
 233   virtual bool setPointInternal( const CurveCreator::SectionsMap &theSectionsMap );
 234    //! Set coordinates of specified point
 235   virtual bool setPoint( const int theISection,
 236                          const int theIPnt,
 237                          const CurveCreator::Coordinates& theNewCoords );
 238
 239   //! Set coordinates of specified points from different sections
 240   virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords);
 241
 242   //! For internal use only! Undo/Redo are not used here.
 243   virtual bool removePointsInternal( const SectionToPointList &thePoints );
 244   /** Remove point with given id */
 245   virtual bool removePoint( const int theISection, const int theIPnt = -1 );
 246
 247   //! Remove several points from different sections with given ids
 248   virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs);
 249
 250   //! Get coordinates of specified point
 251   virtual CurveCreator::Coordinates getPoint( const int theISection,
 252                                               const int theIPnt ) const;
 253
 254   /**
 255    * Get points of a section (the total points in Curve if theISection is equal to -1)..
 256    */
 257   virtual CurveCreator::Coordinates getPoints( const int theISection = -1 ) const;
 258
 259
 260   /**
 261    *  Get number of points in specified section or (the total number of points
 262    *  in Curve if theISection is equal to -1).
 263    */
 264   virtual int getNbPoints( const int theISection ) const;
 265
 266
 267   /***********************************************/
 268   /***       Presentation methods              ***/
 269   /***********************************************/
 270   virtual ListAISObjects constructWire() const;
 271
 272 public:
 273   Handle(CurveCreator_AISCurve)   myAISCurve;
 274   bool                            myIsLocked;
 275   CurveCreator::Sections          mySections;   //!< curve data
 276   CurveCreator::Dimension         myDimension;  //!< curve dimension
 277   CurveCreator_Displayer*         myDisplayer;  //!< curve displayer
 278
 279 private:
 280
 281   int                             myNbUndos;
 282   int                             myNbRedos;
 283   ListDiff::iterator              myCurrenPos;
 284   ListDiff                        myListDiffs;
 285   int                             myUndoDepth;
 286   int                             myOpLevel;
 287 };
 288
 289 #endif