src/SketchSolver/SolveSpaceSolver/SolveSpaceSolver_EntityWrapper.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef SolveSpaceSolver_EntityWrapper_H_
  22 #define SolveSpaceSolver_EntityWrapper_H_
  23
  24 #include <SketchSolver_IEntityWrapper.h>
  25 #include <SolveSpaceSolver_Solver.h>
  26
  27 /**
  28  *  Wrapper providing operations with SolveSpace entities.
  29  */
  30 class SolveSpaceSolver_EntityWrapper : public SketchSolver_IEntityWrapper
  31 {
  32 public:
  33   SolveSpaceSolver_EntityWrapper(const FeaturePtr theFeature, const Slvs_Entity& theEntity);
  34   SolveSpaceSolver_EntityWrapper(const AttributePtr theAttribute, const Slvs_Entity& theEntity);
  35
  36   /// \brief Constructor useful for SketchPlugin_Point only
  37   SolveSpaceSolver_EntityWrapper(const FeaturePtr thePointFeature,
  38                                  const AttributePtr thePointAttribute,
  39                                  const Slvs_Entity& theEntity);
  40
  41   /// \brief Return SolveSpace entity
  42   const Slvs_Entity& entity() const
  43   { return myEntity; }
  44   /// \brief Return SolveSpace entity to change
  45   Slvs_Entity& changeEntity()
  46   { return myEntity; }
  47
  48   /// \brief Return ID of current entity
  49   virtual EntityID id() const;
  50
  51   /// \brief Change group for the entity
  52   virtual void setGroup(const GroupID& theGroup);
  53   /// \brief Return identifier of the group the entity belongs to
  54   virtual GroupID group() const
  55   { return (GroupID)myEntity.group; }
  56
  57   /// \brief Return type of current entity
  58   virtual SketchSolver_EntityType type() const;
  59
  60   /// \brief Verify the feature is used in the entity
  61   virtual bool isUsed(FeaturePtr theFeature) const;
  62   /// \brief Verify the attribute is used in the entity
  63   virtual bool isUsed(AttributePtr theAttribute) const;
  64
  65   /// \brief Compare current entity with other
  66   virtual bool isEqual(const EntityWrapperPtr& theOther);
  67
  68   /// \brief Update values of parameters of this entity by the parameters of given one
  69   /// \return \c true if some parameters change their values
  70   virtual bool update(const std::shared_ptr<SketchSolver_IEntityWrapper>& theOther);
  71
  72 private:
  73   Slvs_Entity  myEntity;
  74 };
  75
  76 #endif