#ifndef GeomAlgoAPI_ShapeTools_H_
#define GeomAlgoAPI_ShapeTools_H_
-#include <GeomAlgoAPI.h>
+#include "GeomAlgoAPI.h"
+
#include <GeomAPI_Pnt.h>
#include <GeomAPI_Shape.h>
+#include <GeomAPI_Vertex.h>
-#include <map>
-
-/** \class GeomAlgoAPI_ShapeTools
- * \ingroup DataAlgo
- * \brief
- */
+/// \class GeomAlgoAPI_ShapeTools
+/// \ingroup DataAlgo
+/// \brief Useful tools for working with shapes.
class GEOMALGOAPI_EXPORT GeomAlgoAPI_ShapeTools
{
public:
/// \return the total volume of the solids of the current shape or 0.0 if it can be computed.
- static double volume(std::shared_ptr<GeomAPI_Shape> theShape);
+ static double volume(const std::shared_ptr<GeomAPI_Shape> theShape);
/// \return the centre of mass of the current face. The coordinates returned for the center of mass
/// are expressed in the absolute Cartesian coordinate system. (This function works only for surfaces).
- static std::shared_ptr<GeomAPI_Pnt> centreOfMass(std::shared_ptr<GeomAPI_Shape> theShape);
-
- /** \brief Combines faces with common edges to shells
- * \param[in] theFacesList list of faces to be combined.
- * \param[out] theShells resulting shells.
- * \param[out] theFreeFaces faces that does not have common edges.
- */
- static void combineFacesToShells(const ListOfShape& theFacesList,
- ListOfShape& theShells,
- ListOfShape& theFreeFaces);
+ static std::shared_ptr<GeomAPI_Pnt> centreOfMass(const std::shared_ptr<GeomAPI_Shape> theShape);
+
+ /// \brief Combines faces with common edges to shells, or solids to compsolids.
+ /// \param[in] theCompound compound of shapes.
+ /// \param[in] theType type of combine.
+ /// \param[out] theCombinedShapes resulting shapes.
+ /// \param[out] theFreeShapes shapes that does not have common subshapes.
+ static void combineShapes(const std::shared_ptr<GeomAPI_Shape> theCompound,
+ const GeomAPI_Shape::ShapeType theType,
+ ListOfShape& theCombinedShapes,
+ ListOfShape& theFreeShapes);
+
+ /// \brief Calculates bounding box for theShapes
+ /// \return list of eight points.
+ /// \param[in] theShapes list of shapes.
+ /// \param[in] theEnlarge enlarges bounding box size.
+ static std::list<std::shared_ptr<GeomAPI_Pnt> > getBoundingBox(const ListOfShape& theShapes, const double theEnlarge = 0.0);
+
+ /// \return infinite plane received from theFace plane.
+ static std::shared_ptr<GeomAPI_Shape> faceToInfinitePlane(const std::shared_ptr<GeomAPI_Shape> theFace);
+
+ /// \brief Enlarges or reduces plane to fit bounding box.
+ /// \return plane that fits to bounding box.
+ /// \param[in] thePlane base plane.
+ /// \param[in] thePoints bounding box points (shoud be eight).
+ static std::shared_ptr<GeomAPI_Shape> fitPlaneToBox(const std::shared_ptr<GeomAPI_Shape> thePlane,
+ const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints);
+
+ /// \brief Finds the start and end vertices of theShape. theShape can be of the following type:\n
+ /// Vertex: theV1 and theV2 are the same and equal to theShape;\n
+ /// Edge : theV1 is start and theV2 is end vertex;\n
+ /// Wire : theV1 is start vertex of the first edge, theV2 is end vertex of the last edge. If wire
+ /// contains no edges theV1 and theV2 are nullified.\n
+ /// If none of the above theV1 and theV2 are nullified.
+ static void findBounds(const std::shared_ptr<GeomAPI_Shape> theShape,
+ std::shared_ptr<GeomAPI_Vertex>& theV1,
+ std::shared_ptr<GeomAPI_Vertex>& theV2);
+
};
#endif
