src/SketchAPI/SketchAPI_Rectangle.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   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, or (at your option) any later version.
   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 #ifndef SRC_SKETCHAPI_SKETCHAPI_RECTANGLE_H_
  21 #define SRC_SKETCHAPI_SKETCHAPI_RECTANGLE_H_
  22
  23 //--------------------------------------------------------------------------------------
  24 #include "SketchAPI.h"
  25
  26 #include "SketchAPI_SketchEntity.h"
  27
  28 //--------------------------------------------------------------------------------------
  29 class ModelHighAPI_Selection;
  30 class SketchAPI_Point;
  31 //--------------------------------------------------------------------------------------
  32 /**\class SketchAPI_Rectangle
  33  * \ingroup CPPHighAPI
  34  * \brief Interface for Rectangle feature
  35  */
  36 class SketchAPI_Rectangle : public SketchAPI_SketchEntity
  37 {
  38 public:
  39   /// Constructor without values
  40   SKETCHAPI_EXPORT
  41   explicit SketchAPI_Rectangle(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  42   /// Constructor with values
  43   SKETCHAPI_EXPORT
  44   SketchAPI_Rectangle(const std::shared_ptr<ModelAPI_Feature> & theFeature,
  45                       double theX1, double theY1,
  46                       double theX2, double theY2,
  47                       bool theCreateByCenterAndCorner = false);
  48   /// Constructor with values
  49   SKETCHAPI_EXPORT
  50   SketchAPI_Rectangle(const std::shared_ptr<ModelAPI_Feature> & theFeature,
  51                       const std::shared_ptr<GeomAPI_Pnt2d> & thePoint1,
  52                       const std::shared_ptr<GeomAPI_Pnt2d> & thePoint2,
  53                       bool theCreateByCenterAndCorner = false);
  54
  55
  56
  57   /// Destructor
  58   SKETCHAPI_EXPORT
  59   virtual ~SketchAPI_Rectangle() = default;
  60
  61   INTERFACE_7("SketchRectangle",
  62               type, "RectangleType", ModelAPI_AttributeString,
  63               /** Creation type of rectangle */,
  64               startPoint, "RectStartPoint", GeomDataAPI_Point2D,
  65               /** Start point */,
  66               endPoint, "RectEndPoint", GeomDataAPI_Point2D,
  67               /** End point */,
  68               centerPoint, "RectCenterPoint", GeomDataAPI_Point2D,
  69               /** Center point */,
  70               centerPointRef, "RectCenterPointRef", ModelAPI_AttributeRefAttr,
  71               /** Reference to center point */,
  72               cornerPoint, "RectCornerPoint", GeomDataAPI_Point2D,
  73               /** Corner point */,
  74               linesList, "RectangleList", ModelAPI_AttributeRefList,
  75               /** Lines list */
  76   )
  77
  78   /// Set by coordinates
  79   SKETCHAPI_EXPORT
  80   void setByCoordinates(double theX1, double theY1, double theX2, double theY2);
  81
  82   /// Set by points
  83   SKETCHAPI_EXPORT
  84   void setByPoints(const std::shared_ptr<GeomAPI_Pnt2d> & theFirstPoint,
  85                    const std::shared_ptr<GeomAPI_Pnt2d> & theSecondPoint);
  86
  87   /// Set by coordinates
  88   SKETCHAPI_EXPORT
  89   void setByCenterAndCornerCoords(
  90     double theCenterX, double theCenterY,
  91     double theCornerX, double theCornerY
  92   );
  93
  94   /// Set by points
  95   SKETCHAPI_EXPORT
  96   void setByCenterAndCornerPoints(
  97     const std::shared_ptr<GeomAPI_Pnt2d> & theCenterPoint,
  98     const std::shared_ptr<GeomAPI_Pnt2d> & theCornerPoint
  99   );
 100
 101   /// List of lines composing rectangle
 102   SKETCHAPI_EXPORT std::list<std::shared_ptr<SketchAPI_SketchEntity> > lines() const;
 103
 104   SKETCHAPI_EXPORT std::shared_ptr<SketchAPI_Point> centerSketchPoint() const;
 105 };
 106
 107 //! Pointer on Rectangle object
 108 typedef std::shared_ptr<SketchAPI_Rectangle> RectanglePtr;
 109
 110 //--------------------------------------------------------------------------------------
 111 //--------------------------------------------------------------------------------------
 112 #endif /* SRC_SKETCHAPI_SKETCHAPI_RECTANGLE_H_ */