X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2FSketchPlugin_ConstraintLength.h;h=4ca396e6b8f12c7088bfefce426ae6b0f008c99a;hb=5a5362530345c00af26fc8226f3066f749dde392;hp=52d26854a00b908148891ce73d3811ef219d96a7;hpb=300f40cc0945ce614f9c0af668ac2b3094ec0524;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/SketchPlugin_ConstraintLength.h b/src/SketchPlugin/SketchPlugin_ConstraintLength.h index 52d26854a..4ca396e6b 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintLength.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintLength.h @@ -1,55 +1,107 @@ -// File: SketchPlugin_ConstraintLength.h -// Created: 30 May 2014 -// Author: Artem ZHIDKOV +// 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 +// 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_ConstraintLength_H_ #define SketchPlugin_ConstraintLength_H_ #include "SketchPlugin.h" -#include "SketchPlugin_Constraint.h" -#include +#include "SketchPlugin_ConstraintBase.h" +#include "SketchPlugin_Sketch.h" + +#include + #include -#define LENGTH_COLOR "255, 0, 255" +class GeomAPI_Pnt2d; +class GeomDataAPI_Point2D; /** \class SketchPlugin_ConstraintLength - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of a new constraint which defines a length of a line segment * - * These constraint has two attributes: + * This constraint has two attributes: * SketchPlugin_Constraint::VALUE() (length) and SketchPlugin_Constraint::ENTITY_A() (segment), * SketchPlugin_Constraint::FLYOUT_VALUE_PNT() (distance of a constraints handle) */ -class SketchPlugin_ConstraintLength: public SketchPlugin_Constraint +class SketchPlugin_ConstraintLength : public SketchPlugin_ConstraintBase { -public: + public: /// Length constraint kind inline static const std::string& ID() { static const std::string MY_CONSTRAINT_LENGTH_ID("SketchConstraintLength"); return MY_CONSTRAINT_LENGTH_ID; } + /// \brief Returns the kind of a feature - SKETCHPLUGIN_EXPORT virtual const std::string& getKind() - {static std::string MY_KIND = SketchPlugin_ConstraintLength::ID(); return MY_KIND;} + SKETCHPLUGIN_EXPORT virtual const std::string& getKind() + { + static std::string MY_KIND = SketchPlugin_ConstraintLength::ID(); + return MY_KIND; + } + + /// attribute name of dimension location type + inline static const std::string& LOCATION_TYPE_ID() + { + static const std::string MY_LOCATION_TYPE_ID("LocationType"); + return MY_LOCATION_TYPE_ID; + } /// \brief Creates a new part document if needed SKETCHPLUGIN_EXPORT virtual void execute(); + /// Computes the attribute value on the base of other attributes if the value can be computed + /// \param theAttributeId an attribute index to be computed + /// \return a boolean value about it is computed + SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId); + /// \brief Request for initialization of data model of the feature: adding all attributes SKETCHPLUGIN_EXPORT virtual void initAttributes(); + /// Retuns the parameters of color definition in the resources config manager + SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName, + std::string& theDefault); + /// Returns the AIS preview - SKETCHPLUGIN_EXPORT virtual boost::shared_ptr getAISObject( - boost::shared_ptr thePrevious); + SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious); - /// Moves the feature - /// \param theDeltaX the delta for X coordinate is moved - /// \param theDeltaY the delta for Y coordinate is moved - SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY); + /// Called on change of any argument-attribute of this object + /// \param theID identifier of changed attribute + SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID); /// \brief Use plugin manager for features creation SketchPlugin_ConstraintLength(); + + /// Computes distance between lenght point attributes + /// \param theValue [out] distance or 0 if one of point attributes is not initialized + /// \return boolean value if distance is computed + bool computeLenghtValue(double& theValue); + +private: + /// retrns the points-base of length, returns false if it is not possible + bool getPoints( + std::shared_ptr& thePoint1, std::shared_ptr& thePoint2, + std::shared_ptr& theStartPoint, + std::shared_ptr& theEndPoint); + +private: + bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point }; #endif