src/Model/Model_ResultPart.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_ResultPart.hxx
   4 // Created:     07 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef Model_ResultPart_H_
   8 #define Model_ResultPart_H_
   9
  10 #include "Model.h"
  11 #include <ModelAPI_ResultPart.h>
  12 #include <TopoDS_Shape.hxx>
  13 #include <gp_Trsf.hxx>
  14
  15 /**\class Model_ResultPart
  16  * \ingroup DataModel
  17  * \brief The Part document, result of a creation of new part feature.
  18  *
  19  * This result leaves without feature: no parametricity for this element,
  20  * only add/remove, undo/redo.
  21  */
  22 class Model_ResultPart : public ModelAPI_ResultPart
  23 {
  24   TopoDS_Shape myShape; ///< shape of this part created from bodies (updated only of Part deactivation)
  25   std::shared_ptr<gp_Trsf> myTrsf; ///< if it is just copy of original shape, keep just transformation
  26   bool myIsInLoad; ///< true if document of this part is in the loading process, so, it may be already received
  27  public:
  28
  29   /// the reference to the base result document, may be null if this is the root, others make sequence of references
  30   inline static const std::string& BASE_REF_ID()
  31   {
  32     static const std::string MY_BASE_REF("BaseReference");
  33     return MY_BASE_REF;
  34   }
  35   /// Request for initialization of data model of the result: adding all attributes
  36   virtual void initAttributes();
  37   /// Returns the part-document of this result
  38   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> partDoc();
  39
  40   /// Returns the original part result: for transfomration features results this is
  41   /// the original Part feature result
  42   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultPart> original();
  43
  44   /// Sets this document as current and if it is not loaded yet, loads it
  45   MODEL_EXPORT virtual void activate();
  46
  47   /// disable all feature of the part on disable of the part result
  48   MODEL_EXPORT virtual bool setDisabled(std::shared_ptr<ModelAPI_Result> theThis,
  49     const bool theFlag);
  50
  51   /// Result shape of part document is compound of bodies inside of this part
  52   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  53
  54   /// Returns the name of the shape inside of the part
  55   /// \param theShape selected shape in this document
  56   /// \param theIndex is returned as one-based index if selection was required, "0" otherwise
  57   /// \returns empty name is selection is not correct
  58   MODEL_EXPORT virtual std::string nameInPart(const std::shared_ptr<GeomAPI_Shape>& theShape,
  59     int& theIndex);
  60
  61   /// Updates the selection inside of the part by the selection index
  62   MODEL_EXPORT virtual bool updateInPart(const int theIndex);
  63   /// Returns the shape by the name in the part
  64   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shapeInPart(const std::string& theName);
  65   /// Updates the shape-result of the part (called on Part feature execution)
  66   MODEL_EXPORT virtual void updateShape();
  67   /// Applies the additional transformation of the part
  68   MODEL_EXPORT virtual void setTrsf(std::shared_ptr<ModelAPI_Result> theThis,
  69     const std::shared_ptr<GeomAPI_Trsf>& theTransformation);
  70
  71   /// Returns the parameters of color definition in the resources config manager
  72   MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  73                                             std::string& theDefault);
  74
  75 protected:
  76   /// makes a result on a temporary feature (an action)
  77   Model_ResultPart();
  78
  79   /// Returns true if document is activated (loaded into the memory)
  80   virtual bool isActivated();
  81
  82   friend class Model_Objects;
  83 };
  84
  85 #endif