X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2FSketchPlugin_Arc.h;h=47a9f9dd45d2d089d1f2c469478ba1631d2b1b17;hb=8d8878b385494638fbe5fad10bbcdee9c9d04f30;hp=3286cff4218506c53690ae23699c9022221cb905;hpb=e884d8b11e3cde0d41d80bb39e3108f4725c3917;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/SketchPlugin_Arc.h b/src/SketchPlugin/SketchPlugin_Arc.h index 3286cff42..47a9f9dd4 100644 --- a/src/SketchPlugin/SketchPlugin_Arc.h +++ b/src/SketchPlugin/SketchPlugin_Arc.h @@ -1,55 +1,95 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D --> + // File: SketchPlugin_Arc.h // Created: 26 May 2014 // Author: Artem ZHIDKOV -#ifndef SketchPlugin_Arc_HeaderFile -#define SketchPlugin_Arc_HeaderFile +#ifndef SketchPlugin_Arc_H_ +#define SketchPlugin_Arc_H_ #include "SketchPlugin.h" -#include +#include #include - -/// Arc feature kind -const std::string SKETCH_ARC_KIND("SketchArc"); - -/// Central 2D point of the circle which contains the arc -const std::string ARC_ATTR_CENTER("ArcCenter"); -/// Start 2D point of the arc -const std::string ARC_ATTR_START("ArcStartPoint"); -/// End 2D point of the arc -const std::string ARC_ATTR_END("ArcEndPoint"); +#include /**\class SketchPlugin_Arc - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new arc of circle in PartSet. + * The visualization of this object is separated in two parts. The first one is an AIS object + * calculated when there is non-initialized attributes of the arc. The second is a result and + * it is calculated if all attributes are initialized. */ -class SketchPlugin_Arc: public SketchPlugin_Feature +class SketchPlugin_Arc : public SketchPlugin_SketchEntity, public GeomAPI_IPresentable { -public: + /// to avoid cyclic dependencies in automatic updates: they mean that + /// update is performed right now and automatic updates are not needed + bool myStartUpdate, myEndUpdate; + + public: + /// Arc feature kind + inline static const std::string& ID() + { + static const std::string MY_SKETCH_ARC_ID("SketchArc"); + return MY_SKETCH_ARC_ID; + } + + /// Central 2D point of the circle which contains the arc + inline static const std::string& CENTER_ID() + { + static const std::string MY_CENTER_ID = "ArcCenter"; + return MY_CENTER_ID; + } + /// Start 2D point of the arc + inline static const std::string& START_ID() + { + static const std::string MY_START_ID = "ArcStartPoint"; + return MY_START_ID; + } + /// End 2D point of the arc + inline static const std::string& END_ID() + { + static const std::string MY_END_ID = "ArcEndPoint"; + return MY_END_ID; + } + /// Returns the kind of a feature SKETCHPLUGIN_EXPORT virtual const std::string& getKind() - {static std::string MY_KIND = SKETCH_ARC_KIND; return MY_KIND;} + { + static std::string MY_KIND = SketchPlugin_Arc::ID(); + return MY_KIND; + } - /// 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;} + /// Returns true is sketch element is under the rigid constraint + SKETCHPLUGIN_EXPORT virtual bool isFixed(); - /// Creates a new part document if needed + /// Creates an arc-shape SKETCHPLUGIN_EXPORT virtual void execute(); /// Request for initialization of data model of the feature: adding all attributes SKETCHPLUGIN_EXPORT virtual void initAttributes(); - /// Returns the sketch preview - SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr& preview(); + /// 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); + + /// Returns the AIS preview + virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious); - /// Adds sub-feature of the higher level feature (sub-element of the sketch) - /// \param theFeature sub-feature - SKETCHPLUGIN_EXPORT virtual const void addSub( - const boost::shared_ptr& theFeature) {}; + /// 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); + + /// Return the distance between the feature and the point + /// \param thePoint the point + virtual double distanceToPoint(const std::shared_ptr& thePoint); /// Use plugin manager for features creation SketchPlugin_Arc(); + +private: + /// Returns true if all obligatory attributes are initialized + bool isFeatureValid(); }; #endif