src/ModelAPI/ModelAPI_ResultGroup.h

   1 // Copyright (C) 2014-2023  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 ModelAPI_ResultGroup_H_
  21 #define ModelAPI_ResultGroup_H_
  22
  23 #include "ModelAPI_Result.h"
  24 #include <GeomAPI_Shape.h>
  25 #include <memory>
  26 #include <string>
  27
  28 /**\class ModelAPI_ResultGroup
  29  * \ingroup DataModel
  30  * \brief The groups result.
  31  *
  32  * Provides a compound of selected elements, without storage, one the fly.
  33  */
  34 class ModelAPI_ResultGroup : public ModelAPI_Result
  35 {
  36 public:
  37   MODELAPI_EXPORT virtual ~ModelAPI_ResultGroup();
  38   /// Returns the group identifier of this result
  39   MODELAPI_EXPORT virtual std::string groupName();
  40
  41   /// Returns the group identifier of this result
  42   inline static std::string group()
  43   {
  44     static std::string MY_GROUP = "Groups";
  45     return MY_GROUP;
  46   }
  47
  48   /// default color for a result body
  49   inline static const std::string& DEFAULT_COLOR()
  50   {
  51     static const std::string RESULT_GROUP_COLOR("150,150,180");
  52     return RESULT_GROUP_COLOR;
  53   }
  54
  55   /// \brief Stores the result of operation made on groups.
  56   ///        Cleans the storage if empty shape is given.
  57   /// param[in] theShape shape to store.
  58   MODELAPI_EXPORT virtual void store(const GeomShapePtr& /*theShape*/)
  59   {}
  60 };
  61
  62 //! Pointer on feature object
  63 typedef std::shared_ptr<ModelAPI_ResultGroup> ResultGroupPtr;
  64
  65 #endif