X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2FSketchPlugin_Constraint.h;h=dc4a228cbc80aa1dbe7f5917ced4dd3c9a0fee4d;hb=df51e63f5d87b0c8fa46f5cda0c7c92aad5da888;hp=031587be0db99043ff01bc3950888833011e67a6;hpb=7ee1eff7098db3bd08f072034d4926524950f230;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/SketchPlugin_Constraint.h b/src/SketchPlugin/SketchPlugin_Constraint.h index 031587be0..dc4a228cb 100644 --- a/src/SketchPlugin/SketchPlugin_Constraint.h +++ b/src/SketchPlugin/SketchPlugin_Constraint.h @@ -1,80 +1,87 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D --> + // File: SketchPlugin_Constraint.h // Created: 08 May 2014 // Author: Artem ZHIDKOV -#ifndef SketchPlugin_Constraint_HeaderFile -#define SketchPlugin_Constraint_HeaderFile +#ifndef SketchPlugin_Constraint_H_ +#define SketchPlugin_Constraint_H_ -#include "SketchPlugin.h" -#include "SketchPlugin_Feature.h" -#include -#include -#include +#include -/* Description: - * Each constraint uses a set of parameters. In the SolveSpace library - * these parameters are named "valA", "ptA", "ptB", "entityA", "entityB". - * The "ptA" and "ptB" parameters represents a point in the constraint. - * The "entityA" and "entityB" represents any other object (and a point too). - * And the "valA" represents a real value. - * - * The attributes below are named corresponding to the SolveSpace, - * some of them may be unused. The list of used attributes is defined - * inside the certain constraint. - */ -/// The value parameter for the constraint -const std::string CONSTRAINT_ATTR_VALUE("ConstraintValueA"); -/// First point for the constraint -const std::string CONSTRAINT_ATTR_POINT_A("ConstraintPointA"); -/// Second point for the constraint -const std::string CONSTRAINT_ATTR_POINT_B("ConstraintPointB"); -/// First entity for the constraint -const std::string CONSTRAINT_ATTR_ENTITY_A("ConstraintEntityA"); -/// Second entity for the constraint -const std::string CONSTRAINT_ATTR_ENTITY_B("ConstraintEntityB"); +#include +/// Size of the list of constraint attributes +const unsigned int CONSTRAINT_ATTR_SIZE = 4; /** \class SketchPlugin_Constraint - * \ingroup DataModel - * \brief Feature for creation of a new constraint between other features. + * \brief Abstract interface to the SketchPlugin_ConstraintBase + * For more info see: SketchPlugin_ConstraintBase.h */ -class SketchPlugin_Constraint: public SketchPlugin_Feature +class SketchPlugin_Constraint : public SketchPlugin_Feature { -public: - /// \brief Returns the kind of a feature - SKETCHPLUGIN_EXPORT virtual const std::string& getKind() - {static std::string MY_KIND = "SketchConstraint"; return MY_KIND;} - - /// \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 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) {} + public: + /// The value parameter for the constraint + inline static const std::string& VALUE() + { + static const std::string MY_CONSTRAINT_VALUE("ConstraintValue"); + return MY_CONSTRAINT_VALUE; + } + /// The 2D value parameter for the constraint + inline static const std::string& FLYOUT_VALUE_PNT() + { + static const std::string MY_FLYOUT_VALUE_PNT("ConstraintFlyoutValuePnt"); + return MY_FLYOUT_VALUE_PNT; + } + /// First entity for the constraint + inline static const std::string& ENTITY_A() + { + static const std::string MY_ENTITY_A("ConstraintEntityA"); + return MY_ENTITY_A; + } + /// Second entity for the constraint + inline static const std::string& ENTITY_B() + { + static const std::string MY_ENTITY_B("ConstraintEntityB"); + return MY_ENTITY_B; + } + /// Third entity for the constraint + inline static const std::string& ENTITY_C() + { + static const std::string MY_ENTITY_C("ConstraintEntityC"); + return MY_ENTITY_C; + } + /// Fourth entity for the constraint + inline static const std::string& ENTITY_D() + { + static const std::string MY_ENTITY_D("ConstraintEntityD"); + return MY_ENTITY_D; + } - /** \brief Adds an object of the constraint. The object added by the reference. - * \param theReference reference to the feature, which will be constrained - */ - SKETCHPLUGIN_EXPORT virtual void addConstrainedObject( - const boost::shared_ptr& theReference); - - /** \brief Adds an object of the constraint. The object added by the reference to its attribute. - * \param theReference reference to the attribute feature, which will be constrained - */ - SKETCHPLUGIN_EXPORT virtual void addConstrainedObject( - const boost::shared_ptr& theReference); + /// List of constraint attributes + inline static const std::string& ATTRIBUTE(const int theNumber) + { + switch (theNumber) { + case 0: + return ENTITY_A(); + case 1: + return ENTITY_B(); + case 2: + return ENTITY_C(); + case 3: + return ENTITY_D(); + default: + break; + } + static const std::string EMPTY_STRING(""); + return EMPTY_STRING; + } + protected: /// \brief Use plugin manager for features creation - SketchPlugin_Constraint() {} - -protected: - /** \brief Returns the list of attributes for the certain type of constraint. - * \return names of attributes - */ - virtual const std::list& getAttributesList() const = 0; + SketchPlugin_Constraint(); }; +typedef std::shared_ptr ConstraintPtr; + #endif