src/ModelAPI/ModelAPI_ResultBody.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_ResultBody.hxx
   4 // Created:     07 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef ModelAPI_ResultBody_H_
   8 #define ModelAPI_ResultBody_H_
   9
  10 #include "ModelAPI_Result.h"
  11 #include <GeomAPI_Shape.h>
  12 #include <GeomAPI_DataMapOfShapeShape.h>
  13 #include <string>
  14
  15 class ModelAPI_BodyBuilder;
  16 class GeomAlgoAPI_MakeShape;
  17
  18 /**\class ModelAPI_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 ModelAPI_ResultBody : public ModelAPI_Result
  27 {
  28 public:
  29   MODELAPI_EXPORT virtual ~ModelAPI_ResultBody();
  30   /// Returns the group identifier of this result
  31   MODELAPI_EXPORT virtual std::string groupName();
  32
  33   /// Returns the group identifier of this result
  34   inline static std::string group()
  35   {
  36     static std::string MY_GROUP = "Bodies";
  37     return MY_GROUP;
  38   }
  39
  40   /// default color for a result body
  41   inline static const std::string& DEFAULT_COLOR()
  42   {
  43     static const std::string RESULT_BODY_COLOR("150,150,180");
  44     return RESULT_BODY_COLOR;
  45   }
  46
  47   /// Stores the shape (called by the execution method).
  48   MODELAPI_EXPORT virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape);
  49
  50   /// Stores the generated shape (called by the execution method).
  51   MODELAPI_EXPORT virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
  52     const std::shared_ptr<GeomAPI_Shape>& theToShape);
  53
  54   /// Stores the modified shape (called by the execution method).
  55   MODELAPI_EXPORT virtual void storeModified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  56     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const int theDecomposeSolidsTag = 0);
  57
  58   /// Returns the shape-result produced by this feature
  59   MODELAPI_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  60
  61   /// Records the subshape newShape which was generated during a topological construction.
  62   /// As an example, consider the case of a face generated in construction of a box.
  63   MODELAPI_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theNewShape,
  64     const std::string& theName, const int theTag = 1);
  65
  66   /// Records the shape newShape which was generated from the shape oldShape during a topological
  67   /// construction. As an example, consider the case of a face generated from an edge in
  68   /// construction of a prism.
  69   MODELAPI_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  70     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName,
  71     const int theTag = 1);
  72
  73   /// Records the shape newShape which is a modification of the shape oldShape.
  74   /// As an example, consider the case of a face split or merged in a Boolean operation.
  75   MODELAPI_EXPORT virtual void modified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  76     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName,
  77     const int theTag = 1);
  78
  79   /// Records the shape oldShape which was deleted from the current label.
  80   /// As an example, consider the case of a face removed by a Boolean operation.
  81   MODELAPI_EXPORT virtual void deleted(
  82     const std::shared_ptr<GeomAPI_Shape>& theOldShape, const int theTag = 1);
  83
  84   /// load deleted shapes
  85   MODELAPI_EXPORT virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
  86                                   std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  87                                   const int  theKindOfShape,
  88                                   const int  theTag);
  89   /// load and orient modified shapes
  90   MODELAPI_EXPORT virtual void loadAndOrientModifiedShapes (GeomAlgoAPI_MakeShape* theMS,
  91     std::shared_ptr<GeomAPI_Shape>  theShapeIn, const int  theKindOfShape, const int  theTag,
  92     const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes);
  93   /// load and orient generated shapes
  94   MODELAPI_EXPORT virtual void loadAndOrientGeneratedShapes (GeomAlgoAPI_MakeShape* theMS,
  95     std::shared_ptr<GeomAPI_Shape>  theShapeIn, const int  theKindOfShape,
  96     const int  theTag, const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes);
  97
  98   /// load shapes of the first level (to be used during shape import)
  99   MODELAPI_EXPORT virtual void loadFirstLevel(std::shared_ptr<GeomAPI_Shape> theShape,
 100     const std::string& theName, int&  theTag);
 101
 102   /// load disconnected edges
 103   MODELAPI_EXPORT virtual void loadDisconnectedEdges(std::shared_ptr<GeomAPI_Shape> theShape,
 104     const std::string& theName, int&  theTag);
 105
 106   /// load disconnected vetexes
 107   MODELAPI_EXPORT virtual void loadDisconnectedVertexes(std::shared_ptr<GeomAPI_Shape> theShape,
 108     const std::string& theName,int&  theTag);
 109
 110 protected:
 111   MODELAPI_EXPORT ModelAPI_ResultBody();
 112
 113   ModelAPI_BodyBuilder* myBuilder; /// provide the body processing in naming shape
 114 };
 115
 116 //! Pointer on feature object
 117 typedef std::shared_ptr<ModelAPI_ResultBody> ResultBodyPtr;
 118
 119 #endif