X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchSolver%2FSketchSolver_Constraint.h;h=c0545a520aae4e97cbd94cc3b8e9d0f356129a30;hb=de16c210a6c0cd034d143d0f9b37e089cdf2ed7e;hp=4caa73b49bcc9ec0598383d34513ab35780f40e6;hpb=4783f146b71a48c651523fcf0e12367bcf3d1fa8;p=modules%2Fshaper.git diff --git a/src/SketchSolver/SketchSolver_Constraint.h b/src/SketchSolver/SketchSolver_Constraint.h index 4caa73b49..c0545a520 100644 --- a/src/SketchSolver/SketchSolver_Constraint.h +++ b/src/SketchSolver/SketchSolver_Constraint.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: SketchSolver_Constraint.h // Created: 27 May 2014 // Author: Artem ZHIDKOV @@ -5,45 +7,96 @@ #ifndef SketchSolver_Constraint_H_ #define SketchSolver_Constraint_H_ -#include "SketchSolver.h" +#include +#include #include +#include +#include + #include #include /** \class SketchSolver_Constraint - * \ingroup DataModel - * \brief Obtain information about SketchPlugin's constraint + * \ingroup Plugins + * \brief Converts SketchPlugin constraint to the constraint applicable for solver */ class SketchSolver_Constraint { - public: - SketchSolver_Constraint(); - SketchSolver_Constraint(std::shared_ptr theConstraint); - - /** \brief Compute constraint type according to SolveSpace identifiers - * and verify that constraint parameters are correct - * \param[in] theConstraint constraint which type should be determined - * \return identifier of constraint type or SLVS_C_UNKNOWN if the type is wrong - */ - const int& getType(std::shared_ptr theConstraint); - /// \brief Returns the type of myConstraint member - inline const int& getType() const - { - return myType; - } - - /// \brief Returns list of attributes names in the correct order required by SolveSpace - inline const std::vector& getAttributes() const - { - return myAttributesList; - } - - private: - std::shared_ptr myConstraint; - int myType; - std::vector myAttributesList; +protected: + /// Default constructor + SketchSolver_Constraint() + : myType(CONSTRAINT_UNKNOWN) + {} + +public: + /// Constructor based on SketchPlugin constraint + SketchSolver_Constraint(ConstraintPtr theConstraint); + + virtual ~SketchSolver_Constraint() {} + + /// \brief Initializes parameters and start constraint creation + /// \param theStorage [in] storage where to place new constraint + /// \param theEventsBlocked [in] all events from this constraint should be blocked + void process(StoragePtr theStorage, bool theEvensBlocked); + + /// \brief Notify this object about the feature is changed somewhere + virtual void notify(const FeaturePtr& theFeature, PlaneGCSSolver_Update* theUpdater) {} + + /// \brief Update constraint + virtual void update(); + + /// \brief Tries to remove constraint + /// \return \c false, if current constraint contains another SketchPlugin constraints + /// (like for multiple coincidence) + virtual bool remove(); + + /// \brief Block or unblock events from this constraint + virtual void blockEvents(bool isBlocked); + + /// \brief Obtain a type of SketchPlugin constraint + static SketchSolver_ConstraintType TYPE(ConstraintPtr theConstraint); + + /// \brief Returns the type of constraint + virtual SketchSolver_ConstraintType getType() const + { return myType; } + + /// \brief Shows error message + const std::string& error() const + { return myErrorMsg; } + +protected: + /// \brief Converts SketchPlugin constraint to a list of solver's constraints + virtual void process(); + + /// \brief Generate list of attributes of constraint in order useful for constraints + /// \param[out] theValue numerical characteristic of constraint (e.g. distance) + /// \param[out] theAttributes list of attributes to be filled + virtual void getAttributes(EntityWrapperPtr& theValue, + std::vector& theAttributes); + + /// \brief This method is used in derived objects to check consistency of constraint. + /// E.g. the distance between line and point may be signed. + virtual void adjustConstraint() + {} + + /// \brief Removes last error + void cleanErrorMsg() + { myErrorMsg.clear(); } + +protected: + ConstraintPtr myBaseConstraint; ///< base SketchPlugin constraint + ConstraintWrapperPtr mySolverConstraint; ///< wrapper for PlaneGCS constraint + + /// storage, which contains all information about entities and constraints + StoragePtr myStorage; + SketchSolver_ConstraintType myType; ///< type of constraint + std::list myAttributes; ///< attributes of constraint + + std::string myErrorMsg; ///< error message }; +typedef std::shared_ptr SolverConstraintPtr; + #endif