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