SketchAPI_Ellipse.h

// Copyright (C) 2014-2026  CEA, EDF
//
// 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
//
 
#ifndef SketchAPI_Ellipse_H_
#define SketchAPI_Ellipse_H_
 
#include "SketchAPI.h"
#include "SketchAPI_SketchEntity.h"
 
#include <SketchPlugin_Ellipse.h>
 
class ModelHighAPI_Selection;
 
typedef std::pair<std::string, std::string> PairOfStrings;
 
class SketchAPI_Ellipse : public SketchAPI_SketchEntity
{
public:
  SKETCHAPI_EXPORT
  explicit SketchAPI_Ellipse(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  SKETCHAPI_EXPORT
  SketchAPI_Ellipse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                    double theCenterX, double theCenterY,
                    double theFocusX, double theFocusY,
                    double theMinorRadius);
 
  SKETCHAPI_EXPORT
  SketchAPI_Ellipse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                    const std::shared_ptr<GeomAPI_Pnt2d>& theCenter,
                    const std::shared_ptr<GeomAPI_Pnt2d>& theFocus,
                    double theMinorRadius);
 
  SKETCHAPI_EXPORT
  SketchAPI_Ellipse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                    const ModelHighAPI_Selection& theExternal);
 
  SKETCHAPI_EXPORT
  SketchAPI_Ellipse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                    const std::wstring& theExternalName);
 
  SKETCHAPI_EXPORT
  virtual ~SketchAPI_Ellipse();
 
  INTERFACE_10(SketchPlugin_Ellipse::ID(),
               center, SketchPlugin_Ellipse::CENTER_ID(),
               GeomDataAPI_Point2D, ,
               firstFocus, SketchPlugin_Ellipse::FIRST_FOCUS_ID(),
               GeomDataAPI_Point2D, ,
               secondFocus, SketchPlugin_Ellipse::SECOND_FOCUS_ID(),
               GeomDataAPI_Point2D, ,
               majorAxisNegative, SketchPlugin_Ellipse::MAJOR_AXIS_START_ID(),
               GeomDataAPI_Point2D, ,
               majorAxisPositive, SketchPlugin_Ellipse::MAJOR_AXIS_END_ID(),
               GeomDataAPI_Point2D, ,
               minorAxisNegative, SketchPlugin_Ellipse::MINOR_AXIS_START_ID(),
               GeomDataAPI_Point2D, ,
               minorAxisPositive, SketchPlugin_Ellipse::MINOR_AXIS_END_ID(),
               GeomDataAPI_Point2D, ,
               majorRadius, SketchPlugin_Ellipse::MAJOR_RADIUS_ID(),
               ModelAPI_AttributeDouble, ,
               minorRadius, SketchPlugin_Ellipse::MINOR_RADIUS_ID(),
               ModelAPI_AttributeDouble, ,
               external, SketchPlugin_Ellipse::EXTERNAL_ID(),
               ModelAPI_AttributeSelection, )
 
  
  SKETCHAPI_EXPORT
  void setByCenterFocusAndRadius(double theCenterX, double theCenterY,
                                 double theFocusX, double theFocusY,
                                 double theMinorRadius);
 
  SKETCHAPI_EXPORT
  void setByCenterFocusAndRadius(const std::shared_ptr<GeomAPI_Pnt2d>& theCenter,
                                 const std::shared_ptr<GeomAPI_Pnt2d>& theFocus,
                                 double theMinorRadius);
 
  SKETCHAPI_EXPORT
  void setByExternal(const ModelHighAPI_Selection& theExternal);
 
  SKETCHAPI_EXPORT
  void setByExternalName(const std::wstring& theExternalName);
 
  SKETCHAPI_EXPORT
  void setCenter(double theX, double theY);
 
  SKETCHAPI_EXPORT
  void setCenter(const std::shared_ptr<GeomAPI_Pnt2d>& theCenter);
 
  SKETCHAPI_EXPORT
  void setFocus(double theX, double theY);
 
  SKETCHAPI_EXPORT
  void setFocus(const std::shared_ptr<GeomAPI_Pnt2d>& theFocus);
 
  SKETCHAPI_EXPORT
  void setMinorRadius(double theRadius);
 
  SKETCHAPI_EXPORT
  std::list<std::shared_ptr<SketchAPI_SketchEntity> > construction(
      const std::wstring& center = std::wstring(),
      const std::wstring& firstFocus = std::wstring(),
      const std::wstring& secondFocus = std::wstring(),
      const std::wstring& majorAxisStart = std::wstring(),
      const std::wstring& majorAxisEnd = std::wstring(),
      const std::wstring& minorAxisStart = std::wstring(),
      const std::wstring& minorAxisEnd = std::wstring(),
      const std::wstring& majorAxis = std::wstring(),
      const std::wstring& minorAxis = std::wstring()) const;
 
  SKETCHAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 
private:
  static void collectAuxiliaryFeatures(FeaturePtr theEllipse,
                                       const PairOfStrings& theMajorAxis,
                                       const PairOfStrings& theMinorAxis,
                                       std::map<std::string, FeaturePtr>& theAttrToFeature);
 
  static void dumpConstructionEntities(ModelHighAPI_Dumper& theDumper,
                                       const FeaturePtr& theEllipse,
                                       const std::list<PairOfStrings>& theAttributes,
                                       const std::map<std::string, FeaturePtr>& theAuxFeatures);
 
  static std::list<std::shared_ptr<SketchAPI_SketchEntity> > buildConstructionEntities(
      const FeaturePtr& theEllipse,
      const std::list<PairOfStrings>& theAttributes,
      const std::wstring& theCenter,
      const std::wstring& theFirstFocus,
      const std::wstring& theSecondFocus,
      const std::wstring& theMajorAxisStart,
      const std::wstring& theMajorAxisEnd,
      const std::wstring& theMinorAxisStart,
      const std::wstring& theMinorAxisEnd,
      const std::wstring& theMajorAxis,
      const std::wstring& theMinorAxis);
 
  friend class SketchAPI_EllipticArc;
};
 
typedef std::shared_ptr<SketchAPI_Ellipse> EllipsePtr;
 
#endif // SketchPlugin_Ellipse_H_