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   /// Converts a 2D sketch space point into point in 3D space
  86   /// \param theX an X coordinate
  87   /// \param theY an Y coordinate
  88   std::shared_ptr<GeomAPI_Pnt> to3D(const double theX, const double theY) const
  89   {
  90     std::shared_ptr<GeomDataAPI_Point> aC = std::dynamic_pointer_cast<GeomDataAPI_Point>(
  91         data()->attribute(ORIGIN_ID()));
  92     std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
  93         data()->attribute(NORM_ID()));
  94     std::shared_ptr<GeomDataAPI_Dir> aX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
  95         data()->attribute(DIRX_ID()));
  96     std::shared_ptr<GeomAPI_Dir> aY(new GeomAPI_Dir(aNorm->dir()->cross(aX->dir())));
  97
  98     std::shared_ptr<GeomAPI_XYZ> aSum = aC->pnt()->xyz()->added(aX->dir()->xyz()->multiplied(theX))
  99         ->added(aY->xyz()->multiplied(theY));
 100
 101     return std::shared_ptr<GeomAPI_Pnt>(new GeomAPI_Pnt(aSum));
 102   }
 103
 104   /// Returns the point projected into the sketch plane
 105   /// \param thePnt a source 3d point
 106   std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& thePnt) const
 107   {
 108     std::shared_ptr<GeomDataAPI_Point> aC = std::dynamic_pointer_cast<GeomDataAPI_Point>(
 109         data()->attribute(ORIGIN_ID()));
 110     std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 111         data()->attribute(NORM_ID()));
 112     std::shared_ptr<GeomDataAPI_Dir> aX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 113         data()->attribute(DIRX_ID()));
 114     std::shared_ptr<GeomAPI_Dir> aY(new GeomAPI_Dir(aNorm->dir()->cross(aX->dir())));
 115     return thePnt->to2D(aC->pnt(), aX->dir(), aY);
 116   }
 117
 118   /// Returns true if this feature must be displayed in the history (top level of Part tree)
 119   SKETCHPLUGIN_EXPORT virtual bool isInHistory()
 120   {
 121     return true;
 122   }
 123
 124   /// Use plugin manager for features creation
 125   SketchPlugin_Sketch();
 126
 127   /// Returns the basis plane for the sketch
 128   std::shared_ptr<GeomAPI_Pln> plane() const
 129   {
 130     std::shared_ptr<GeomDataAPI_Point> anOrigin = std::dynamic_pointer_cast<GeomDataAPI_Point>(
 131         data()->attribute(ORIGIN_ID()));
 132     std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 133         data()->attribute(NORM_ID()));
 134
 135     if (!anOrigin || !aNorm)
 136       return std::shared_ptr<GeomAPI_Pln>();
 137
 138     return std::shared_ptr<GeomAPI_Pln>(new GeomAPI_Pln(anOrigin->pnt(), aNorm->dir()));
 139   }
 140
 141   /// Returns currently defined plane as an object of Ax3
 142   std::shared_ptr<GeomAPI_Ax3> coordinatePlane() const
 143   {
 144     DataPtr aData = data();
 145     std::shared_ptr<GeomDataAPI_Point> aC = std::dynamic_pointer_cast<GeomDataAPI_Point>(
 146       aData->attribute(ORIGIN_ID()));
 147     std::shared_ptr<GeomDataAPI_Dir> aX = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 148       aData->attribute(DIRX_ID()));
 149     std::shared_ptr<GeomDataAPI_Dir> aNorm = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 150       aData->attribute(NORM_ID()));
 151
 152     return std::shared_ptr<GeomAPI_Ax3>(new GeomAPI_Ax3(aC->pnt(), aX->dir(), aNorm->dir()));
 153   }
 154
 155   /// Checks whether the plane is set in the sketch.
 156   /// \returns the boolean state
 157   bool isPlaneSet() const
 158   {
 159     std::shared_ptr<GeomDataAPI_Dir> aNormal = std::dynamic_pointer_cast<GeomDataAPI_Dir>(
 160         data()->attribute(NORM_ID()));
 161
 162     return aNormal && !(aNormal->x() == 0 && aNormal->y() == 0 && aNormal->z() == 0);
 163   }
 164
 165
 166   /// removes also all sub-sketch elements
 167   SKETCHPLUGIN_EXPORT virtual void erase();
 168
 169   /// appends a feature to the sketch sub-elements container
 170   SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
 171
 172   /// Just to synchronise the container of sub-features
 173   virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
 174
 175   /// Returns the number of sub-elements
 176   SKETCHPLUGIN_EXPORT virtual int numberOfSubs(bool forTree = false) const;
 177
 178   /// Returns the sub-feature by zero-base index
 179   SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
 180     subFeature(const int theIndex, bool forTree = false);
 181
 182   /// Returns the sub-feature unique identifier in this composite feature by index
 183   SKETCHPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
 184
 185   /// Returns true if feature or reuslt belong to this composite feature as subs
 186   SKETCHPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
 187
 188   /// Construction result is allways recomuted on the fly
 189   SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
 190
 191   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 192
 193   /// \brief Create a result for the point in the attribute if the attribute is initialized
 194   /// \param theAttributeID an attribute string
 195   /// \param theIndex an index of the result
 196   static void createPoint2DResult(ModelAPI_Feature* theFeature,
 197                                   SketchPlugin_Sketch* theSketch,
 198                                   const std::string& theAttributeID, const int theIndex);
 199
 200   /// Add new feature and fill the data of the feature by the data of the parameter feature.
 201   /// The name of the created feature stays unique.
 202   /// \param theFeature a source feature
 203   /// \return a created feature
 204   static FeaturePtr addUniqueNamedCopiedFeature(FeaturePtr aFeature,
 205                                                 SketchPlugin_Sketch* theSketch);
 206
 207   /// Creates a plane of the sketch.
 208   /// \param theSketch a sketch intance
 209   static std::shared_ptr<GeomAPI_Ax3> plane(SketchPlugin_Sketch* theSketch);
 210
 211   /// Customize presentation of the feature
 212   virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
 213                                      std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs)
 214   {
 215     bool isCustomized = false;
 216     // apply the color of the result to the presentation
 217     if (theDefaultPrs.get())
 218       isCustomized = theDefaultPrs->customisePresentation(theResult, thePrs, theDefaultPrs);
 219     // set the sketch presentation bold
 220     isCustomized = thePrs->setWidth(2) || isCustomized;
 221
 222     return isCustomized;
 223   }
 224
 225 };
 226
 227 #endif