X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketcherPrs%2FSketcherPrs_Tools.h;h=33254fd1804c8587cea1560cae52f16147dd5c7d;hb=ca95b8880b63f9998cb09d3ea7d91716f3ea4390;hp=a7c0925b53b194bb321b2da75b90055de369d3d4;hpb=79c2d06fc1aa7bfee1bd1ff23db8031aa9edaa6a;p=modules%2Fshaper.git diff --git a/src/SketcherPrs/SketcherPrs_Tools.h b/src/SketcherPrs/SketcherPrs_Tools.h index a7c0925b5..33254fd18 100644 --- a/src/SketcherPrs/SketcherPrs_Tools.h +++ b/src/SketcherPrs/SketcherPrs_Tools.h @@ -1,8 +1,21 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: SketcherPrs_Tools.h -// Created: 10 March 2015 -// Author: Vitaly SMETANNIKOV +// Copyright (C) 2014-2020 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 +// 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 @@ -12,33 +25,79 @@ #include #include #include +#include #include +#include +#include #include -class GeomDataAPI_Point2D; +#include +#include -//#define MyTextHeight 20 +class GeomDataAPI_Point2D; namespace SketcherPrs_Tools { + /// \enum ParameterStyle lists styles of parameter + enum ParameterStyle { + ParameterValue, ///< using symbol with the parameter value + ParameterText ///< using parameter text + }; + + /// Set dimensions parameters style + /// \param theStyle new style + SKETCHERPRS_EXPORT void setParameterStyle(ParameterStyle theStyle); + + /// Return dimensions parameters style + SKETCHERPRS_EXPORT ParameterStyle parameterStyle(); + /// Enumeration with modes for activation of selection custom presentations enum SelectionModes { /// Start of enumeration - Sel_Mode_First = 100, - + Sel_Mode_First = 100, + /// Selection mode for all constraints exclude dimensions Sel_Constraint, - + /// Selection mode for whole dimension Sel_Dimension_All, - + /// Selection mode for line of dimension Sel_Dimension_Line, - /// Selection mode foe text of dimension - Sel_Dimension_Text + /// Selection mode for text of dimension + Sel_Dimension_Text, + + /// Selectiom mode for faces selection on sketch + Sel_Sketch_Face, + + /// Selectiom mode for wires selection on sketch + Sel_Sketch_Wire + }; + + /// Type of angle + enum AngleType{ + ANGLE_DIRECT, ///< Angle from the first line to the second line + ANGLE_COMPLEMENTARY, ///< Additional angle to the angle from first to second line + ANGLE_BACKWARD ///< Angle from the second line to the first line }; + /// Type of dimension location + enum LocationType{ + LOCATION_RIGHT, ///< Position is marked by right arrow placed on the left + LOCATION_AUTOMATIC, ///< Position is marked by two arrow placed on the both sides + LOCATION_LEFT ///< Position is marked by left arrow placed on the left + }; + + /// Event ID about expression visual state has been changed, the symbol with a digit + /// or parameter text is shown + + /// Returns attribute object referenced by feature + /// \param theFeature a feature + /// \param theAttrName an attribute name + SKETCHERPRS_EXPORT AttributePtr getAttribute(ModelAPI_Feature* theFeature, + const std::string& theAttrName); + /// Returns result object referenced by feature /// \param theFeature a feature /// \param theAttrName an attribute name @@ -72,8 +131,13 @@ namespace SketcherPrs_Tools { /// \param theAttribute an attribute name /// \param thePlane a projection plane (sketcher plane) SKETCHERPRS_EXPORT std::shared_ptr getFeaturePoint(DataPtr theData, - const std::string& theAttribute, - const std::shared_ptr& thePlane); + const std::string& theAttribute, + const std::shared_ptr& thePlane); + + /// Collect all sketch points which are not connected with other entities. + /// \param theSketch sketch feature + /// \return list of results of SketchPlugin_Point features + SKETCHERPRS_EXPORT std::list getFreePoints(const CompositeFeaturePtr& theSketch); /// Returns value of dimension arrows size SKETCHERPRS_EXPORT double getArrowSize(); @@ -82,6 +146,12 @@ namespace SketcherPrs_Tools { /// \param theSize a size value SKETCHERPRS_EXPORT void setArrowSize(double theSize); + /// Returns default value of dimension arrows size + SKETCHERPRS_EXPORT int getDefaultArrowSize(); + + /// Returns value of dimension arrows size set in preferences + SKETCHERPRS_EXPORT int getConfigArrowSize(); + /// Set value of dimension text height /// \param theHeight a height value SKETCHERPRS_EXPORT void setTextHeight(double theHeight); @@ -92,6 +162,9 @@ namespace SketcherPrs_Tools { /// Returns default value of dimension text height SKETCHERPRS_EXPORT double getDefaultTextHeight(); + /// Returns value of dimension text height set in preferences + SKETCHERPRS_EXPORT double getConfigTextHeight(); + /// Get flayout distance of the dimension constraint /// \param theConstraint a dimension constraint object SKETCHERPRS_EXPORT double getFlyoutDistance(const ModelAPI_Feature* theConstraint); @@ -100,6 +173,16 @@ namespace SketcherPrs_Tools { SKETCHERPRS_EXPORT std::shared_ptr getAnchorPoint( const ModelAPI_Feature* theConstraint, const std::shared_ptr& thePlane); + + /// Throws an exception(in debug mode) and sends a signal about necessity to hide the object + /// \param theFeature a feature where AIS presentation is empty + /// \param theError a debug error information + SKETCHERPRS_EXPORT void sendEmptyPresentationError(ModelAPI_Feature* theFeature, + const std::string theError); + + SKETCHERPRS_EXPORT void setPixelRatio(int theRatio); + + SKETCHERPRS_EXPORT int pixelRatio(); }; #endif