src/SketchPlugin/SketchPlugin_Sketch.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        SketchPlugin_Sketch.h
   4 // Created:     27 Mar 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef SketchPlugin_Sketch_H_
   8 #define SketchPlugin_Sketch_H_
   9
  10 #include "SketchPlugin.h"
  11 #include <SketchPlugin_Feature.h>
  12 #include <GeomAPI_Pnt.h>
  13 #include <GeomAPI_Pln.h>
  14 #include <GeomAPI_IPresentable.h>
  15 #include <GeomAPI_ICustomPrs.h>
  16
  17 #include <GeomAPI_Ax3.h>
  18 #include <GeomAPI_XYZ.h>
  19 #include <GeomDataAPI_Point.h>
  20 #include <GeomDataAPI_Dir.h>
  21 #include <list>
  22
  23 #define YZ_PLANE_COLOR "225,0,0"
  24 #define XZ_PLANE_COLOR "0,225,0"
  25 #define XY_PLANE_COLOR "0,0,225"
  26
  27 /**\class SketchPlugin_Sketch
  28  * \ingroup Plugins
  29  * \brief Feature for creation of the new part in PartSet.
  30  */
  31 class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICustomPrs//, public GeomAPI_IPresentable
  32 {
  33  public:
  34   /// Sketch feature kind
  35   inline static const std::string& ID()
  36   {
  37     static const std::string MY_SKETCH_ID("Sketch");
  38     return MY_SKETCH_ID;
  39   }
  40   /// Origin point of the sketcher in 3D space
  41   inline static const std::string& ORIGIN_ID()
  42   {
  43     static const std::string MY_ORIGIN_ID("Origin");
  44     return MY_ORIGIN_ID;
  45   }
  46   /// Vector X inside of the sketch plane
  47   inline static const std::string& DIRX_ID()
  48   {
  49     static const std::string MY_DIRX_ID("DirX");
  50     return MY_DIRX_ID;
  51   }
  52   /// Vector Z, normal to the sketch plane
  53   inline static const std::string& NORM_ID()
  54   {
  55     static const std::string MY_NORM_ID("Norm");
  56     return MY_NORM_ID;
  57   }
  58   /// All features of this sketch (list of references)
  59   inline static const std::string& FEATURES_ID()
  60   {
  61     static const std::string MY_FEATURES_ID("Features");
  62     return MY_FEATURES_ID;
  63   }
  64
  65   /// Returns the kind of a feature
  66   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  67   {
  68     static std::string MY_KIND = SketchPlugin_Sketch::ID();
  69     return MY_KIND;
  70   }
  71
  72   /// Creates a new part document if needed
  73   SKETCHPLUGIN_EXPORT virtual void execute();
  74
  75   /// Request for initialization of data model of the feature: adding all attributes
  76   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  77
  78   /// Moves the feature
  79   /// \param theDeltaX the delta for X coordinate is moved
  80   /// \param theDeltaY the delta for Y coordinate is moved
  81   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY)
  82   {
  83   }
  84
  85   /// Return the distance between the feature and the point
  86   /// \param thePoint the point
  87   virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint)
  88   {
  89     return 0;
  90   }
  91
  92   /// Converts a 2D sketch space point into point in 3D space
  93   /// \param theX an X coordinate
  94   /// \param theY an Y coordinate
  95   std::shared_ptr<GeomAPI_Pnt> to3D(const double theX, const double theY) const
  96   {
  97     std::shared_ptr<GeomDataAPI_Point> aC = std::dynamic_pointer_cast<GeomDataAPI_Point>(
  98         data()->attribute(ORIGIN_ID()));
  99     std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 100         data()->attribute(NORM_ID()));
 101     std::shared_ptr<GeomDataAPI_Dir> aX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 102         data()->attribute(DIRX_ID()));
 103     std::shared_ptr<GeomAPI_Dir> aY(new GeomAPI_Dir(aNorm->dir()->cross(aX->dir())));
 104
 105     std::shared_ptr<GeomAPI_XYZ> aSum = aC->pnt()->xyz()->added(aX->dir()->xyz()->multiplied(theX))
 106         ->added(aY->xyz()->multiplied(theY));
 107
 108     return std::shared_ptr<GeomAPI_Pnt>(new GeomAPI_Pnt(aSum));
 109   }
 110
 111   /// Returns the point projected into the sketch plane
 112   /// \param thePnt a source 3d point
 113   std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& thePnt) const
 114   {
 115     std::shared_ptr<GeomDataAPI_Point> aC = std::dynamic_pointer_cast<GeomDataAPI_Point>(
 116         data()->attribute(ORIGIN_ID()));
 117     std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 118         data()->attribute(NORM_ID()));
 119     std::shared_ptr<GeomDataAPI_Dir> aX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 120         data()->attribute(DIRX_ID()));
 121     std::shared_ptr<GeomAPI_Dir> aY(new GeomAPI_Dir(aNorm->dir()->cross(aX->dir())));
 122     return thePnt->to2D(aC->pnt(), aX->dir(), aY);
 123   }
 124
 125   /// Returns true if this feature must be displayed in the history (top level of Part tree)
 126   SKETCHPLUGIN_EXPORT virtual bool isInHistory()
 127   {
 128     return true;
 129   }
 130
 131   /// Use plugin manager for features creation
 132   SketchPlugin_Sketch();
 133
 134   /// Returns the basis plane for the sketch
 135   std::shared_ptr<GeomAPI_Pln> plane() const
 136   {
 137     std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
 138         data()->attribute(ORIGIN_ID()));
 139     std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 140         data()->attribute(NORM_ID()));
 141
 142     if (!anOrigin || !aNorm)
 143       return std::shared_ptr<GeomAPI_Pln>();
 144
 145     return std::shared_ptr<GeomAPI_Pln>(new GeomAPI_Pln(anOrigin->pnt(), aNorm->dir()));
 146   }
 147
 148   /// Returns currently defined plane as an object of Ax3
 149   std::shared_ptr<GeomAPI_Ax3> coordinatePlane() const
 150   {
 151     DataPtr aData = data();
 152     std::shared_ptr<GeomDataAPI_Point> aC = std::dynamic_pointer_cast<GeomDataAPI_Point>(
 153       aData->attribute(ORIGIN_ID()));
 154     std::shared_ptr<GeomDataAPI_Dir> aX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 155       aData->attribute(DIRX_ID()));
 156     std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 157       aData->attribute(NORM_ID()));
 158
 159     return std::shared_ptr<GeomAPI_Ax3>(new GeomAPI_Ax3(aC->pnt(), aX->dir(), aNorm->dir()));
 160   }
 161
 162   /// Checks whether the plane is set in the sketch.
 163   /// \returns the boolean state
 164   bool isPlaneSet() const
 165   {
 166     std::shared_ptr<GeomDataAPI_Dir> aNormal = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 167         data()->attribute(NORM_ID()));
 168
 169     return aNormal && !(aNormal->x() == 0 && aNormal->y() == 0 && aNormal->z() == 0);
 170   }
 171
 172
 173   /// removes also all sub-sketch elements
 174   SKETCHPLUGIN_EXPORT virtual void erase();
 175
 176   /// appends a feature to the sketch sub-elements container
 177   SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
 178
 179   /// Just to synchronise the container of sub-features
 180   virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
 181
 182   /// Returns the number of sub-elements
 183   SKETCHPLUGIN_EXPORT virtual int numberOfSubs() const;
 184
 185   /// Returns the sub-feature by zero-base index
 186   SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
 187     subFeature(const int theIndex) const;
 188
 189   /// Returns the sub-feature unique identifier in this composite feature by zero-base index
 190   SKETCHPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
 191
 192   /// Returns true if feature or reuslt belong to this composite feature as subs
 193   SKETCHPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
 194
 195   /// Construction result is allways recomuted on the fly
 196   SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
 197
 198   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 199
 200   /// \brief Create a result for the point in the attribute if the attribute is initialized
 201   /// \param theAttributeID an attribute string
 202   /// \param theIndex an index of the result
 203   static void createPoint2DResult(ModelAPI_Feature* theFeature,
 204                                   SketchPlugin_Sketch* theSketch,
 205                                   const std::string& theAttributeID, const int theIndex);
 206
 207   /// Add new feature and fill the data of the feature by the data of the parameter feature.
 208   /// The name of the created feature stays unique.
 209   /// \param theFeature a source feature
 210   /// \return a created feature
 211   static FeaturePtr addUniqueNamedCopiedFeature(FeaturePtr aFeature,
 212                                                 SketchPlugin_Sketch* theSketch);
 213
 214   /// Creates a plane of the sketch.
 215   /// \param theSketch a sketch intance
 216   static std::shared_ptr<GeomAPI_Ax3> plane(SketchPlugin_Sketch* theSketch);
 217
 218   /// Customize presentation of the feature
 219   virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
 220                                      std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs)
 221   {
 222     bool isCustomized = false;
 223     // apply the color of the result to the presentation
 224     if (theDefaultPrs.get())
 225       isCustomized = theDefaultPrs->customisePresentation(theResult, thePrs, theDefaultPrs);
 226     // set the sketch presentation bold
 227     isCustomized = thePrs->setWidth(2) || isCustomized;
 228
 229     return isCustomized;
 230   }
 231
 232 };
 233
 234 #endif