src/Model/Model_ResultBody.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Model_ResultBody.h
   4 // Created:     08 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef Model_ResultBody_H_
   8 #define Model_ResultBody_H_
   9
  10 #include "Model.h"
  11 #include <ModelAPI_ResultBody.h>
  12 #include <GeomAlgoAPI_MakeShape.h>
  13 #include <GeomAPI_DataMapOfShapeShape.h>
  14 #include <vector>
  15
  16 class TNaming_Builder;
  17
  18 /**\class Model_ResultBody
  19  * \ingroup DataModel
  20  * \brief The body (shape) result of a feature.
  21  *
  22  * Provides a shape that may be displayed in the viewer.
  23  * May provide really huge results, so, working with this kind
  24  * of result must be optimized.
  25  */
  26 class Model_ResultBody : public ModelAPI_ResultBody
  27 {
  28   /// builders that tores the naming history: one per label to allow store several shapes to one
  29   /// label; index in vector corresponds to the label tag
  30   std::vector<TNaming_Builder*> myBuilders;
  31 public:
  32   /// default color for a result body
  33   inline static const std::string& DEFAULT_COLOR()
  34   {
  35     static const std::string RESULT_BODY_COLOR("#E0A01B");
  36     return RESULT_BODY_COLOR;
  37   }
  38
  39   /// Request for initialization of data model of the result: adding all attributes
  40   virtual void initAttributes();
  41
  42   // Retuns the parameters of color definition in the resources config manager
  43   MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  44                                             std::string& theDefault);
  45
  46   /// Stores the shape (called by the execution method).
  47   MODEL_EXPORT virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape);
  48
  49   /// Stores the generated shape (called by the execution method).
  50   MODEL_EXPORT virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
  51                                                const std::shared_ptr<GeomAPI_Shape>& theToShape);
  52
  53   /// Stores the modified shape (called by the execution method).
  54   MODEL_EXPORT virtual void storeModified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  55                                                const std::shared_ptr<GeomAPI_Shape>& theNewShape);
  56
  57   /// Returns the shape-result produced by this feature
  58   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  59
  60   /// Records the subshape newShape which was generated during a topological construction.
  61   /// As an example, consider the case of a face generated in construction of a box.
  62   MODEL_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theNewShape,
  63     const std::string& theName, const int theTag = 1);
  64
  65   /// Records the shape newShape which was generated from the shape oldShape during a topological
  66   /// construction. As an example, consider the case of a face generated from an edge in
  67   /// construction of a prism.
  68   MODEL_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  69     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1);
  70
  71
  72   /// Records the shape newShape which is a modification of the shape oldShape.
  73   /// As an example, consider the case of a face split or merged in a Boolean operation.
  74   MODEL_EXPORT virtual void modified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  75     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1);
  76
  77   /// Records the shape oldShape which was deleted from the current label.
  78   /// As an example, consider the case of a face removed by a Boolean operation.
  79   MODEL_EXPORT virtual void deleted(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  80     const int theTag = 1);
  81
  82   /// load deleted shapes
  83   MODEL_EXPORT virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
  84                                                std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  85                                                const int  theKindOfShape,
  86                                                const int  theTag);
  87   /// load and orient modified shapes
  88   MODEL_EXPORT virtual void loadAndOrientModifiedShapes (
  89                                                    GeomAlgoAPI_MakeShape* theMS,
  90                                                std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  91                                                const int  theKindOfShape,
  92                                                const int  theTag,
  93                                                                                            const std::string& theName,
  94                                                GeomAPI_DataMapOfShapeShape& theSubShapes);
  95    /// load and orient generated shapes
  96   MODEL_EXPORT virtual void loadAndOrientGeneratedShapes (
  97                                                    GeomAlgoAPI_MakeShape* theMS,
  98                                                std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  99                                                const int  theKindOfShape,
 100                                                const int  theTag,
 101                                                                                            const std::string& theName,
 102                                                GeomAPI_DataMapOfShapeShape& theSubShapes);
 103
 104   /// Loads shapes of the first level (to be used during shape import)
 105   MODEL_EXPORT virtual void loadFirstLevel(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int&  theTag);
 106
 107   /// Loads disconnected edges
 108   MODEL_EXPORT virtual void loadDisconnectedEdges(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int&  theTag);
 109
 110   /// Loads disconnected vetexes
 111   MODEL_EXPORT virtual void loadDisconnectedVertexes(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int&  theTag);
 112
 113   /// Removes the stored builders
 114   MODEL_EXPORT virtual ~Model_ResultBody();
 115
 116 protected:
 117   /// Makes a body on the given feature
 118   Model_ResultBody();
 119
 120   /// Removes the stored builders
 121   void clean();
 122
 123   /// Returns (creates if necessary) the builder created on the needed tag of sub-label
 124   TNaming_Builder* builder(const int theTag);
 125
 126 private:
 127   /// Loads shapes of the next level (to be used during shape import)
 128   void loadNextLevels(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int&  theTag);
 129
 130   /// builds name for the shape kept at the specified tag
 131   void buildName(const int theTag, const std::string& theName);
 132
 133   friend class Model_Document;
 134 };
 135
 136 #endif