SketcherPrs_Tools.h

// Copyright (C) 2014-2025  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 SketcherPrs_Tools_H
#define SketcherPrs_Tools_H
 
#include "SketcherPrs.h"
#include <GeomAPI_Shape.h>
#include <GeomAPI_Pnt2d.h>
#include <GeomAPI_Ax3.h>
#include <ModelAPI_Object.h>
#include <ModelAPI_Attribute.h>
#include <ModelAPI_Feature.h>
#include <ModelAPI_CompositeFeature.h>
#include <ModelAPI_Result.h>
#include <string>
 
#include <Events_Loop.h>
#include <Events_Message.h>
 
class GeomDataAPI_Point2D;
 
namespace SketcherPrs_Tools {
 
  enum ParameterStyle {
    ParameterValue, 
    ParameterText 
  };
 
  SKETCHERPRS_EXPORT void setParameterStyle(ParameterStyle theStyle);
 
  SKETCHERPRS_EXPORT ParameterStyle parameterStyle();
 
  enum SelectionModes {
    Sel_Mode_First = 100,
 
    Sel_Constraint,
 
    Sel_Dimension_All,
 
    Sel_Dimension_Line,
 
    Sel_Dimension_Text,
 
    Sel_Sketch_Face,
 
    Sel_Sketch_Wire
  };
 
  enum AngleType{
    ANGLE_DIRECT,   
    ANGLE_COMPLEMENTARY,  
    ANGLE_BACKWARD 
  };
 
  enum LocationType{
    LOCATION_RIGHT,   
    LOCATION_AUTOMATIC,  
    LOCATION_LEFT 
  };
 
 
  SKETCHERPRS_EXPORT AttributePtr getAttribute(ModelAPI_Feature* theFeature,
                                               const std::string& theAttrName);
 
  SKETCHERPRS_EXPORT ObjectPtr getResult(ModelAPI_Feature* theFeature,
                                         const std::string& theAttrName);
 
  SKETCHERPRS_EXPORT std::shared_ptr<GeomAPI_Shape> getShape(ObjectPtr theObject);
 
 
  SKETCHERPRS_EXPORT std::shared_ptr<GeomAPI_Pnt2d> getPoint(ModelAPI_Feature* theFeature,
                                          const std::string& theAttrName);
 
 
  SKETCHERPRS_EXPORT std::shared_ptr<GeomAPI_Pnt2d> getProjectionPoint(
                        const FeaturePtr theLine,
                        const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
 
  SKETCHERPRS_EXPORT FeaturePtr getFeatureLine(DataPtr theData,
                                               const std::string& theAttribute);
 
  SKETCHERPRS_EXPORT std::shared_ptr<GeomDataAPI_Point2D> getFeaturePoint(DataPtr theData,
                                               const std::string& theAttribute,
                                               const std::shared_ptr<GeomAPI_Ax3>& thePlane);
 
  SKETCHERPRS_EXPORT std::list<ResultPtr> getFreePoints(const CompositeFeaturePtr& theSketch);
 
  SKETCHERPRS_EXPORT double getArrowSize();
 
  SKETCHERPRS_EXPORT void setArrowSize(double theSize);
 
  SKETCHERPRS_EXPORT int getDefaultArrowSize();
 
  SKETCHERPRS_EXPORT int getConfigArrowSize();
 
  SKETCHERPRS_EXPORT void setTextHeight(double theHeight);
 
  SKETCHERPRS_EXPORT double getTextHeight();
 
  SKETCHERPRS_EXPORT double getDefaultTextHeight();
 
  SKETCHERPRS_EXPORT double getConfigTextHeight();
 
  SKETCHERPRS_EXPORT double getFlyoutDistance(const ModelAPI_Feature* theConstraint);
 
  SKETCHERPRS_EXPORT std::shared_ptr<GeomAPI_Pnt> getAnchorPoint(
                                              const ModelAPI_Feature* theConstraint,
                                              const std::shared_ptr<GeomAPI_Ax3>& thePlane);
 
  SKETCHERPRS_EXPORT void sendEmptyPresentationError(ModelAPI_Feature* theFeature,
                                                     const std::string theError);
 
  SKETCHERPRS_EXPORT void setPixelRatio(const double theRatio);
 
  SKETCHERPRS_EXPORT double pixelRatio();
};
 
#endif