X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2FSketchPlugin_Circle.h;h=ea95823d87b5bc83dd45c96287f887ee588ae560;hb=5670f4d1d8063dbd131a0b3e67f881be80a6e2be;hp=bb47c214de03db6987bb77b26d0346aa1ddbc172;hpb=6b437d84d92c29ba8c2c843735fa2feb4f0664c7;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/SketchPlugin_Circle.h b/src/SketchPlugin/SketchPlugin_Circle.h index bb47c214d..ea95823d8 100644 --- a/src/SketchPlugin/SketchPlugin_Circle.h +++ b/src/SketchPlugin/SketchPlugin_Circle.h @@ -1,66 +1,80 @@ -// File: SketchPlugin_Circle.h -// Created: 26 May 2014 -// Author: Artem ZHIDKOV +// Copyright (C) 2014-2017 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_Circle_HeaderFile -#define SketchPlugin_Circle_HeaderFile +#ifndef SketchPlugin_Circle_H_ +#define SketchPlugin_Circle_H_ #include "SketchPlugin.h" -#include +#include #include -/// Circle feature kind -const std::string SKETCH_CIRCLE_KIND("SketchCircle"); - -/// 2D point - center of the circle -const std::string CIRCLE_ATTR_CENTER("CircleCenter"); -/// Radius of the circle -const std::string CIRCLE_ATTR_RADIUS("CircleRadius"); - /**\class SketchPlugin_Circle - * \ingroup DataModel - * \brief Feature for creation of the new circle in PartSet. + * \ingroup Plugins + * \brief Feature for creation of the new circle in Sketch. */ -class SketchPlugin_Circle: public SketchPlugin_Feature +class SketchPlugin_Circle: public SketchPlugin_SketchEntity { -public: - /// Returns the kind of a feature - SKETCHPLUGIN_EXPORT virtual const std::string& getKind() - {static std::string MY_KIND = SKETCH_CIRCLE_KIND; return MY_KIND;} + public: + /// Circle feature kind + inline static const std::string& ID() + { + static const std::string ID("SketchCircle"); + return ID; + } - /// Returns to which group in the document must be added feature - SKETCHPLUGIN_EXPORT virtual const std::string& getGroup() - {static std::string MY_GROUP = SKETCH_KIND; return MY_GROUP;} - - /// Creates a new part document if needed - SKETCHPLUGIN_EXPORT virtual void execute(); + /// 2D point - center of the circle + inline static const std::string& CENTER_ID() + { + static const std::string ID("circle_center"); + return ID; + } - /// Request for initialization of data model of the feature: adding all attributes - SKETCHPLUGIN_EXPORT virtual void initAttributes(); + /// Radius of the circle + inline static const std::string& RADIUS_ID() + { + static const std::string ID("circle_radius"); + return ID; + } - /// Returns the sketch preview - SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr& preview(); - - /// Returns the AIS preview - SKETCHPLUGIN_EXPORT virtual boost::shared_ptr getAISObject( - boost::shared_ptr thePrevious); + /// Returns the kind of a feature + SKETCHPLUGIN_EXPORT virtual const std::string& getKind() + { + static std::string MY_KIND = SketchPlugin_Circle::ID(); + return MY_KIND; + } - /// Adds sub-feature of the higher level feature (sub-element of the sketch) - /// \param theFeature sub-feature - SKETCHPLUGIN_EXPORT virtual const void addSub( - const FeaturePtr& theFeature) {}; + /// Returns true is sketch element is under the rigid constraint + SKETCHPLUGIN_EXPORT virtual bool isFixed(); - /// 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 + SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID); - /// Return the distance between the feature and the point - /// \param thePoint the point - virtual double distanceToPoint(const boost::shared_ptr& thePoint); + /// Creates a new part document if needed + SKETCHPLUGIN_EXPORT virtual void execute(); /// Use plugin manager for features creation SketchPlugin_Circle(); + +protected: + /// \brief Initializes attributes of derived class. + virtual void initDerivedClassAttributes(); }; #endif