-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File: SketchSolver_Constraint.h
-// Created: 27 May 2014
-// Author: Artem ZHIDKOV
+// Copyright (C) 2014-2019 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 SketchSolver_Constraint_H_
#define SketchSolver_Constraint_H_
-#include "SketchSolver.h"
#include <SketchSolver_Storage.h>
+#include <PlaneGCSSolver_Update.h>
#include <SketchPlugin_Constraint.h>
+#include <ModelAPI_AttributeDouble.h>
#include <ModelAPI_AttributeRefAttr.h>
#include <string>
#include <vector>
-class SketchSolver_Group;
-
/** \class SketchSolver_Constraint
* \ingroup Plugins
- * \brief Stores mapping between SketchPlugin and SolveSpace constraints data
+ * \brief Converts SketchPlugin constraint to the constraint applicable for solver
*/
class SketchSolver_Constraint
{
protected:
/// Default constructor
- SketchSolver_Constraint() {}
- SketchSolver_Constraint(ConstraintPtr theConstraint);
+ SketchSolver_Constraint()
+ : myType(CONSTRAINT_UNKNOWN)
+ {}
public:
- virtual ~SketchSolver_Constraint();
-
- /// \brief Initializes the storage of SolveSpace constraints
- void setStorage(StoragePtr theStorage);
- /// \brief Initializes group ID for this constraint
- void setGroup(SketchSolver_Group* theGroup);
-
- /// \brief Update constraint
- virtual void update(ConstraintPtr theConstraint = ConstraintPtr());
+ /// Constructor based on SketchPlugin constraint
+ SketchSolver_Constraint(ConstraintPtr theConstraint);
- /// \brief Tries to remove constraint
- /// \return \c false, if current constraint contains another SketchPlugin constraints (like for multiple coincidence)
- virtual bool remove(ConstraintPtr theConstraint = ConstraintPtr());
+ virtual ~SketchSolver_Constraint() {}
- /// \brief Update SketchPlugin attributes using the data obtained from SolveSpace entities
- void refresh();
+ /// \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 Returns the type of constraint
- virtual int getType() const = 0;
+ /// \brief Notify this object about the feature is changed somewhere
+ virtual void notify(const FeaturePtr& theFeature, PlaneGCSSolver_Update* theUpdater) {}
- /// \brief The constraint is made temoparary
- void makeTemporary() const;
+ /// \brief Update constraint
+ virtual void update();
- /// \brief Checks the constraint is used by current object
- virtual bool hasConstraint(ConstraintPtr theConstraint) const
- { return theConstraint == myBaseConstraint; }
+ /// \brief Tries to remove constraint
+ /// \return \c false, if current constraint contains another SketchPlugin constraints
+ /// (like for multiple coincidence)
+ virtual bool remove();
- /// \brief Return list of SketchPlugin constraints attached to this object
- virtual std::list<ConstraintPtr> constraints() const;
+ /// \brief Block or unblock events from this constraint
+ virtual void blockEvents(bool isBlocked);
- /// \brief Return identifier of SolveSpace entity relating to the feature
- Slvs_hEntity getId(FeaturePtr theFeature) const;
- /// \brief Return identifier of SolveSpace entity relating to the attribute
- Slvs_hEntity getId(AttributePtr theAttribute) const;
+ /// \brief Obtain a type of SketchPlugin constraint
+ static SketchSolver_ConstraintType TYPE(ConstraintPtr theConstraint);
- /// \brief Adds a feature to constraint and create its analogue in SolveSpace
- virtual void addFeature(FeaturePtr theFeature);
+ /// \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 SolveSpace constraints
+ /// \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 SolveSpace constraints
+ /// \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(double& theValue, std::vector<Slvs_hEntity>& theAttributes);
-
- /// \brief Verify the attributes of constraint are changed (and constraint need to rebuild)
- /// \param[in] theConstraint constraint, which attributes should be checked (if NULL, the myBaseConstraint is used)
- /// \return \c true if some attributes are changed
- virtual bool checkAttributesChanged(ConstraintPtr theConstraint);
+ virtual void getAttributes(EntityWrapperPtr& theValue,
+ std::vector<EntityWrapperPtr>& theAttributes);
- /// \brief This method is used in derived objects to check consistence of constraint.
+ /// \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 Create or change SlveSpace entity according to the given attribute
- /// \param[in] theAttribute reference to the entity to be changed
- /// \param[out] theType type of created entity
- /// \return identifier of created/updated entity
- Slvs_hEntity changeEntity(AttributeRefAttrPtr theAttribute, int& theType);
- /// \brief Create or change SlveSpace entity according to the given attribute
- Slvs_hEntity changeEntity(AttributePtr theAttribute, int& theType);
- /// \brief Create or change SlveSpace entity according to the given feature
- Slvs_hEntity changeEntity(FeaturePtr theFeature, int& theType);
-
- /// \brief Calculate middle point on the specified entity
- /// \param[in] theEntity arc or line
- /// \param[in] theCoeff is a value in [0.0, 1.0] which shows the position of the point on the entity (0.0 - start point, 1.0 - end point)
- /// \param[out] theX X coordinate of middle point
- /// \param[out] theY Y coordinate of middle point
- void calculateMiddlePoint(const Slvs_Entity& theEntity, double theCoeff,
- double& theX, double& theY) const;
-
- /// \brief Removes the links to unused entities
- void cleanRemovedEntities();
-
/// \brief Removes last error
void cleanErrorMsg()
{ myErrorMsg.clear(); }
-private:
- /// \brief Sets error, if the attribute is not initialized
- bool isInitialized(AttributePtr theAttribute);
-
protected:
- SketchSolver_Group* myGroup; ///< the group which contains current constraint
- ConstraintPtr myBaseConstraint; ///< SketchPlugin constraint
- std::vector<Slvs_hConstraint> mySlvsConstraints; ///< list of indices of SolveSpace constraints, together which equivalent to SketchPlugin constraint
- std::map<FeaturePtr, Slvs_hEntity> myFeatureMap; ///< map feature to the entity it represents
- std::map<AttributePtr, Slvs_hEntity> myAttributeMap; ///< map attribute to the corresponding entity
- std::map<AttributePtr, Slvs_hParam> myValueMap; ///< list of attributes, which represents single value (e.g. distance) used in constraint
- StoragePtr myStorage; ///< storage, which contains all information about entities and constraints in current group
-
- std::string myErrorMsg; ///< error message
-};
-
-typedef std::shared_ptr<SketchSolver_Constraint> SolverConstraintPtr;
-
-
-
-/** \class SketchSolver_ConstraintParallel
- * \ingroup Plugins
- * \brief Convert Parallel constraint to SolveSpace structure
- */
-class SketchSolver_ConstraintParallel : public SketchSolver_Constraint
-{
-public:
- SketchSolver_ConstraintParallel(ConstraintPtr theConstraint) :
- SketchSolver_Constraint(theConstraint)
- {}
-
- virtual int getType() const
- { return SLVS_C_PARALLEL; }
-};
-
-
-/** \class SketchSolver_ConstraintPerpendicular
- * \ingroup Plugins
- * \brief Convert Perpendicular constraint to SolveSpace structure
- */
-class SketchSolver_ConstraintPerpendicular : public SketchSolver_Constraint
-{
-public:
- SketchSolver_ConstraintPerpendicular(ConstraintPtr theConstraint) :
- SketchSolver_Constraint(theConstraint)
- {}
-
- virtual int getType() const
- { return SLVS_C_PERPENDICULAR; }
-};
-
-
-/** \class SketchSolver_ConstraintHorizontal
- * \ingroup Plugins
- * \brief Convert Horizontal constraint to SolveSpace structure
- */
-class SketchSolver_ConstraintHorizontal : public SketchSolver_Constraint
-{
-public:
- SketchSolver_ConstraintHorizontal(ConstraintPtr theConstraint) :
- SketchSolver_Constraint(theConstraint)
- {}
-
- virtual int getType() const
- { return SLVS_C_HORIZONTAL; }
-};
-
+ ConstraintPtr myBaseConstraint; ///< base SketchPlugin constraint
+ ConstraintWrapperPtr mySolverConstraint; ///< wrapper for PlaneGCS constraint
-/** \class SketchSolver_ConstraintVertical
- * \ingroup Plugins
- * \brief Convert Vertical constraint to SolveSpace structure
- */
-class SketchSolver_ConstraintVertical : public SketchSolver_Constraint
-{
-public:
- SketchSolver_ConstraintVertical(ConstraintPtr theConstraint) :
- SketchSolver_Constraint(theConstraint)
- {}
+ /// storage, which contains all information about entities and constraints
+ StoragePtr myStorage;
+ SketchSolver_ConstraintType myType; ///< type of constraint
+ std::list<EntityWrapperPtr> myAttributes; ///< attributes of constraint
- virtual int getType() const
- { return SLVS_C_VERTICAL; }
+ std::string myErrorMsg; ///< error message
};
-
-/** \class SketchSolver_ConstraintRadius
- * \ingroup Plugins
- * \brief Convert Radius constraint to SolveSpace structure
- */
-class SketchSolver_ConstraintRadius : public SketchSolver_Constraint
-{
-public:
- SketchSolver_ConstraintRadius(ConstraintPtr theConstraint) :
- SketchSolver_Constraint(theConstraint)
- {}
-
- virtual int getType() const
- { return SLVS_C_DIAMETER; }
-
- virtual void adjustConstraint()
- {
- Slvs_Constraint aConstraint = myStorage->getConstraint(mySlvsConstraints.front());
- aConstraint.valA *= 2.0;
- myStorage->updateConstraint(aConstraint);
- }
-};
+typedef std::shared_ptr<SketchSolver_Constraint> SolverConstraintPtr;
#endif