X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2FSketchPlugin_ConstraintDistance.h;h=4295e8c2dee1d9dba731c92d9d00c33a5276d342;hb=587c5c1821f464e323eec057ba860b2433d4f412;hp=48b59e1ed02b442988f7dc1acc836c7804d23455;hpb=507f658f34fc6c42f48fb83a8fa916c6f0e33fd3;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/SketchPlugin_ConstraintDistance.h b/src/SketchPlugin/SketchPlugin_ConstraintDistance.h index 48b59e1ed..4295e8c2d 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintDistance.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintDistance.h @@ -1,5 +1,5 @@ // File: SketchPlugin_ConstraintDistance.h -// Created: 08 May 2014 +// Created: 23 May 2014 // Author: Artem ZHIDKOV #ifndef SketchPlugin_ConstraintDistance_HeaderFile @@ -9,28 +9,14 @@ #include "SketchPlugin_Constraint.h" #include -/// The distance value -const std::string CONSTRAINT_ATTR_DISTANCE(CONSTRAINT_ATTR_VALUE); - /** \class SketchPlugin_ConstraintDistance * \ingroup DataModel - * \brief Feature for creation of a new constraint which fixes the distance - * between two other features. - * - * 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". + * \brief Feature for creation of a new constraint which defines a distance + * between a point and another feature (point, line, plane or face) * - * 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 + * These constraint has three attributes: + * CONSTRAINT_ATTR_VALUE, CONSTRAINT_ATTR_ENTITY_A and CONSTRAINT_ATTR_ENTITY_B */ class SketchPlugin_ConstraintDistance: public SketchPlugin_Constraint { @@ -46,87 +32,14 @@ public: /// \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 */ } + /// \brief Request for initialization of data model of the feature: adding all attributes + SKETCHPLUGIN_EXPORT virtual void initAttributes(); - /// \brief Use plugin manager for features creation - SKETCHPLUGIN_EXPORT SketchPlugin_ConstraintDistance(); + /// \brief Returns the sketch preview + SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr& preview(); - /** \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); - -private: - /** \brief Returns the list of attributes for the certain type of constraint. - * \return names of attributes - */ - const std::list& getAttributesList() const - { return myAttrList; } - -private: - std::list myAttrList; ///< List of attributes for current constraint + /// \brief Use plugin manager for features creation + SketchPlugin_ConstraintDistance(); }; #endif