X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2FSketchPlugin_ConstraintDistance.h;h=cbd6ccf37f6ac2a5773f443744972c64149720ad;hb=df51e63f5d87b0c8fa46f5cda0c7c92aad5da888;hp=48b59e1ed02b442988f7dc1acc836c7804d23455;hpb=507f658f34fc6c42f48fb83a8fa916c6f0e33fd3;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/SketchPlugin_ConstraintDistance.h b/src/SketchPlugin/SketchPlugin_ConstraintDistance.h index 48b59e1ed..cbd6ccf37 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintDistance.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintDistance.h @@ -1,132 +1,81 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D --> + // File: SketchPlugin_ConstraintDistance.h -// Created: 08 May 2014 +// Created: 23 May 2014 // Author: Artem ZHIDKOV -#ifndef SketchPlugin_ConstraintDistance_HeaderFile -#define SketchPlugin_ConstraintDistance_HeaderFile +#ifndef SketchPlugin_ConstraintDistance_H_ +#define SketchPlugin_ConstraintDistance_H_ #include "SketchPlugin.h" -#include "SketchPlugin_Constraint.h" -#include +#include "SketchPlugin_ConstraintBase.h" +#include "SketchPlugin_Sketch.h" +#include "ModelAPI_Data.h" -/// The distance value -const std::string CONSTRAINT_ATTR_DISTANCE(CONSTRAINT_ATTR_VALUE); +#include + +#include +class SketchPlugin_Line; +class GeomDataAPI_Point2D; /** \class SketchPlugin_ConstraintDistance - * \ingroup DataModel - * \brief Feature for creation of a new constraint which fixes the distance - * between two other features. + * \ingroup Plugins + * \brief Feature for creation of a new constraint which defines a distance + * between a point and another feature (point, line, plane or face) * - * There are allowed several kinds of distances: - * \li The next constraints use "valA", "ptA" and "entityA" parameters: - * point-point, point-line, point-plane, point-face; - * \li The distance between two points projected on a line (or vector) - * uses "valA", "ptA", "ptB", "entityA"; - * \li The diameter of a circle is defined by "valA" and "entityA"; - * \li The angle between two lines (or vectors) uses "valA", "entityA", "entityB". - * - * The default list of attributes contains only CONSTRAINT_ATTR_DISTANCE. - * - * \remark As far as the constraint may have different attributes, - * it is strongly recommended to use setAttibutes() methods - * instead of direct intialization of the attributes + * This constraint has three attributes: + * SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B() */ -class SketchPlugin_ConstraintDistance: public SketchPlugin_Constraint +class SketchPlugin_ConstraintDistance : public SketchPlugin_ConstraintBase { -public: - /// \brief Returns the kind of a feature - SKETCHPLUGIN_EXPORT virtual const std::string& getKind() - {static std::string MY_KIND = "SketchConstraintDistance"; return MY_KIND;} + public: + /// Distance constraint kind + inline static const std::string& ID() + { + static const std::string MY_CONSTRAINT_DISTANCE_ID("SketchConstraintDistance"); + return MY_CONSTRAINT_DISTANCE_ID; + } - /// \brief Returns to which group in the document must be added feature - SKETCHPLUGIN_EXPORT virtual const std::string& getGroup() - {static std::string MY_GROUP = "Sketch"; return MY_GROUP;} + /// \brief Returns the kind of a feature + SKETCHPLUGIN_EXPORT virtual const std::string& getKind() + { + static std::string MY_KIND = SketchPlugin_ConstraintDistance::ID(); + return MY_KIND; + } /// \brief Creates a new part document if needed SKETCHPLUGIN_EXPORT virtual void execute(); - /** \brief Request for initialization of data model of the feature: adding all attributes - * - * The setAttributes() methods should be used instead. - */ - SKETCHPLUGIN_EXPORT virtual void initAttributes() - { /* do nothing */ } + /// 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(); + + /// Returns the AIS preview + 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_EXPORT SketchPlugin_ConstraintDistance(); - - /** \brief Initializes the attributes of the constraint - * - * Defines the distance between a point and another entity, - * or defines the angle between two vectors. - * - * \param[in] theDistance distance (or angle) between two entities - * \param[in] theEntityA first parameter of the constraint - * \param[in] theEntityB second parameter of the constraint - */ - SKETCHPLUGIN_EXPORT void setAttributes( - const double theDistance, - const boost::shared_ptr theEntityA, - const boost::shared_ptr theEntityB); - /** \brief Initializes the attributes of the constraint - * - * Defines the distance between a point defined by reference and another entity. - * - * \param[in] theDistance distance between the point and other entity - * \param[in] thePoint reference to the point attribute - * \param[in] theEntity other parameter of the constraint - */ - SKETCHPLUGIN_EXPORT void setAttributes( - const double theDistance, - const boost::shared_ptr thePoint, - const boost::shared_ptr theEntity); - /** \brief Initializes the attributes of the constraint - * - * Defines the distance between two points which defined by references. - * - * \param[in] theDistance distance between the points - * \param[in] thePointA reference to the first point attribute - * \param[in] thePointB reference to the second point attribute - */ - SKETCHPLUGIN_EXPORT void setAttributes( - const double theDistance, - const boost::shared_ptr thePointA, - const boost::shared_ptr thePointB); - /** \brief Initializes the attributes of the constraint - * - * Defines radius of a circle. - * - * \param[in] theRadius radius of the circle - * \param[in] theCircle the circle which has specified radius - */ - SKETCHPLUGIN_EXPORT void setAttributes( - const double theRadius, - const boost::shared_ptr theCircle); - /** \brief Initializes the attributes of the constraint - * - * Defines the distance between two points projected on specified vector (or line). - * - * \param[in] theDistance distance between projected points - * \param[in] thePointA first point for the projection - * \param[in] thePointB second point for the projection - * \param[in] theEntity direction of the line which the points projected on - */ - SKETCHPLUGIN_EXPORT void setAttributes( - const double theDistance, - const boost::shared_ptr thePointA, - const boost::shared_ptr thePointB, - const boost::shared_ptr theEntity); + SketchPlugin_ConstraintDistance(); -private: - /** \brief Returns the list of attributes for the certain type of constraint. - * \return names of attributes - */ - const std::list& getAttributesList() const - { return myAttrList; } +protected: + /// Returns the current distance between the feature attributes + double calculateCurrentDistance(); private: - std::list myAttrList; ///< List of attributes for current constraint + bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point }; #endif