src/Model/Model_ResultGroup.h

   1 // Copyright (C) 2014-2022  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef Model_ResultGroup_H_
  21 #define Model_ResultGroup_H_
  22
  23 #include "Model.h"
  24 #include <ModelAPI_ResultGroup.h>
  25
  26 /**\class Model_ResultGroup
  27  * \ingroup DataModel
  28  * \brief The groups result.
  29  *
  30  * Provides a compound of selected elements, without storage, one the fly.
  31  */
  32 class Model_ResultGroup : public ModelAPI_ResultGroup
  33 {
  34   std::shared_ptr<ModelAPI_Data> myOwnerData;  ///< data of owner of this result
  35 public:
  36
  37   /// Retuns the parameters of color definition in the resources config manager
  38   MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  39                                             std::string& theDefault);
  40
  41   /// Returns the compound of selected entities
  42   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  43
  44   /// \brief Stores the result of operation made on groups.
  45   ///        Cleans the storage if empty shape is given.
  46   /// param[in] theShape shape to store.
  47   MODEL_EXPORT virtual void store(const GeomShapePtr& theShape);
  48
  49   /// Removes the stored builders
  50   MODEL_EXPORT virtual ~Model_ResultGroup() {}
  51
  52 protected:
  53   /// Makes a body on the given feature data
  54   Model_ResultGroup(std::shared_ptr<ModelAPI_Data> theOwnerData);
  55
  56   friend class Model_Objects;
  57 };
  58
  59 #endif