X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_ShapeExplorer.h;h=44320fa641f122c653fab52a3a437c791394e4cc;hb=8476d5e088f7b1b5a414fa5e33ce99d6131929eb;hp=fac506fd1589fa20393a039e1e4749fe1dcfffbe;hpb=a3508b5b0db5dd5857049f3f046bd628030d9bb9;p=modules%2Fshaper.git diff --git a/src/GeomAPI/GeomAPI_ShapeExplorer.h b/src/GeomAPI/GeomAPI_ShapeExplorer.h index fac506fd1..44320fa64 100644 --- a/src/GeomAPI/GeomAPI_ShapeExplorer.h +++ b/src/GeomAPI/GeomAPI_ShapeExplorer.h @@ -14,21 +14,21 @@ * \ingroup DataModel * \brief This class is used to explore subshapes on shape. */ - class GeomAPI_ShapeExplorer : public GeomAPI_Interface { public: /// Default constructor. Creates an empty explorer, becomes usefull after Init. - GEOMAPI_EXPORT + GEOMAPI_EXPORT GeomAPI_ShapeExplorer(); /** \brief Constructs an explorer to search on theShape, for shapes of type toFind, * that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE, * or if it is the same as, or less complex than the shape toFind it has no effect on the search. - \param[in] toFind shape type to find. - \param[in] toAvoid shape type to avoid. + * \param[in] theShape shape to explore. + * \param[in] toFind shape type to find. + * \param[in] toAvoid shape type to avoid. */ - GEOMAPI_EXPORT + GEOMAPI_EXPORT GeomAPI_ShapeExplorer(const std::shared_ptr& theShape, const GeomAPI_Shape::ShapeType toFind, const GeomAPI_Shape::ShapeType toAvoid = GeomAPI_Shape::SHAPE); @@ -36,36 +36,37 @@ public: /** \brief Resets this explorer. It is initialized to search on theShape, for shapes of type toFind, * that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE, * or if it is the same as, or less complex than the shape toFind it has no effect on the search. - \param[in] toFind shape type to find. - \param[in] toAvoid shape type to avoid. + * \param[in] theShape shape to explore. + * \param[in] toFind shape type to find. + * \param[in] toAvoid shape type to avoid. */ - GEOMAPI_EXPORT + GEOMAPI_EXPORT void init(const std::shared_ptr& theShape, const GeomAPI_Shape::ShapeType toFind, const GeomAPI_Shape::ShapeType toAvoid = GeomAPI_Shape::SHAPE); /// \return true if there are more shapes in the exploration. - GEOMAPI_EXPORT + GEOMAPI_EXPORT bool more() const; /// Moves to the next Shape in the exploration or do nothing if there are no more shapes to explore. - GEOMAPI_EXPORT + GEOMAPI_EXPORT void next(); - /// Returns the current shape in the exploration or empty pointer if this explorer has no more shapes to explore. - GEOMAPI_EXPORT + /// \return the current shape in the exploration or empty pointer if this explorer has no more shapes to explore. + GEOMAPI_EXPORT std::shared_ptr current(); /// Reinitialize the exploration with the original arguments. - GEOMAPI_EXPORT + GEOMAPI_EXPORT void reinit(); - /// Returns the current depth of the exploration. 0 is the shape to explore itself. - GEOMAPI_EXPORT + /// \return the current depth of the exploration. 0 is the shape to explore itself. + GEOMAPI_EXPORT int depth() const; /// Clears the content of the explorer. It will return False on more(). - GEOMAPI_EXPORT + GEOMAPI_EXPORT void clear(); };