PartSet_PreviewSketchPlane.h

// Copyright (C) 2014-2026  CEA, EDF
//
// 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
//
 
#ifndef PartSet_PreviewSketchPlane_H
#define PartSet_PreviewSketchPlane_H
 
#include <memory>
#include <utility>
#include <Standard_Handle.hxx>
#include <Aspect_GridType.hxx>
#include <Aspect_GridDrawMode.hxx>
#include <ModelAPI_CompositeFeature.h>
#include <gp_Ax3.hxx>
 
#include "PartSet_Tools.h"
 
class PartSet_SketcherMgr;
class ModelAPI_CompositeFeature;
class GeomAPI_AISObject;
class GeomAPI_Face;
class AIS_PlaneTrihedron;
class V3d_Viewer;
class QString;
class gp_Trsf;
 
// #define SKETCH_ACCESSORY_DBG;
 
class PartSet_PreviewSketchPlane
{
public:
  inline static bool SketchAccessoryDbg()
  {
#ifdef SKETCH_ACCESSORY_DBG
    return true;
#else
  return false;
#endif
  };
 
  static bool SketchAccessoryDbg(const QString& theString);
  static bool SketchAccessoryDbg(const char* theString);
  static bool SketchAccessoryDbg(const char* theCSDescription, const gp_Ax3& theCS);
  static bool SketchAccessoryDbg(const char* theCSDescription, const gp_Pnt& thePoint);
  static bool SketchAccessoryDbg(const char* theCSDescription, const gp_Trsf& theMatrix);
 
  enum GridSnappingMode {
    Off,
    SnapAnyway,
    SnapInProximity
  };
 
  PartSet_PreviewSketchPlane(PartSet_SketcherMgr* theManager);
  PartSet_PreviewSketchPlane(const PartSet_PreviewSketchPlane&) = delete;
  PartSet_PreviewSketchPlane& operator=(const PartSet_PreviewSketchPlane&) = delete;
  ~PartSet_PreviewSketchPlane() = default;
 
  void savePreferencesIntoSketchData(std::shared_ptr<ModelAPI_CompositeFeature> theSketch) const;
  void saveRectangularGridPreferencesIntoSketchData(std::shared_ptr<ModelAPI_CompositeFeature> theSketch) const;
  void saveCircularGridPreferencesIntoSketchData(std::shared_ptr<ModelAPI_CompositeFeature> theSketch) const;
 
  void setCSAndSize(const gp_Ax3& theCS, double theSize);
 
  bool setAllUsingSketch(std::shared_ptr<ModelAPI_CompositeFeature> theSketch);
 
  bool reconfigureGrid();
 
  bool reconfigureGridUsingSketch(std::shared_ptr<ModelAPI_CompositeFeature> theSketch);
 
  bool showAxes(bool theShow);
  bool showSubstrate(bool theShow);
  bool setGridType(PartSet_Tools::SketchPlaneGridType::Enum theType);
 
  PartSet_Tools::SketchPlaneGridType::Enum getGridType() const { return myGridType; }
 
  void hideAll();
 
  std::pair<double, double> getDimensions() const;
 
  bool isShowAxes() const { return myShowTrihedron; }
  bool isShowSubstrate() const { return myShowSubstrate; }
  bool isShowGrid() const { return myGridType != PartSet_Tools::SketchPlaneGridType::No; }
 
  GridSnappingMode getGridSnappingMode() const { return mySnappingMode; };
  void setGridSnappingMode(GridSnappingMode theMode) { mySnappingMode = theMode; };
 
  void resetRectangularGrid();
 
  void setRectangularGridStepX(double theStepX);
  void setRectangularGridStepY(double theStepY);
  std::pair<double, double> getRectangularGridSteps() const { return myRectangularGridSteps; }
 
  void setRectangularGridOffsetX(double theOffsetX);
  void setRectangularGridOffsetY(double theOffsetY);
  void setRectangularGridOffsetA(double theOffsetAngle);
  std::pair<std::pair<double, double>, double> getRectangularGridOffsets() const;
  int getRectangularGridDimOfNodeSpace() const { return myRectangularGridDimOfNodeSpace; }
 
  void resetCircularGrid();
 
  void setCircularGridRadialStep(double theStep);
  void setCircularGridNumOfAngularSegments(int theNum);
  std::pair<double, int> getCircularGrid_dR_and_NAS() const;
 
  void setCircularGridOffsetX(double theOffset);
  void setCircularGridOffsetY(double theOffset);
  void setCircularGridOffsetA(double theOffset);
  std::pair<std::pair<double, double>, double> getCircularGridOffsets() const;
  int getCircularGridDimOfNodeSpace() const { return myCircularGridDimOfNodeSpace; }
 
  void setUseSizeOfView(const bool isUseSizeOfView) { myIsUseSizeOfView = isUseSizeOfView; }
  bool isUseSizeOfView() const { return myIsUseSizeOfView; }
 
private:
  void configureTrihedron();
  void initSubstrate(std::shared_ptr<GeomAPI_Face> theFace);
 
  opencascade::handle<V3d_Viewer> getV3DViewer() const;
  bool isValid() const;
  void setInvalid();
 
  double getDefaultSize() const;
 
  double getCircularGridRaduis(const std::pair<double, double>& theBBox2Dimensions) const;
 
  static std::pair<double, double> dimsOfRectangleFittingRectangle(double wInner, double hInner, double angle, double cX, double cY);
 
public:
  static double defaultSketchSize();
 
  static const double DEFAULT_RELATIVE_STEP_INVERSE;
  static const int DEFAULT_NUM_OF_ANGULAR_SECTIONS;
  static const int SNAP_PROXIMITY_P; 
 
private:
  static const double DEFAULT_SKETCH_SIZE;
 
  const PartSet_SketcherMgr* const mySketcherMgr;
 
  bool myValid;
  gp_Ax3 mySketchCS;
  std::pair<double, double> mySketchDimensions; // Width and height of sketch bounding box, aligned with sketch axes.
  double mySketchDefaultSize;
  bool myIsUseSizeOfView = false; 
 
  bool myShowTrihedron;
  opencascade::handle<AIS_PlaneTrihedron> myTrihedron; // Visualization of sketch axes and origin.
 
  bool myShowSubstrate;
  std::shared_ptr<GeomAPI_AISObject> mySubstrate; // Translucent substrate.
 
  PartSet_Tools::SketchPlaneGridType::Enum myGridType;
  Aspect_GridDrawMode myGridDrawMode;
  GridSnappingMode mySnappingMode;
 
  std::pair<double, double> myRectangularGridSteps;
  std::pair<double, double> myRectangularGridTransOffset;
  double myRectangularGridOffsetAngle;
  int myRectangularGridDimOfNodeSpace; // Minimal dimension of space which can fit displayed grid nodes.
 
  double myCircularGridRadialStep;
  int    myCircularGridNumOfAngularSections;
  std::pair<double, double> myCircularGridTransOffset;
  double myCircularGridOffsetAngle;
  int myCircularGridDimOfNodeSpace; // Minimal dimension of space which can fit displayed grid nodes.
};
 
#endif