CurveCreator_ICurve.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_ICurve.hxx
// Author:      Alexander KOVALEV and Alexander SOLOVYOV

#ifndef _CurveCreator_ICurve_HeaderFile
#define _CurveCreator_ICurve_HeaderFile

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

#include <TColgp_HArray1OfPnt.hxx>
#include <AIS_InteractiveObject.hxx>

#include <deque>
#include <vector>
#include <string>
#include <list>

namespace CurveCreator
{
  enum SectionType
  {
    Polyline,
    Spline,
  };

  enum Dimension
  {
    Dim2d = 2,
    Dim3d = 3
  };

};

struct CURVECREATOR_EXPORT CurveCreator_ISection
{
  virtual ~CurveCreator_ISection() {}

  virtual void GetDifferentPoints(
    const int theDimension, Handle(TColgp_HArray1OfPnt)& thePoints) const = 0;
};

class CURVECREATOR_EXPORT CurveCreator_ICurve
{
public:
  typedef std::pair<int,int> SectionToPoint;
  typedef std::deque<SectionToPoint> SectionToPointList;

  typedef std::deque< std::pair< SectionToPoint, CurveCreator::Coordinates > > SectionToPointCoordsList;

public:
  /***********************************************/
  /***          Undo/Redo methods              ***/
  /***********************************************/

  virtual ~CurveCreator_ICurve() {}

  virtual int getNbUndo() const = 0;

  virtual bool undo() = 0;

  virtual int getNbRedo() const = 0;

  virtual bool redo() = 0;


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

  virtual bool clear() = 0;

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

  virtual int getNbSections() const = 0;

  virtual int addSection( const std::string& theName, 
                           const CurveCreator::SectionType theType,
                           const bool theIsClosed ) = 0;

  virtual bool removeSection( const int theISection ) = 0;

  virtual bool isClosed( const int theISection ) const = 0;

  virtual bool setClosed( const int theISection, 
                          const bool theIsClosed ) = 0;

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

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

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

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

  virtual const CurveCreator_ISection* getSection(
    const int theSectionIndex) const = 0;

  virtual CurveCreator_ISection* getSection(const int theSectionIndex) = 0;


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

  virtual CurveCreator::Dimension getDimension() const = 0;

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

  virtual bool setPoint( const int theISection,
                         const int theIPnt,
                         const CurveCreator::Coordinates& theNewCoords ) = 0;
  
  virtual bool setSeveralPoints( const SectionToPointCoordsList &theSectionToPntCoords,
                                 const bool theIsToSaveDiff = true ) = 0;

  virtual bool removePoint( const int theISection, const int theIPnt = -1 ) = 0;
  virtual bool removeSeveralPoints( const SectionToPointList &theSectionToPntIDs) = 0;

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

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

  virtual int getNbPoints( const int theISection ) const = 0;

  virtual void setSkipSorting( const bool ) = 0;

  virtual bool canPointsBeSorted() = 0;

  virtual void saveCoordDiff( const SectionToPointCoordsList &theOldCoords ) = 0;

  /***********************************************/
  /***       Presentation methods              ***/
  /***********************************************/

  virtual Handle(AIS_InteractiveObject) getAISObject( const bool theNeedToBuild = false ) const = 0;

protected:
  virtual void constructAISObject() = 0;

};

#endif