CurveCreator_Curve.hxx

Go to the documentation of this file.

// Copyright (C) 2013-2016  CEA/DEN, EDF R&D, OPEN CASCADE
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

// File:        CurveCreator_Curve.hxx
// Author:      Sergey KHROMOV

#ifndef _CurveCreator_Curve_HeaderFile
#define _CurveCreator_Curve_HeaderFile

#include "CurveCreator_ICurve.hxx"

#include "CurveCreator_Macro.hxx"
#include "CurveCreator.hxx"
#include "CurveCreator_Diff.hxx"

#include <list>
#include <map>

struct CurveCreator_Section;
class CurveCreator_Displayer;
class AIS_Shape;
class AIS_InteractiveObject;

class CURVECREATOR_EXPORT CurveCreator_Curve : public CurveCreator_ICurve
{
protected:
  typedef std::list<CurveCreator_Diff> ListDiff;

public:

  CurveCreator_Curve(const CurveCreator::Dimension theDimension);

  virtual ~CurveCreator_Curve();

  virtual CurveCreator::Dimension getDimension() const;

  virtual std::string getUniqSectionName() const;

  virtual void setDisplayer( CurveCreator_Displayer* theDisplayer );

  CurveCreator_Displayer* getDisplayer();

  virtual void removeDisplayer();

  virtual void setUndoDepth(const int theDepth = -1);

  virtual int getUndoDepth() const;

  virtual void startOperation();
  virtual void finishOperation();

  virtual int toICoord(const int theIPnt) const;

  virtual bool moveSectionInternal(const int theISection,
                           const int theNewIndex);
  virtual bool moveSection(const int theISection,
                   const int theNewIndex);

protected:
  virtual bool addEmptyDiff();

public: // TODO: remove public
  void getCoordinates( int theISection, int theIPoint, double& theX, double& theY, double& theZ ) const;
protected:  // TODO: remove public
  void redisplayCurve();

public:
  /************   Implementation of INTERFACE methods   ************/

  /***********************************************/
  /***          Undo/Redo methods              ***/
  /***********************************************/

  virtual int getNbUndo() const;

  virtual bool undo();

  virtual int getNbRedo() const;

  virtual bool redo();


  /***********************************************/
  /***           Section methods               ***/
  /***********************************************/

  virtual bool clearInternal();
  virtual bool clear();

  virtual bool joinInternal( const std::list<int>& theSections );

  // The first section in the list is a leader, another sections are joined to it
  virtual bool join( const std::list<int>& theSections );

  virtual int getNbSections() const;

  virtual int addSectionInternal( const std::string &theName, 
                                  const CurveCreator::SectionType theType,
                                  const bool theIsClosed,
                                  const CurveCreator::Coordinates &thePoints);
  virtual int addSection( const std::string &theName, 
                           const CurveCreator::SectionType theType,
                           const bool theIsClosed );
  virtual int addSection( const std::string &theName, 
                           const CurveCreator::SectionType theType,
                           const bool theIsClosed,
                           const CurveCreator::Coordinates &thePoints);
  
  virtual bool removeSectionInternal( const int theISection );
  virtual bool removeSection( const int theISection );

  virtual bool isClosed( const int theISection ) const;

  virtual bool setClosedInternal( const int theISection, 
                                  const bool theIsClosed );
  virtual bool setClosed( const int theISection, 
                          const bool theIsClosed );

  virtual std::string getSectionName( const int theISection ) const;

  virtual bool setSectionNameInternal( const int theISection, 
                                       const std::string& theName );
  virtual bool setSectionName( const int theISection, 
                               const std::string& theName );

  virtual CurveCreator::SectionType getSectionType( const int theISection ) const;

  virtual bool setSectionTypeInternal( const int theISection, 
                                       const CurveCreator::SectionType theType );
  virtual bool setSectionType( const int theISection, 
                               const CurveCreator::SectionType theType );

  const CurveCreator_ISection* getSection(const int theSectionIndex) const
  {
    if (theSectionIndex >= 0 && theSectionIndex < mySections.size())
    {
      return (CurveCreator_ISection*)mySections[theSectionIndex];
    }
    return NULL;
  }

  CurveCreator_ISection* getSection(const int theSectionIndex)
  {
    return (CurveCreator_ISection*)mySections[theSectionIndex];
  }

  /***********************************************/
  /***           Point methods                 ***/
  /***********************************************/

  virtual bool addPointsInternal( const CurveCreator::SectionsMap &theSectionsMap );
  virtual bool addPoints( const CurveCreator::Coordinates &theCoords,
                          const int theISection,
                          const int theIPnt = -1 );

  virtual bool setPointInternal( const CurveCreator::SectionsMap &theSectionsMap );
  virtual bool setPoint( const int theISection,
                         const int theIPnt,
                         const CurveCreator::Coordinates& theNewCoords );

  virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords,
                                 const bool theIsToSaveDiff = true );

  virtual bool removePointsInternal( const SectionToPointList &thePoints );
  virtual bool removePoint( const int theISection, const int theIPnt = -1 );

  virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs);

  virtual CurveCreator::Coordinates getPoint( const int theISection, 
                                              const int theIPnt ) const;

  virtual CurveCreator::Coordinates getPoints( const int theISection = -1 ) const;


  virtual int getNbPoints( const int theISection ) const;

  virtual void setSkipSorting( const bool theIsToSkip );

  virtual bool canPointsBeSorted();

  virtual void saveCoordDiff( const SectionToPointCoordsList &theOldCoords );

  /***********************************************/
  /***       Presentation methods              ***/
  /***********************************************/
  virtual Handle(AIS_InteractiveObject) getAISObject( const bool theNeedToBuild = false ) const;

protected:
  bool removeSectionPoints( const int theSectionId,
                            const std::list<int>& thePointIds );
  void convert( const SectionToPointList &thePoints,
                std::map<int, std::list<int> > &theConvPoints );

protected:
  virtual void constructAISObject();

protected:
  bool                            mySkipSorting;

public:
  bool                            myIsLocked;
  CurveCreator::Sections          mySections;   
  CurveCreator::Dimension         myDimension;  
  CurveCreator_Displayer*         myDisplayer;  

private:

  int                             myNbUndos;
  int                             myNbRedos;
  ListDiff::iterator              myCurrenPos;
  ListDiff                        myListDiffs;
  int                             myUndoDepth;
  int                             myOpLevel;
  AIS_Shape*                      myAISShape;   
};

#endif