src/SketchPlugin/SketchPlugin_Sketch.h

   1 // File:        SketchPlugin_Sketch.h
   2 // Created:     27 Mar 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef SketchPlugin_Sketch_HeaderFile
   6 #define SketchPlugin_Sketch_HeaderFile
   7
   8 #include "SketchPlugin.h"
   9 #include <SketchPlugin_Feature.h>
  10 #include <GeomAPI_Pnt.h>
  11 #include <GeomAPI_Pln.h>
  12 #include <list>
  13
  14 /// Sketch feature kind
  15 const std::string SKETCH_KIND("Sketch");
  16
  17 /// Origin point of the sketcher in 3D space
  18 const std::string SKETCH_ATTR_ORIGIN("Origin");
  19 /// Vector X inside of the sketch plane
  20 const std::string SKETCH_ATTR_DIRX("DirX");
  21 /// Vector Y inside of the sketch plane
  22 const std::string SKETCH_ATTR_DIRY("DirY");
  23 /// Vector Z, normal to the sketch plane
  24 const std::string SKETCH_ATTR_NORM("Norm");
  25 /// All features of this sketch (list of references)
  26 const std::string SKETCH_ATTR_FEATURES("Features");
  27
  28 /**\class SketchPlugin_Sketch
  29  * \ingroup DataModel
  30  * \brief Feature for creation of the new part in PartSet.
  31  */
  32 class SketchPlugin_Sketch: public SketchPlugin_Feature
  33 {
  34 public:
  35   /// Returns the kind of a feature
  36   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  37   {static std::string MY_KIND = SKETCH_KIND; return MY_KIND;}
  38
  39   /// Returns to which group in the document must be added feature
  40   SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
  41   {static std::string MY_GROUP = "Construction"; return MY_GROUP;}
  42
  43   /// Creates a new part document if needed
  44   SKETCHPLUGIN_EXPORT virtual void execute();
  45
  46   /// Request for initialization of data model of the feature: adding all attributes
  47   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  48
  49   /// Returns the sketch preview
  50   SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
  51
  52   /// Returns the AIS preview
  53   SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
  54                                 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
  55
  56   /// Adds sub-feature of the higher level feature (sub-element of the sketch)
  57   /// \param theFeature sub-feature
  58   SKETCHPLUGIN_EXPORT virtual const void addSub(
  59     const FeaturePtr& theFeature);
  60
  61   /// Moves the feature
  62   /// \param theDeltaX the delta for X coordinate is moved
  63   /// \param theDeltaY the delta for Y coordinate is moved
  64   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) {};
  65
  66   /// Return the distance between the feature and the point
  67   /// \param thePoint the point
  68   virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint) { return 0; };
  69
  70   /// Converts a 2D sketch space point into point in 3D space
  71   SKETCHPLUGIN_EXPORT boost::shared_ptr<GeomAPI_Pnt> to3D(
  72     const double theX, const double theY);
  73
  74   /// Returns true if this feature must be displayed in the history (top level of Part tree)
  75   SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return true;}
  76
  77   /// Use plugin manager for features creation
  78   SketchPlugin_Sketch();
  79
  80   /// Returns the basis plane for the sketch
  81   boost::shared_ptr<GeomAPI_Pln> plane();
  82 protected:
  83   /// Creates a plane and append it to the list
  84   /// \param theX the X normal value
  85   /// \param theY the Y normal value
  86   /// \param theZ the Z normal value
  87   /// \param theShapes the list of result shapes
  88   void addPlane(double theX, double theY, double theZ,
  89                 std::list<boost::shared_ptr<GeomAPI_Shape> >& theShapes) const;
  90
  91   /// Checks whether the plane is set in the sketch.
  92   /// \returns the boolean state
  93   bool isPlaneSet();
  94 };
  95
  96 #endif