Copyright update 2022

[modules/shaper.git] / src / PartSet / PartSet_PreviewSketchPlane.h

diff --git a/src/PartSet/PartSet_PreviewSketchPlane.h b/src/PartSet/PartSet_PreviewSketchPlane.h
index b797b2dd4fbc04c13c2460aa40c8e80f31105c71..04bb84e02e355df02e27c4a0d21623376036272d 100644 (file)
--- a/src/PartSet/PartSet_PreviewSketchPlane.h
+++ b/src/PartSet/PartSet_PreviewSketchPlane.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2022  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
@@ -12,15 +12,16 @@
 //
 // 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
+// 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>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef PartSet_PreviewSketchPlane_H
 #define PartSet_PreviewSketchPlane_H
 
+#include <GeomAPI_Pnt.h>
+
 class GeomAPI_AISObject;
 class GeomAPI_Shape;
 
@@ -53,6 +54,16 @@ public:
   void createSketchPlane(const std::shared_ptr<ModelAPI_CompositeFeature>& theSketch,
                          ModuleBase_IWorkshop* theWorkshop);
 
+  /// Returns bounding box size covered the sketch sub-elements.
+  /// If the sketch uses extenal face, it will not have default size and returns false.
+  /// \param theSketch sources sketch
+  /// \param [out] theSizeOfView maximum value in X, Y or Z direction
+  /// \param theCentralPoint central point of the sketch sub features
+  /// \return boolean value
+  bool getDefaultSizeOfView(const std::shared_ptr<ModelAPI_CompositeFeature>& theSketch,
+                            double& theSizeOfView,
+                            std::shared_ptr<GeomAPI_Pnt>& theCentralPnt);
+
   /// Returns whether custom size of view is set
   /// \return boolean value
   bool isUseSizeOfView() const { return myIsUseSizeOfView; }
@@ -60,7 +71,24 @@ public:
   /// Sets the size of default created face
   /// \param theSizeOfView value
   /// \param isUseSizeOfView state whether the size should be used
-  void setSizeOfView(double theSizeOfView, bool isUseSizeOfView);
+  void setSizeOfView(double theSizeOfView, bool isUseSizeOfView,
+    const std::shared_ptr<GeomAPI_Pnt>& theCentralPoint = std::shared_ptr<GeomAPI_Pnt>());
+
+  /// Returns True if the plane preview is already created
+  bool isPlaneCreated() const {
+    return myPlane.get();
+  }
+
+  /// Returns current state of the plane preview visibility
+  bool isDisplayed() const { return myPreviewIsDisplayed; }
+
+  /// Displays preview planes
+ /// \param theWorkshop the application workshop
+  void displaySketchPlane(ModuleBase_IWorkshop* theWorkshop);
+
+  /// Nullyfies current plane preview object.
+  /// Important: Before call of this function the plane has to be erased from viewer
+  void clearPlanePreview();
 
 private:
   /// Create a square face by parameters
@@ -70,9 +98,11 @@ private:
   bool myPreviewIsDisplayed;
   std::shared_ptr<GeomAPI_AISObject> myPlane; //! visualized presentation
   std::shared_ptr<GeomAPI_Shape> myShape; //! current shape to be displayed
+  std::shared_ptr<GeomAPI_Pnt> myViewCentralPoint; //! central point of the default view
 
   double mySizeOfView; //! size that should be used by creating a default face
   bool myIsUseSizeOfView; //! state if the size is custom or from preferences
+  std::shared_ptr<GeomAPI_Pnt> myViewOrigin; //! origin point of sketch if default view is used
 };
 
 #endif
\ No newline at end of file