Salome HOME
Issue #1343 Fixes for creating extrusion on vertex
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_MakeShape.h
index 8d6c83aab18d921f9ffdd2747456c4e3111ebe2f..0131da44660d4a454a108377a63d6c352e15c66d 100644 (file)
 #include <list>
 #include <memory>
 
-/** \class GeomAlgoAPI_MakeShape
- *  \ingroup DataAlgo
- *  \brief Interface to the root class of all topological shapes constructions
- */
+/// \class GeomAlgoAPI_MakeShape
+/// \ingroup DataAlgo
+/// \brief Interface to the root class of all topological shapes constructions
 class GeomAlgoAPI_MakeShape : public GeomAPI_Interface
 {
 public:
   /// Builder type enum
   enum BuilderType {
+    Unknown,
     OCCT_BRepBuilderAPI_MakeShape,
     OCCT_BOPAlgo_Builder
   };
 
 public:
-  /** \brief Constructor by builder and builder type.
-   *  \param[in] theBuilder pointer to the builder.
-   *  \param[in] theBuilderType builder type.
-   */
-  GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(void* theBuilder, const BuilderType theBuilderType = OCCT_BRepBuilderAPI_MakeShape);
+  /// \brief Empty constructor.
+  GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape();
+
+  /// \brief Constructor by builder and builder type.
+  /// \param[in] theBuilder pointer to the builder.
+  /// \param[in] theBuilderType builder type.
+  template<class T> explicit GeomAlgoAPI_MakeShape(T* theBuilder, const BuilderType theBuilderType = OCCT_BRepBuilderAPI_MakeShape)
+  : GeomAPI_Interface(theBuilder),
+    myBuilderType(theBuilderType)
+  {
+    initialize();
+  }
+
+  /// \brief Initializes internals.
+  /// \param[in] theBuilder pointer to the builder.
+  /// \param[in] theBuilderType builder type.
+  template<class T> void initialize(T* theBuilder, const BuilderType theBuilderType = OCCT_BRepBuilderAPI_MakeShape)
+  {
+    setImpl(theBuilder);
+    myBuilderType = theBuilderType;
+    initialize();
+  }
 
   /// \return status of builder.
   GEOMALGOAPI_EXPORT bool isDone() const;
@@ -38,49 +55,55 @@ public:
   /// \return a shape built by the shape construction algorithm.
   GEOMALGOAPI_EXPORT virtual const std::shared_ptr<GeomAPI_Shape> shape() const;
 
-  /** \return the list of shapes generated from the shape \a theShape.
-   *  \param[in] theShape base shape.
-   *  \param[out] theHistory generated shapes.
-   */
+  /// \return true if resulting shape is valid.
+  GEOMALGOAPI_EXPORT bool isValid() const;
+
+  /// \return true if resulting shape has volume.
+  GEOMALGOAPI_EXPORT bool hasVolume() const;
+
+  /// \return map of sub-shapes of the result. To be used for History keeping.
+  GEOMALGOAPI_EXPORT std::shared_ptr<GeomAPI_DataMapOfShapeShape> mapOfSubShapes() const;
+
+  /// \return the list of shapes generated from the shape \a theShape.
+  /// \param[in] theShape base shape.
+  /// \param[out] theHistory generated shapes.
   GEOMALGOAPI_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape> theShape,
                                             ListOfShape& theHistory);
 
-  /** \return the list of shapes modified from the shape \a theShape.
-   *  \param[in] theShape base shape.
-   *  \param[out] theHistory modified shapes.
-   */
+  /// \return the list of shapes modified from the shape \a theShape.
+  /// \param[in] theShape base shape.
+  /// \param[out] theHistory modified shapes.
   GEOMALGOAPI_EXPORT virtual void modified(const std::shared_ptr<GeomAPI_Shape> theShape,
                                            ListOfShape& theHistory);
 
-  /** \return true if theShape was deleted.
-   *  \param[in] theShape base shape.
-   */
+  /// \return true if theShape was deleted.
+  /// \param[in] theShape base shape.
   GEOMALGOAPI_EXPORT virtual bool isDeleted(const std::shared_ptr<GeomAPI_Shape> theShape);
 
 protected:
-  /// \brief Default constructor.
-  GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape();
+  /// \brief Sets builder type.
+  /// \param[in] theBuilderType new builder type.
+  void setBuilderType(const BuilderType theBuilderType);
 
-  /** \brief Sets builder type.
-   *  \param[in] theBuilderType new builder type.
-   */
-  GEOMALGOAPI_EXPORT void setBuilderType(const BuilderType theBuilderType);
+  /// \brief Sets status of builder.
+  /// \param[in] theFlag new status.
+  void setDone(const bool theFlag);
 
-  /** \brief Sets status of builder.
-   *  \param[in] theFlag new status.
-   */
-  GEOMALGOAPI_EXPORT void setDone(const bool theFlag);
+  /// \brief Sets result shape.
+  /// \param[in] theShape new shape.
+  void setShape(const std::shared_ptr<GeomAPI_Shape> theShape);
 
-  /** \brief Sets result shape.
-   *  \param[in] theShape new shape.
-   */
-  GEOMALGOAPI_EXPORT void setShape(const std::shared_ptr<GeomAPI_Shape> theShape);
+protected:
+  std::shared_ptr<GeomAPI_DataMapOfShapeShape> myMap; ///< Data map to keep correct orientation of sub-shapes.
+
+private:
+  /// \brief Initializes internals.
+  void initialize();
 
 private:
   GeomAlgoAPI_MakeShape::BuilderType myBuilderType; ///< Type of make shape builder.
   bool myDone; ///< Builder status.
   std::shared_ptr<GeomAPI_Shape> myShape; ///< Resulting shape.
-  std::shared_ptr<GeomAPI_DataMapOfShapeShape> myMap; ///< Data map to keep correct orientation of sub-shapes.
 };
 
 typedef std::list<std::shared_ptr<GeomAlgoAPI_MakeShape> > ListOfMakeShape;