1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef GeomAlgoAPI_ShapeTools_H_
22 #define GeomAlgoAPI_ShapeTools_H_
24 #include "GeomAlgoAPI.h"
26 #include <GeomAPI_Shape.h>
27 #include <GeomAPI_Vertex.h>
36 class GeomAPI_PlanarEdges;
40 class GeomDataAPI_Point2D;
41 class ModelAPI_Object;
43 /// \class GeomAlgoAPI_ShapeTools
45 /// \brief Useful tools for working with shapes.
46 class GeomAlgoAPI_ShapeTools
49 /// \return the total volume of the solids of the current shape or 0.0 if it can be computed.
50 GEOMALGOAPI_EXPORT static double volume(const std::shared_ptr<GeomAPI_Shape> theShape);
52 /// \return the total area of the faces of the current shape or 0.0 if it can be computed.
53 GEOMALGOAPI_EXPORT static double area(const std::shared_ptr<GeomAPI_Shape> theShape);
55 /// \return the centre of mass of the current face.
56 /// The coordinates returned for the center of mass
57 /// are expressed in the absolute Cartesian coordinate system.
58 /// (This function works only for surfaces).
59 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Pnt>
60 centreOfMass(const std::shared_ptr<GeomAPI_Shape> theShape);
62 /// \brief Obtain radius of cylindrical face.
63 /// Return negative value if the face is not a cylinder
64 GEOMALGOAPI_EXPORT static double radius(const std::shared_ptr<GeomAPI_Face>& theCylinder);
66 /// \brief Calculate minimal distance between shapes
67 GEOMALGOAPI_EXPORT static double minimalDistance(const GeomShapePtr& theShape1,
68 const GeomShapePtr& theShape2);
70 /// \brief Combines faces with common edges to shells, or solids to compsolids.
71 /// \param[in] theCompound compound of shapes.
72 /// \param[in] theType type of combine.
73 /// \param[out] theCombinedShapes resulting shapes.
74 /// \param[out] theFreeShapes shapes that does not have common subshapes.
75 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> combineShapes(
76 const std::shared_ptr<GeomAPI_Shape> theCompound,
77 const GeomAPI_Shape::ShapeType theType,
78 ListOfShape& theCombinedShapes,
79 ListOfShape& theFreeShapes);
81 /// \brief Groups shapes with shared topology to compounds.
82 /// \param[in] theCompound compound of shapes.
83 /// \return compound of compounds with shared topology.
84 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape>
85 groupSharedTopology(const std::shared_ptr<GeomAPI_Shape> theCompound);
87 /// \brief Calculates bounding box for theShapes
88 /// \return list of eight points.
89 /// \param[in] theShapes list of shapes.
90 /// \param[in] theEnlarge enlarges bounding box size.
91 GEOMALGOAPI_EXPORT static
92 std::list<std::shared_ptr<GeomAPI_Pnt> > getBoundingBox(const ListOfShape& theShapes,
93 const double theEnlarge = 0.0);
95 /// \return infinite plane received from theFace plane.
96 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape>
97 faceToInfinitePlane(const std::shared_ptr<GeomAPI_Shape> theFace);
99 /// \brief Enlarges or reduces plane to fit bounding box.
100 /// \return plane that fits to bounding box.
101 /// \param[in] thePlane base plane.
102 /// \param[in] thePoints bounding box points (shoud be eight).
103 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Face> fitPlaneToBox(
104 const std::shared_ptr<GeomAPI_Shape> thePlane,
105 const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints);
107 /// \brief Finds the start and end vertices of theShape. theShape can be of the following type:\n
108 /// Vertex: theV1 and theV2 are the same and equal to theShape;\n
109 /// Edge : theV1 is start and theV2 is end vertex;\n
110 /// Wire : theV1 is start vertex of the first edge, theV2 is end vertex of the last edge. If wire
111 /// contains no edges theV1 and theV2 are nullified.\n
112 /// If none of the above theV1 and theV2 are nullified.
113 GEOMALGOAPI_EXPORT static void findBounds(const std::shared_ptr<GeomAPI_Shape> theShape,
114 std::shared_ptr<GeomAPI_Vertex>& theV1,
115 std::shared_ptr<GeomAPI_Vertex>& theV2);
117 /// \brief Creates faces with holes from wires.
118 /// \param[in] theWires base wires.
119 /// \param[out] theFaces resulting faces.
120 GEOMALGOAPI_EXPORT static void makeFacesWithHoles(const std::shared_ptr<GeomAPI_Pnt> theOrigin,
121 const std::shared_ptr<GeomAPI_Dir> theDirection,
122 const ListOfShape& theWires,
123 ListOfShape& theFaces);
125 /// \brief Return a plane for list of shapes if they are all planar.
126 /// \param[in] theShapes shapes to find plane.
127 /// \return plane where all shapes lie or empty ptr if they not planar.
128 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Pln> findPlane(const ListOfShape& theShapes);
130 /// \brief Checks that vertex/edge is inside face or vertext inside wire.
131 /// \param[in] theSubShape shape that should be inside.
132 /// \param[in] theBaseShape base shape.
133 /// \return true if edge inside the face.
134 GEOMALGOAPI_EXPORT static bool isSubShapeInsideShape(
135 const std::shared_ptr<GeomAPI_Shape> theSubShape,
136 const std::shared_ptr<GeomAPI_Shape> theBaseShape);
138 /// \return true if theShape is valid.
139 GEOMALGOAPI_EXPORT static bool isShapeValid(const std::shared_ptr<GeomAPI_Shape> theShape);
141 /// \return outer wire for face. If theShape has different type returns empty pointer.
142 GEOMALGOAPI_EXPORT static
143 std::shared_ptr<GeomAPI_Shape> getFaceOuterWire(const std::shared_ptr<GeomAPI_Shape> theFace);
145 /// \return true if edge is parallel to face.
146 GEOMALGOAPI_EXPORT static bool isParallel(const std::shared_ptr<GeomAPI_Edge> theEdge,
147 const std::shared_ptr<GeomAPI_Face> theFace);
149 // Computes intersection point between the edge curve and a face surface (only one point, with
150 // preferences to point that belongs to edge and face boundaries.
151 /// \returns null if there is no intersection
152 GEOMALGOAPI_EXPORT static std::list<std::shared_ptr<GeomAPI_Vertex> > intersect(
153 const std::shared_ptr<GeomAPI_Edge> theEdge, const std::shared_ptr<GeomAPI_Face> theFace,
154 const bool thePointsOutsideFace);
156 typedef std::map<std::shared_ptr<GeomAPI_Pnt>,
157 std::pair<std::list<std::shared_ptr<GeomDataAPI_Point2D> >,
158 std::list<std::shared_ptr<ModelAPI_Object> > > > PointToRefsMap;
159 /// \brief Performs the split of the shape by points.
160 /// \param[in] theBaseShape shape that should be splitted.
161 /// \param[in] thePoints container of points to split
162 /// \param[out] theShapes container of shapes after split
163 GEOMALGOAPI_EXPORT static void splitShape(const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
164 const PointToRefsMap& thePointsInfo,
165 std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
167 /// \brief Performs the split of the shape by points.
168 /// \param[in] theBaseShape shape that should be splitted.
169 /// \param[in] thePoints container of points to split
170 /// \param[out] theShapes container of shapes after split
171 GEOMALGOAPI_EXPORT static void splitShape_p(const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
172 const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints,
173 std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
175 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> findShape(
176 const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints,
177 const std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
179 /// \brief Returns a dir from a shape and an axis.
180 /// \param[in] theBaseShape shape whose center of mass serves as the starting point of the dir.
181 /// \param[in] theAxis axis that serves as a direction for the dir
182 /// \return dir that builds from center of mass of the base shape and the axis
183 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Dir> buildDirFromAxisAndShape(
184 const std::shared_ptr<GeomAPI_Shape> theBaseShape,
185 const std::shared_ptr<GeomAPI_Ax1> theAxis);
187 /// \brief Reapproximate a wire to build a single edge
188 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Edge> wireToEdge(
189 const std::shared_ptr<GeomAPI_Wire>& theWire);
191 /// \brief Get non-composite sub-shapes of the given shape.
192 /// \param[in] theShape shape that should be exploded
193 /// \return list of sub-shapes (vertices, edges, faces, solids)
194 GEOMALGOAPI_EXPORT static ListOfShape getLowLevelSubShapes(const GeomShapePtr& theShape);