src/SketchSolver/SketchSolver_ConstraintMirror.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:    SketchSolver_ConstraintMirror.h
   4 // Created: 1 Apr 2015
   5 // Author:  Artem ZHIDKOV
   6
   7 #ifndef SketchSolver_ConstraintMirror_H_
   8 #define SketchSolver_ConstraintMirror_H_
   9
  10 #include "SketchSolver.h"
  11 #include <SketchSolver_Constraint.h>
  12
  13 /** \class   SketchSolver_ConstraintMirror
  14  *  \ingroup Plugins
  15  *  \brief   Convert fillet constraint to SolveSpace structure
  16  */
  17 class SketchSolver_ConstraintMirror : public SketchSolver_Constraint
  18 {
  19 public:
  20   SketchSolver_ConstraintMirror(ConstraintPtr theConstraint) :
  21       SketchSolver_Constraint(theConstraint),
  22       myNumberOfObjects(0)
  23   {}
  24
  25   virtual int getType() const
  26   { return SLVS_C_SYMMETRIC_LINE; }
  27
  28   /// \brief Update constraint
  29   virtual void update(ConstraintPtr theConstraint = ConstraintPtr());
  30
  31   /// \brief Tries to remove constraint
  32   /// \return \c false, if current constraint contains another SketchPlugin constraints (like for multiple coincidence)
  33   virtual bool remove(ConstraintPtr theConstraint = ConstraintPtr());
  34
  35 protected:
  36   /// \brief Converts SketchPlugin constraint to a list of SolveSpace constraints
  37   virtual void process();
  38
  39   /// \brief Generate list of attributes of constraint in order useful for SolveSpace constraints
  40   /// \param[out] theValue      numerical characteristic of constraint (e.g. distance)
  41   /// \param[out] theAttributes list of attributes to be filled
  42   virtual void getAttributes(double& theValue, std::vector<Slvs_hEntity>& theAttributes)
  43   { /* do nothing here */ }
  44
  45   /// \brief Verify the attributes of constraint are changed (and constraint need to rebuild)
  46   /// \param[in] theConstraint constraint, which attributes should be checked (if NULL, the myBaseConstraint is used)
  47   /// \return \c true if some attributes are changed
  48   virtual bool checkAttributesChanged(ConstraintPtr theConstraint);
  49
  50   /// \brief Generate list of entities of mirror constraint
  51   /// \param[out] theMirrorLine     entity corresponding to mirror line
  52   /// \param[out] theBaseEntities   list of entities to mirror
  53   /// \param[out] theMirrorEntities list of mirrored entities
  54   void getAttributes(Slvs_Entity& theMirrorLine,
  55                      std::vector<Slvs_Entity>& theBaseEntities,
  56                      std::vector<Slvs_Entity>& theMirrorEntities);
  57
  58   /// \brief This method is used in derived objects to check consistence of constraint.
  59   ///        E.g. the distance between line and point may be signed.
  60   virtual void adjustConstraint();
  61
  62 private:
  63   /// \brief Change parameters of entities to be symmetric relative a line,
  64   ///        given by array of parameters (coordinates of first and last points)
  65   void makeMirrorEntity(const Slvs_Entity& theBase,
  66                         const Slvs_Entity& theMirror,
  67                         const double theMirrorLine[]) const;
  68
  69   /// \brief Precisely update last point to be on arc
  70   void adjustArcPoints(const Slvs_Entity& theArc) const;
  71
  72 private:
  73   size_t myNumberOfObjects; ///< number of previously mirrored objects
  74 };
  75
  76 #endif