src/ModelAPI/ModelAPI_ResultPart.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_ResultPart.h
   4 // Created:     07 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef ModelAPI_ResultPart_H_
   8 #define ModelAPI_ResultPart_H_
   9
  10 #include "ModelAPI_Result.h"
  11
  12 #include <string>
  13
  14 /**\class ModelAPI_ResultPart
  15  * \ingroup DataModel
  16  * \brief The Part document, result of a creation of new part feature.
  17  *
  18  * This result leaves without feature: no parametricity for this element,
  19  * only add/remove, undo/redo.
  20  */
  21 class ModelAPI_ResultPart : public ModelAPI_Result
  22 {
  23  public:
  24   /// Returns the group identifier of this result
  25   MODELAPI_EXPORT virtual std::string groupName();
  26
  27   /// Returns the group identifier of this result
  28   inline static std::string group()
  29   {
  30     static std::string MY_GROUP = "Parts";
  31     return MY_GROUP;
  32   }
  33
  34   /// part document reference attribute
  35   inline static const std::string& DOC_REF()
  36   {
  37     static const std::string MY_DOC_REF("PartDocument");
  38     return MY_DOC_REF;
  39   }
  40
  41   /// default color for a result body
  42   inline static const std::string& DEFAULT_COLOR()
  43   {
  44     static const std::string RESULT_BODY_COLOR("96,157,255");
  45     return RESULT_BODY_COLOR;
  46   }
  47
  48   /// Returns the part-document of this result
  49   virtual std::shared_ptr<ModelAPI_Document> partDoc() = 0;
  50
  51   /// Sets this document as current and if it is not loaded yet, loads it
  52   virtual void activate() = 0;
  53
  54   /// Returns true if document is activated (loaded into the memory)
  55   virtual bool isActivated() = 0;
  56
  57   /// Returns the name of the shape inside of the part
  58   virtual std::string nameInPart(const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
  59   /// Returns the shape by the name in the part
  60   virtual std::shared_ptr<GeomAPI_Shape> shapeInPart(const std::string& theName) = 0;
  61   /// Updates the shape-result of the part (called on Part feature execution)
  62   virtual void updateShape() = 0;
  63 };
  64
  65 //! Pointer on feature object
  66 typedef std::shared_ptr<ModelAPI_ResultPart> ResultPartPtr;
  67
  68 #endif