#include <GeomAPI_Shape.h>
#include <memory>
#include <GeomAlgoAPI.h>
-//#include <BRepBuilderAPI_MakeShape.hxx>
+
/**\class GeomAlgoAPI_MakeShape
- * \ingroup DataModel
- * \Interface to the root class of all topological shapes constructions
+ * \ingroup DataAlgo
+ * \brief Interface to the root class of all topological shapes constructions
*/
class GeomAlgoAPI_MakeShape : public GeomAPI_Interface
{
- public:
- /// Constructor
+public:
+ /// Constructor
GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape();
-
+ /// Constructor by the already stored builder in the interface
GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(void* theBuilder);
/// Returns a shape built by the shape construction algorithm
GEOMALGOAPI_EXPORT const std::shared_ptr<GeomAPI_Shape> shape() const;
- /// Returns the list of shapes generated from the shape <theShape>
+ /// Returns the list of shapes generated from the shape \a theShape
GEOMALGOAPI_EXPORT virtual void generated(
const std::shared_ptr<GeomAPI_Shape> theShape, ListOfShape& theHistory);
- /// Returns the list of shapes modified from the shape <theShape>
+ /// Returns the list of shapes modified from the shape \a theShape
GEOMALGOAPI_EXPORT virtual void modified(
const std::shared_ptr<GeomAPI_Shape> theShape, ListOfShape& theHistory);
/// Returns whether the shape is an edge
GEOMALGOAPI_EXPORT virtual bool isDeleted(const std::shared_ptr<GeomAPI_Shape> theShape);
-
+ /// Initializes the algorithm by the builder stored in the interface
GEOMALGOAPI_EXPORT void init(void* theMkShape);
protected:
+ /// The resulting shape
std::shared_ptr<GeomAPI_Shape> myShape;
};