Salome HOME
Issue #2215: Wrong cut result between a compsolid and a box
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Sketch.h
index 3246a2ad728721f27e3024645f43dc7ee9095cdd..6b76be658885f82508f481432db62c861d8417fc 100644 (file)
@@ -1,8 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        SketchPlugin_Sketch.h
-// Created:     27 Mar 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef SketchPlugin_Sketch_H_
 #define SketchPlugin_Sketch_H_
 #include <GeomDataAPI_Dir.h>
 #include <list>
 
-#define YZ_PLANE_COLOR "225,0,0"
-#define XZ_PLANE_COLOR "0,225,0"
-#define XY_PLANE_COLOR "0,0,225"
+#ifdef SET_PLANES_COLOR_IN_PREFERENCES
+  #define YZ_PLANE_COLOR "225,0,0"
+  #define XZ_PLANE_COLOR "0,225,0"
+  #define XY_PLANE_COLOR "0,0,225"
+#endif
 
 /**\class SketchPlugin_Sketch
  * \ingroup Plugins
  * \brief Feature for creation of the new part in PartSet.
  */
-class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICustomPrs//, public GeomAPI_IPresentable
+class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICustomPrs
 {
  public:
   /// Sketch feature kind
@@ -68,6 +84,13 @@ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICu
     return MY_SOLVER_ERROR;
   }
 
+  /// Sketch solver error
+  inline static const std::string& SOLVER_DOF()
+  {
+    static const std::string MY_SOLVER_DOF("SolverDOF");
+    return MY_SOLVER_DOF;
+  }
+
   /// Returns the kind of a feature
   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
   {
@@ -106,7 +129,7 @@ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICu
 
     return std::shared_ptr<GeomAPI_Pnt>(new GeomAPI_Pnt(aSum));
   }
-  
+
   /// Returns the point projected into the sketch plane
   /// \param thePnt a source 3d point
   std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& thePnt) const
@@ -169,9 +192,6 @@ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICu
   }
 
 
-  /// removes also all sub-sketch elements
-  SKETCHPLUGIN_EXPORT virtual void erase();
-
   /// appends a feature to the sketch sub-elements container
   SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
 
@@ -182,7 +202,7 @@ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICu
   SKETCHPLUGIN_EXPORT virtual int numberOfSubs(bool forTree = false) const;
 
   /// Returns the sub-feature by zero-base index
-  SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> 
+  SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
     subFeature(const int theIndex, bool forTree = false);
 
   /// Returns the sub-feature unique identifier in this composite feature by index
@@ -196,19 +216,29 @@ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICu
 
   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 
+  /// Exchanges IDs of two given features: needed for fillet feature better naming (issue 769)
+  SKETCHPLUGIN_EXPORT virtual void exchangeIDs(std::shared_ptr<ModelAPI_Feature> theFeature1,
+    std::shared_ptr<ModelAPI_Feature> theFeature2);
+
+
   /// \brief Create a result for the point in the attribute if the attribute is initialized
+  /// \param theFeature a source feature
+  /// \param theSketch a sketch intance
   /// \param theAttributeID an attribute string
   /// \param theIndex an index of the result
   static void createPoint2DResult(ModelAPI_Feature* theFeature,
                                   SketchPlugin_Sketch* theSketch,
                                   const std::string& theAttributeID, const int theIndex);
-  
+
   /// Add new feature and fill the data of the feature by the data of the parameter feature.
   /// The name of the created feature stays unique.
   /// \param theFeature a source feature
+  /// \param theSketch a sketch intance
+  /// \param theIsCopy if true sets feature copy attribute to true.
   /// \return a created feature
-  static FeaturePtr addUniqueNamedCopiedFeature(FeaturePtr aFeature,
-                                                SketchPlugin_Sketch* theSketch);
+  static FeaturePtr addUniqueNamedCopiedFeature(FeaturePtr theFeature,
+                                                SketchPlugin_Sketch* theSketch,
+                                                const bool theIsCopy = false);
 
   /// Creates a plane of the sketch.
   /// \param theSketch a sketch intance
@@ -222,9 +252,9 @@ class SketchPlugin_Sketch : public ModelAPI_CompositeFeature, public GeomAPI_ICu
     // apply the color of the result to the presentation
     if (theDefaultPrs.get())
       isCustomized = theDefaultPrs->customisePresentation(theResult, thePrs, theDefaultPrs);
-    // set the sketch presentation bold    
+    // set the sketch presentation bold
     isCustomized = thePrs->setWidth(2) || isCustomized;
-  
+
     return isCustomized;
   }