src/PartSet/PartSet_Tools.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 PartSet_Tools_H
  22 #define PartSet_Tools_H
  23
  24 #include "PartSet.h"
  25
  26 #include <gp_Pnt.hxx>
  27
  28 #include <QPoint>
  29 #include <QList>
  30
  31 #include <ModelAPI_CompositeFeature.h>
  32 #include <ModelAPI_Object.h>
  33 #include <ModelAPI_Attribute.h>
  34
  35 #include <Events_Message.h>
  36
  37 #include <TopoDS_Shape.hxx>
  38
  39 #include <memory>
  40
  41 class V3d_View;
  42 class ModuleBase_IViewWindow;
  43 class ModuleBase_ViewerPrs;
  44 class ModuleBase_IWorkshop;
  45 class GeomDataAPI_Point2D;
  46 class GeomAPI_Shape;
  47 class GeomAPI_Pln;
  48 class GeomAPI_Pnt2d;
  49 class GeomAPI_Pnt;
  50 class GeomAPI_Edge;
  51 class GeomAPI_Vertex;
  52 class ModelAPI_Result;
  53
  54 class QMouseEvent;
  55
  56 /*!
  57  * \class PartSet_Tools
  58  * \ingroup Modules
  59  * \brief The operation for the sketch feature creation
  60  */
  61 class PARTSET_EXPORT PartSet_Tools
  62 {
  63 public:
  64   /// \enum ConstraintVisibleState types of constraints which visible state can be
  65   /// changed in the sketch widget
  66   enum ConstraintVisibleState
  67   {
  68     Geometrical = 0, // all constrains excepting dimensional
  69     Dimensional,     // lenght, distance, radius and angle constraints
  70     Expressions,     // parameter text should be shown in dimensional constraint
  71     Any              // both, geometrical and dimensional, types of constraints
  72   };
  73
  74  public:
  75   /// Returns default value of AIS presentation
  76   /// \return integer value
  77   static int getAISDefaultWidth();
  78
  79   /// Converts the 2D screen point to the 3D point on the view according to the point of view
  80   /// \param thePoint a screen point
  81   /// \param theView a 3D view
  82   static gp_Pnt convertClickToPoint(QPoint thePoint, Handle(V3d_View) theView);
  83
  84   /// \brief Converts the 3D point to the projected coodinates on the sketch plane.
  85   /// \param thePoint the 3D point in the viewer
  86   /// \param theSketch the sketch feature
  87   /// \param theView a view 3d object
  88   /// \param theX the X coordinate
  89   /// \param theY the Y coordinate
  90   static void convertTo2D(const gp_Pnt& thePoint, FeaturePtr theSketch,
  91                           Handle(V3d_View) theView,
  92                           double& theX, double& theY);
  93
  94   /// \brief Converts the 3D point to the projected coodinates on the sketch plane.
  95   /// \param theSketch the sketch feature
  96   /// \param thePnt the 3D point in the viewer
  97   /// \returns the converted point object
  98   static std::shared_ptr<GeomAPI_Pnt2d> convertTo2D(FeaturePtr theSketch,
  99                                                     const std::shared_ptr<GeomAPI_Pnt>& thePnt);
 100
 101   /// \brief Converts the 2D projected coodinates on the sketch plane to the 3D point.
 102   /// \param theX the X coordinate
 103   /// \param theY the Y coordinate
 104   /// \param theSketch the sketch feature
 105   static std::shared_ptr<GeomAPI_Pnt> convertTo3D(const double theX, const double theY,
 106                                                   FeaturePtr theSketch);
 107
 108   /// Returns pointer to the root document.
 109   static std::shared_ptr<ModelAPI_Document> document();
 110
 111   /// \brief Save the double to the feature. If the attribute is double, it is filled.
 112   /// \param theFeature the feature
 113   /// \param theX the horizontal coordinate
 114   /// \param theAttribute the feature attribute
 115   static void setFeatureValue(FeaturePtr theFeature, double theX, const std::string& theAttribute);
 116
 117   /// \brief Returns the feature double value if it is.
 118   /// \param theFeature the feature
 119   /// \param theAttribute the feature attribute
 120   /// \param isValid an output parameter whether the value is valid
 121   /// \returns the feature value
 122   static double featureValue(FeaturePtr theFeature, const std::string& theAttribute, bool& isValid);
 123
 124   /// Find a feature in the attribute of the given feature. If the kind is not empty,
 125   /// the return feature should be this type. Otherwise it is null
 126   /// \param theFeature a source feature
 127   /// \param theAttribute a name of the requried attribute attribute
 128   /// \param theKind an output feature kind
 129   /// \return the feature
 130   static FeaturePtr feature(FeaturePtr theFeature, const std::string& theAttribute,
 131                             const std::string& theKind);
 132
 133   /// Creates a constraint on two points
 134   /// \param theSketch a sketch feature
 135   /// \param thePoint1 the first point
 136   /// \param thePoint2 the second point
 137   static void createConstraint(CompositeFeaturePtr theSketch,
 138                                std::shared_ptr<GeomDataAPI_Point2D> thePoint1,
 139                                std::shared_ptr<GeomDataAPI_Point2D> thePoint2);
 140
 141   /// Create a sketch plane instance
 142   /// \param theSketch a sketch feature
 143   /// \return API object of geom plane
 144   static std::shared_ptr<GeomAPI_Pln> sketchPlane(CompositeFeaturePtr theSketch);
 145
 146   /// Create a point 3D on a basis of point 2D and sketch feature
 147   /// \param thePoint2D a point on a sketch
 148   /// \param theSketch a sketch feature
 149   /// \return API object of point 3D
 150   static std::shared_ptr<GeomAPI_Pnt> point3D(std::shared_ptr<GeomAPI_Pnt2d> thePoint2D,
 151                                                 CompositeFeaturePtr theSketch);
 152
 153   /// Finds a line (arc or circle) by given edge
 154   /// \param theShape an edge
 155   /// \param theObject a selected result object
 156   /// \param theSketch a sketch feature
 157   /// \return result of found feature or NULL
 158   static std::shared_ptr<ModelAPI_Result> findFixedObjectByExternal(
 159                                              const TopoDS_Shape& theShape,
 160                                              const ObjectPtr& theObject,
 161                                              CompositeFeaturePtr theSketch);
 162
 163   /// Creates a line (arc or circle) by given edge
 164   /// Created line will have fixed constraint
 165   /// \param theShape an edge
 166   /// \param theObject a selected result object
 167   /// \param theSketch a sketch feature
 168   /// \param theTemporary the created external object is temporary, execute is not performed for it
 169   /// \return result of created feature
 170   static std::shared_ptr<ModelAPI_Result> createFixedObjectByExternal(
 171                                                const TopoDS_Shape& theShape,
 172                                                const ObjectPtr& theObject,
 173                                                CompositeFeaturePtr theSketch,
 174                                                const bool theTemporary = false);
 175
 176     /// Checks whether the list of selected presentations contains the given one
 177   /// \param theSelected a list of presentations
 178   /// \param thePrs a presentation to be found
 179   /// \return - result of check, true if the list contains the prs
 180   static bool isContainPresentation(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theSelected,
 181                                     const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
 182
 183   /// Returns Result object if the given skietch contains external edge equal to the given
 184   /// \param theSketch - the sketch feature
 185   /// \param theEdge - the edge
 186   /// \return result object with external edge if it is found
 187   static std::shared_ptr<ModelAPI_Result> findExternalEdge(CompositeFeaturePtr theSketch,
 188                                                            std::shared_ptr<GeomAPI_Edge> theEdge);
 189
 190   /// Returns Result object if the given sketch contains external vertex equal to the given
 191   /// \param theSketch - the sketch feature
 192   /// \param theVert - the vertex
 193   /// \return result object with external vertex if it is found
 194   static std::shared_ptr<ModelAPI_Result> findExternalVertex(CompositeFeaturePtr theSketch,
 195                                                         std::shared_ptr<GeomAPI_Vertex> theVert);
 196
 197   /// Returns whether the selected presentation has a shape with the vertex type
 198   /// \param thePrs a selected presentation
 199   /// \param theSketch the sketch feature
 200   /// \param theView a 3D view
 201   /// \param theX the output horizontal coordinate of the point
 202   /// \param theY the output vertical coordinate of the point
 203   static bool hasVertexShape(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs,
 204                              FeaturePtr theSketch,
 205                              Handle(V3d_View) theView, double& theX, double& theY);
 206
 207
 208   /**
 209   * Find attribute of object which corresponds to the given shape
 210   * \param theObj - an object
 211   * \param theShape - a Shape
 212   * \param theSketch - a Sketch to get a plane of converting to 2d
 213   */
 214   static AttributePtr findAttributeBy2dPoint(ObjectPtr theObj, const TopoDS_Shape theShape,
 215                                              FeaturePtr theSketch);
 216
 217   /**
 218   * Finds an attribute value in attribute reference attribute value
 219   * \param theAttribute - an attribure reference filled with an attribute
 220   * \param theWorkshop a reference to workshop
 221   * \return a geometry shape
 222   */
 223   static std::shared_ptr<GeomAPI_Shape> findShapeBy2DPoint(const AttributePtr& theAttribute,
 224                                          ModuleBase_IWorkshop* theWorkshop);
 225
 226   /**
 227   * Returns point of coincidence feature
 228   * \param theFeature the coincidence feature
 229   * \param theAttribute the attribute name
 230   */
 231   static std::shared_ptr<GeomAPI_Pnt2d> getPoint(std::shared_ptr<ModelAPI_Feature>& theFeature,
 232                                                  const std::string& theAttribute);
 233
 234   /**
 235   * Convertes parameters into a geom point
 236   * \theEvent a Qt event to find mouse position
 237   * \param theWindow view window to define eye of view
 238   * \param theSketch to convert 3D point coordinates into coorditates of the sketch plane
 239   */
 240   static std::shared_ptr<GeomAPI_Pnt2d> getPnt2d(QMouseEvent* theEvent,
 241                                                  ModuleBase_IViewWindow* theWindow,
 242                                                  const FeaturePtr& theSketch);
 243
 244   /**
 245   * Gets all references to the feature, take coincidence constraint features, get point 2d attributes
 246   * and compare the point value to be equal with the given. Returns the first feature, which has
 247   * equal points.
 248   * \param theFeature the coincidence feature
 249   * \param thePoint a 2d point
 250   * \return the coincidence feature or null
 251   */
 252   static FeaturePtr findFirstCoincidence(const FeaturePtr& theFeature,
 253                                          std::shared_ptr<GeomAPI_Pnt2d> thePoint);
 254
 255   /**
 256   * Returns list of features connected in a councedence feature point
 257   * \param theStartCoin the coincidence feature
 258   * \param theList a list which collects lines features
 259   * \param theCoincidencies a list of coincidence features
 260   * \param theAttr the attribute name
 261   */
 262   static void findCoincidences(FeaturePtr theStartCoin, QList<FeaturePtr>& theList,
 263                                QList<FeaturePtr>& theCoincidencies,
 264                                std::string theAttr, QList<bool>& theIsAttributes);
 265
 266   /**
 267   * Returns point of a coincedence
 268   * \param theStartCoin the coincedence feature
 269   */
 270   static std::shared_ptr<GeomAPI_Pnt2d> getCoincedencePoint(FeaturePtr theStartCoin);
 271
 272   /// Sends redisplay event for all sub-features of the composite. Flush it.
 273   static void sendSubFeaturesEvent(const CompositeFeaturePtr& theComposite,
 274                                    const Events_ID theId);
 275
 276   /**
 277    * Returns true if the object is a sketch entity, where auxiliary attribute has true vlaue
 278    * \param theObject a result or feature
 279    * \return boolean result
 280    */
 281   static bool isAuxiliarySketchEntity(const ObjectPtr& theObject);
 282 };
 283
 284 #endif