src/ConstructionPlugin/ConstructionPlugin_Point.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef ConstructionPlugin_Point_H_
  22 #define ConstructionPlugin_Point_H_
  23
  24 #include "ConstructionPlugin.h"
  25
  26 #include <GeomAPI_ICustomPrs.h>
  27 #include <ModelAPI_Feature.h>
  28 #include <ModelAPI_Result.h>
  29
  30 #include <math.h>
  31
  32 class GeomAPI_Vertex;
  33
  34 /// \class ConstructionPlugin_Point
  35 /// \ingroup Plugins
  36 /// \brief Feature for creation of the new part in PartSet.
  37 class ConstructionPlugin_Point: public ModelAPI_Feature, public GeomAPI_ICustomPrs
  38 {
  39 public:
  40   /// Returns the kind of a feature.
  41   CONSTRUCTIONPLUGIN_EXPORT virtual const std::string& getKind();
  42
  43   /// Point kind.
  44   inline static const std::string& ID()
  45   {
  46     static const std::string CONSTRUCTION_POINT_KIND("Point");
  47     return CONSTRUCTION_POINT_KIND;
  48   }
  49
  50   /// Attribute name for creation method.
  51   inline static const std::string& CREATION_METHOD()
  52   {
  53     static const std::string MY_CREATION_METHOD_ID("creation_method");
  54     return MY_CREATION_METHOD_ID;
  55   }
  56
  57   /// Attribute name for creation method.
  58   inline static const std::string& CREATION_METHOD_BY_XYZ()
  59   {
  60     static const std::string MY_CREATION_METHOD_ID("by_xyz");
  61     return MY_CREATION_METHOD_ID;
  62   }
  63
  64   /// Attribute name for creation method.
  65   inline static const std::string& CREATION_METHOD_BY_DISTANCE_ON_EDGE()
  66   {
  67     static const std::string MY_CREATION_METHOD_ID("by_distance_on_edge");
  68     return MY_CREATION_METHOD_ID;
  69   }
  70
  71   /*
  72   /// Attribute name for creation method.
  73   inline static const std::string& CREATION_METHOD_BY_PROJECTION()
  74   {
  75     static const std::string MY_CREATION_METHOD_ID("by_projection");
  76     return MY_CREATION_METHOD_ID;
  77   }
  78
  79   /// Attribute name for creation method.
  80   inline static const std::string& CREATION_METHOD_BY_LINES_INTERSECTION()
  81   {
  82     static const std::string MY_CREATION_METHOD_ID("by_lines_intersection");
  83     return MY_CREATION_METHOD_ID;
  84   }
  85   */
  86
  87   /// Attribute name for creation method.
  88   inline static const std::string& CREATION_METHOD_BY_LINE_AND_PLANE_INTERSECTION()
  89   {
  90     static const std::string MY_CREATION_METHOD_ID("by_line_and_plane_intersection");
  91     return MY_CREATION_METHOD_ID;
  92   }
  93
  94   /// Attribute name for X coordinate.
  95   inline static const std::string& X()
  96   {
  97     static const std::string POINT_ATTR_X("x");
  98     return POINT_ATTR_X;
  99   }
 100
 101   /// Attribute name for Y coordinate.
 102   inline static const std::string& Y()
 103   {
 104     static const std::string POINT_ATTR_Y("y");
 105     return POINT_ATTR_Y;
 106   }
 107
 108   /// Attribute name for Z coordinate.
 109   inline static const std::string& Z()
 110   {
 111     static const std::string POINT_ATTR_Z("z");
 112     return POINT_ATTR_Z;
 113   }
 114
 115   /// Attribute name for selected edge.
 116   inline static const std::string& EDGE()
 117   {
 118     static const std::string ATTR_ID("edge");
 119     return ATTR_ID;
 120   }
 121
 122   /// Attribute name for offset type on selected edge.
 123   inline static const std::string& OFFSET_TYPE()
 124   {
 125     static const std::string ATTR_ID("offset_type");
 126     return ATTR_ID;
 127   }
 128
 129   /// Attribute name for offset type by distance.
 130   inline static const std::string& OFFSET_TYPE_BY_DISTANCE()
 131   {
 132     static const std::string ATTR_ID("offset_type_by_distance");
 133     return ATTR_ID;
 134   }
 135
 136   /// Attribute name for offset type by ratio.
 137   inline static const std::string& OFFSET_TYPE_BY_RATIO()
 138   {
 139     static const std::string ATTR_ID("offset_type_by_ratio");
 140     return ATTR_ID;
 141   }
 142
 143   /// Attribute name for distance.
 144   inline static const std::string& DISTANCE()
 145   {
 146     static const std::string ATTR_ID("distance");
 147     return ATTR_ID;
 148   }
 149
 150   /// Attribute name for percent flag.
 151   inline static const std::string& RATIO()
 152   {
 153     static const std::string ATTR_ID("ratio");
 154     return ATTR_ID;
 155   }
 156
 157   /// Attribute name for reverse flag.
 158   inline static const std::string& REVERSE()
 159   {
 160     static const std::string ATTR_ID("reverse");
 161     return ATTR_ID;
 162   }
 163
 164   /*
 165   /// Attribute name for point.
 166   inline static const std::string& POINT()
 167   {
 168     static const std::string ATTR_ID("point");
 169     return ATTR_ID;
 170   }
 171
 172   /// Attribute name for plane.
 173   inline static const std::string& PLANE()
 174   {
 175     static const std::string ATTR_ID("plane");
 176     return ATTR_ID;
 177   }
 178
 179   /// Attribute name for selected first line.
 180   inline static const std::string& FIRST_LINE()
 181   {
 182     static const std::string ATTR_ID("first_line");
 183     return ATTR_ID;
 184   }
 185
 186   /// Attribute name for selected second line.
 187   inline static const std::string& SECOND_LINE()
 188   {
 189     static const std::string ATTR_ID("second_line");
 190     return ATTR_ID;
 191   }
 192   */
 193
 194   /// Attribute name for selected intersection line.
 195   inline static const std::string& INTERSECTION_LINE()
 196   {
 197     static const std::string ATTR_ID("intersection_line");
 198     return ATTR_ID;
 199   }
 200
 201   /// Attribute name for selected intersection plane.
 202   inline static const std::string& INTERSECTION_PLANE()
 203   {
 204     static const std::string ATTR_ID("intersection_plane");
 205     return ATTR_ID;
 206   }
 207
 208   /// Attribute name for use offset for the intersection plane.
 209   inline static const std::string& USE_OFFSET()
 210   {
 211     static const std::string ATTR_ID("use_offset");
 212     return ATTR_ID;
 213   }
 214
 215   /// Attribute name for offset for the intersection plane.
 216   inline static const std::string& OFFSET()
 217   {
 218     static const std::string ATTR_ID("offset");
 219     return ATTR_ID;
 220   }
 221
 222   /// Attribute name for reverse offset for the intersection plane.
 223   inline static const std::string& REVERSE_OFFSET()
 224   {
 225     static const std::string ATTR_ID("reverse_offset");
 226     return ATTR_ID;
 227   }
 228
 229   /// Creates a new part document if needed.
 230   CONSTRUCTIONPLUGIN_EXPORT virtual void execute();
 231
 232   /// Request for initialization of data model of the feature: adding all attributes.
 233   CONSTRUCTIONPLUGIN_EXPORT virtual void initAttributes();
 234
 235   /// Construction result is allways recomuted on the fly.
 236   CONSTRUCTIONPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
 237
 238   /// Use plugin manager for features creation
 239   ConstructionPlugin_Point();
 240
 241   /// Customize presentation of the feature
 242   virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
 243                                      std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs);
 244
 245 private:
 246   std::shared_ptr<GeomAPI_Vertex> createByXYZ();
 247   std::shared_ptr<GeomAPI_Vertex> createByDistanceOnEdge();
 248   /*std::shared_ptr<GeomAPI_Vertex> createByProjection();
 249   std::shared_ptr<GeomAPI_Vertex> createByLinesIntersection();*/
 250   std::list<std::shared_ptr<GeomAPI_Vertex> > createByLineAndPlaneIntersection();
 251
 252 };
 253
 254 #endif