SketchPlugin_Tools.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 SKETCHPLUGIN_TOOLS_H_
#define SKETCHPLUGIN_TOOLS_H_
 
#include <GeomAPI_Pnt2d.h>
 
#include <ModelAPI_Feature.h>
#include <ModelAPI_Attribute.h>
#include <ModelAPI_AttributeRefAttr.h>
#include <GeomAPI_Shape.h>
#include <GeomAPI_AISObject.h>
#include <GeomDataAPI_Point2D.h>
#include <GeomDataAPI_Point2DArray.h>
#include <GeomAlgoAPI_ShapeTools.h>
 
#include <list>
#include <map>
 
class GeomAPI_AISObject;
 
class SketchPlugin_Constraint;
class SketchPlugin_Feature;
class SketchPlugin_Sketch;
 
namespace SketchPlugin_Tools {
 
void clearExpressions(FeaturePtr theFeature);
 
std::shared_ptr<GeomAPI_Pnt2d> getCoincidencePoint(const FeaturePtr theStartCoin);
 
std::set<FeaturePtr> findCoincidentConstraints(const ObjectPtr& theObject);
 
void findCoincidences(const FeaturePtr theStartCoin,
                      const std::string& theAttr,
                      std::set<FeaturePtr>& theList,
                      const bool theIsAttrOnly = false);
 
std::set<FeaturePtr> findFeaturesCoincidentToPoint(const AttributePoint2DPtr& thePoint);
 
std::set<AttributePoint2DPtr> findPointsCoincidentToPoint(const AttributePoint2DPtr& thePoint);
 
void resetAttribute(SketchPlugin_Feature* theFeature, const std::string& theId);
 
FeaturePtr createConstraintAttrAttr(SketchPlugin_Sketch* theSketch,
                                    const std::string& theConstraintId,
                                    const AttributePtr& theFirstAttribute,
                                    const AttributePtr& theSecondAttribute);
 
FeaturePtr createConstraintAttrObject(SketchPlugin_Sketch* theSketch,
                                      const std::string& theConstraintId,
                                      const AttributePtr& theFirstAttribute,
                                      const ObjectPtr& theSecondObject);
 
FeaturePtr createConstraintObjectObject(SketchPlugin_Sketch* theSketch,
                                        const std::string& theConstraintId,
                                        const ObjectPtr& theFirstObject,
                                        const ObjectPtr& theSecondObject);
 
void createCoincidenceOrTangency(SketchPlugin_Feature* theFeature,
                                 const std::string& theId,
                                 const AttributePtr theAttr,
                                 const ObjectPtr theObject,
                                 const bool theIsCanBeTangent);
 
void createAuxiliaryPointOnEllipse(const FeaturePtr& theEllipseFeature,
                                   const std::string& theAttrName);
 
void createAuxiliaryAxisOfEllipse(const FeaturePtr& theEllipseFeature,
                                  const std::string& theStartAttr,
                                  const std::string& theEndAttr);
 
void convertRefAttrToPointOrTangentCurve(const AttributeRefAttrPtr&      theRefAttr,
                                         const AttributePtr&             theDefaultAttr,
                                         std::shared_ptr<GeomAPI_Shape>& theTangentCurve,
                                         std::shared_ptr<GeomAPI_Pnt2d>& thePassingPoint);
 
GeomPnt2dPtr flyoutPointCoordinates(const std::shared_ptr<SketchPlugin_Constraint>& theConstraint);
 
void customizeFeaturePrs(const AISObjectPtr& thePrs, bool isAxiliary);
 
void setDimensionColor(const AISObjectPtr& theDimPrs);
 
void replaceInName(ObjectPtr theObject, const std::wstring& theSource, const std::wstring& theDest);
 
}; // namespace SketchPlugin_Tools
 
namespace SketchPlugin_SegmentationTools
{
  void getFeaturePoints(const FeaturePtr& theFeature,
                        std::shared_ptr<GeomDataAPI_Point2D>& theStartPointAttr,
                        std::shared_ptr<GeomDataAPI_Point2D>& theEndPointAttr);
 
  void getRefAttributes(const FeaturePtr& theFeature,
                        std::map<AttributePtr, std::list<AttributePtr> >& theRefs,
                        std::list<AttributePtr>& theRefsToFeature);
 
  GeomShapePtr getSubShape(
      SketchPlugin_Feature* theFeature,
      const std::string& theObjectAttributeId,
      const std::string& thePointAttributeId,
      std::map<ObjectPtr, std::set<GeomShapePtr> >& theCashedShapes,
      std::map<ObjectPtr, GeomAlgoAPI_ShapeTools::PointToRefsMap>& theObjectToPoints);
 
  void fillObjectShapes(
      SketchPlugin_Feature* theOpFeature,
      const ObjectPtr& theObject,
      std::map<ObjectPtr, std::set<GeomShapePtr> >& theCashedShapes,
      std::map<ObjectPtr, GeomAlgoAPI_ShapeTools::PointToRefsMap>& theObjectToPoints);
 
  std::shared_ptr<GeomAPI_AISObject> getAISObject(std::shared_ptr<GeomAPI_AISObject> thePrevious,
                                                  SketchPlugin_Feature* theOpFeature,
                                                  const std::string& thePreviewObjectAttrName,
                                                  const std::string& thePreviewPointAttrName,
                                                  const std::string& theSelectedObjectAttrName,
                                                  const std::string& theSelectedPointAttrName);
 
  void updateRefAttConstraints(
      const std::map<AttributePtr, std::list<AttributePtr> >& theBaseRefAttributes,
      const std::set<std::pair<AttributePtr, AttributePtr> >& theModifiedAttributes);
 
  void updateFeaturesAfterOperation(const std::set<FeaturePtr>& theFeaturesToUpdate);
 
 
  FeaturePtr createLineFeature(const FeaturePtr& theBaseFeature,
                               const std::shared_ptr<GeomAPI_Pnt2d>& theFirstPoint,
                               const std::shared_ptr<GeomAPI_Pnt2d>& theSecondPoint);
 
  FeaturePtr createArcFeature(
      const FeaturePtr& theBaseFeature,
      const std::shared_ptr<GeomAPI_Pnt2d>& theFirstPoint,
      const std::shared_ptr<GeomAPI_Pnt2d>& theSecondPoint);
 
}; // namespace SketchPlugin_SegmentationTools
 
#endif // SKETCHPLUGIN_TOOLS_H_