src/PartSet/PartSet_PreviewSketchPlane.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_PreviewSketchPlane_H
  22 #define PartSet_PreviewSketchPlane_H
  23
  24 class GeomAPI_AISObject;
  25 class GeomAPI_Shape;
  26
  27 class ModuleBase_IWorkshop;
  28 class ModelAPI_CompositeFeature;
  29
  30 #include <memory>
  31
  32 /**
  33 * \class PartSet_PreviewSketchPlane
  34 * \ingroup Modules
  35 * A class to show/hide sketch preview plane
  36 */
  37 class PartSet_PreviewSketchPlane
  38 {
  39 public:
  40   /// Constructor
  41   PartSet_PreviewSketchPlane();
  42
  43   ~PartSet_PreviewSketchPlane() {};
  44
  45   /// Erase preview planes
  46   /// \param theWorkshop the application workshop
  47   /// \param isClearPlane flag whether the plane, origin and normal should be nullified
  48   void eraseSketchPlane(ModuleBase_IWorkshop* theWorkshop, const bool isClearPlane = true);
  49
  50   /// Show preview planes
  51   /// \param theSketch source sketch to initialize plane
  52   /// \param theWorkshop the application workshop
  53   void createSketchPlane(const std::shared_ptr<ModelAPI_CompositeFeature>& theSketch,
  54                          ModuleBase_IWorkshop* theWorkshop);
  55
  56 private:
  57   /// Create a square face by parameters
  58   std::shared_ptr<GeomAPI_AISObject> createPreviewPlane();
  59
  60 private:
  61   bool myPreviewIsDisplayed;
  62   std::shared_ptr<GeomAPI_AISObject> myPlane; //! visualized presentation
  63   std::shared_ptr<GeomAPI_Shape> myShape; //! current shape to be displayed
  64 };
  65
  66 #endif