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   /// Stores the shape (called by the execution method).
  43   MODEL_EXPORT virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape);
  44
  45   /// Stores the generated shape (called by the execution method).
  46   MODEL_EXPORT virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
  47                                                const std::shared_ptr<GeomAPI_Shape>& theToShape);
  48
  49   /// Stores the modified shape (called by the execution method).
  50   MODEL_EXPORT virtual void storeModified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  51                                                const std::shared_ptr<GeomAPI_Shape>& theNewShape);
  52
  53   /// Returns the shape-result produced by this feature
  54   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  55
  56   /// Records the subshape newShape which was generated during a topological construction.
  57   /// As an example, consider the case of a face generated in construction of a box.
  58   MODEL_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theNewShape,
  59     const std::string& theName, const int theTag = 1);
  60
  61   /// Records the shape newShape which was generated from the shape oldShape during a topological
  62   /// construction. As an example, consider the case of a face generated from an edge in
  63   /// construction of a prism.
  64   MODEL_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  65     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1);
  66
  67
  68   /// Records the shape newShape which is a modification of the shape oldShape.
  69   /// As an example, consider the case of a face split or merged in a Boolean operation.
  70   MODEL_EXPORT virtual void modified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  71     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1);
  72
  73   /// Records the shape oldShape which was deleted from the current label.
  74   /// As an example, consider the case of a face removed by a Boolean operation.
  75   MODEL_EXPORT virtual void deleted(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  76     const int theTag = 1);
  77
  78   /// load deleted shapes
  79   MODEL_EXPORT virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
  80                                                std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  81                                                const int  theKindOfShape,
  82                                                const int  theTag);
  83   /// load and orient modified shapes
  84   MODEL_EXPORT virtual void loadAndOrientModifiedShapes (
  85                                                    GeomAlgoAPI_MakeShape* theMS,
  86                                                std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  87                                                const int  theKindOfShape,
  88                                                const int  theTag,
  89                                                                                            const std::string& theName,
  90                                                GeomAPI_DataMapOfShapeShape& theSubShapes);
  91    /// load and orient generated shapes
  92   MODEL_EXPORT virtual void loadAndOrientGeneratedShapes (
  93                                                    GeomAlgoAPI_MakeShape* theMS,
  94                                                std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  95                                                const int  theKindOfShape,
  96                                                const int  theTag,
  97                                                                                            const std::string& theName,
  98                                                GeomAPI_DataMapOfShapeShape& theSubShapes);
  99
 100   /// Loads shapes of the first level (to be used during shape import)
 101   MODEL_EXPORT virtual void loadFirstLevel(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int&  theTag);
 102
 103   /// Loads disconnected edges
 104   MODEL_EXPORT virtual void loadDisconnectedEdges(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int&  theTag);
 105
 106   /// Loads disconnected vetexes
 107   MODEL_EXPORT virtual void loadDisconnectedVertexes(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int&  theTag);
 108
 109   /// Removes the stored builders
 110   MODEL_EXPORT virtual ~Model_ResultBody();
 111
 112 protected:
 113   /// Makes a body on the given feature
 114   Model_ResultBody();
 115
 116   /// Removes the stored builders
 117   void clean();
 118
 119   /// Returns (creates if necessary) the builder created on the needed tag of sub-label
 120   TNaming_Builder* builder(const int theTag);
 121
 122 private:
 123   /// Loads shapes of the next level (to be used during shape import)
 124   void loadNextLevels(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int&  theTag);
 125
 126   /// builds name for the shape kept at the specified tag
 127   void buildName(const int theTag, const std::string& theName);
 128
 129   friend class Model_Document;
 130 };
 131
 132 #endif