1 // Copyright (C) 2014-2020 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 email : webmaster.salome@opencascade.com
20 #ifndef GeomAlgoAPI_ShapeTools_H_
21 #define GeomAlgoAPI_ShapeTools_H_
23 #include "GeomAlgoAPI.h"
25 #include <GeomAPI_Shape.h>
26 #include <GeomAPI_Vertex.h>
37 class GeomAPI_PlanarEdges;
41 class GeomDataAPI_Point2D;
42 class ModelAPI_Object;
44 /// \class GeomAlgoAPI_ShapeTools
46 /// \brief Useful tools for working with shapes.
47 class GeomAlgoAPI_ShapeTools
50 /// \return the total volume of the solids of the current shape or 0.0 if it can be computed.
51 GEOMALGOAPI_EXPORT static double volume(const std::shared_ptr<GeomAPI_Shape> theShape);
53 /// \return the total area of the faces of the current shape or 0.0 if it can be computed.
54 GEOMALGOAPI_EXPORT static double area(const std::shared_ptr<GeomAPI_Shape> theShape);
56 /// \return the center of mass of the current face.
57 /// The coordinates returned for the center of mass
58 /// are expressed in the absolute Cartesian coordinate system.
59 /// (This function works only for surfaces).
60 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Pnt>
61 centreOfMass(const std::shared_ptr<GeomAPI_Shape> theShape);
63 /// \brief Obtain radius of cylindrical face.
64 /// Return negative value if the face is not a cylinder
65 GEOMALGOAPI_EXPORT static double radius(const std::shared_ptr<GeomAPI_Face>& theCylinder);
67 /// \brief Calculate minimal distance between shapes
68 GEOMALGOAPI_EXPORT static double minimalDistance(const GeomShapePtr& theShape1,
69 const GeomShapePtr& theShape2);
70 GEOMALGOAPI_EXPORT static double minimalDistance(const GeomShapePtr& theShape1,
71 const GeomShapePtr& theShape2, std::array<double, 3> & fromShape1To2);
73 /// \brief Combines faces with common edges to shells, or solids to compsolids.
74 /// \param[in] theCompound compound of shapes.
75 /// \param[in] theType type of combine.
76 /// \param[out] theResults resulting shapes.
77 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> combineShapes(
78 const std::shared_ptr<GeomAPI_Shape> theCompound,
79 const GeomAPI_Shape::ShapeType theType, ListOfShape& theResults);
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 Check group of shapes has shared sub-shapes of the given type
88 /// \param[in] theShapes list of shapes
89 /// \param[in] theShapeType type of sub-shapes to check
90 /// \return \c true if shared topology exists
91 GEOMALGOAPI_EXPORT static bool hasSharedTopology(const ListOfShape& theShapes,
92 const GeomAPI_Shape::ShapeType theShapeType);
94 /// \brief Calculates bounding box for theShapes
95 /// \return list of eight points.
96 /// \param[in] theShapes list of shapes.
97 /// \param[in] theEnlarge enlarges bounding box size.
98 GEOMALGOAPI_EXPORT static
99 std::list<std::shared_ptr<GeomAPI_Pnt> > getBoundingBox(const ListOfShape& theShapes,
100 const double theEnlarge = 0.0);
102 /// \brief Enlarges or reduces plane to fit bounding box.
103 /// \return plane that fits to bounding box.
104 /// \param[in] thePlane base plane.
105 /// \param[in] thePoints bounding box points (should be eight).
106 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Face> fitPlaneToBox(
107 const std::shared_ptr<GeomAPI_Shape> thePlane,
108 const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints);
110 /// \brief Finds the start and end vertices of theShape. theShape can be of the following type:\n
111 /// Vertex: theV1 and theV2 are the same and equal to theShape;\n
112 /// Edge : theV1 is start and theV2 is end vertex;\n
113 /// Wire : theV1 is start vertex of the first edge, theV2 is end vertex of the last edge. If wire
114 /// contains no edges theV1 and theV2 are nullified.\n
115 /// If none of the above theV1 and theV2 are nullified.
116 GEOMALGOAPI_EXPORT static void findBounds(const std::shared_ptr<GeomAPI_Shape> theShape,
117 std::shared_ptr<GeomAPI_Vertex>& theV1,
118 std::shared_ptr<GeomAPI_Vertex>& theV2);
120 /// \brief Creates faces with holes from wires.
121 /// \param[in] theWires base wires.
122 /// \param[out] theFaces resulting faces.
123 GEOMALGOAPI_EXPORT static void makeFacesWithHoles(const std::shared_ptr<GeomAPI_Pnt> theOrigin,
124 const std::shared_ptr<GeomAPI_Dir> theDirection,
125 const ListOfShape& theWires,
126 ListOfShape& theFaces);
128 /// \brief Return a plane for list of shapes if they are all planar.
129 /// \param[in] theShapes shapes to find plane.
130 /// \return plane where all shapes lie or empty pointer if they not planar.
131 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Pln> findPlane(const ListOfShape& theShapes);
133 /// \brief Checks that vertex/edge is inside face or vertex inside wire.
134 /// \param[in] theSubShape shape that should be inside.
135 /// \param[in] theBaseShape base shape.
136 /// \return true if edge inside the face.
137 GEOMALGOAPI_EXPORT static bool isSubShapeInsideShape(
138 const std::shared_ptr<GeomAPI_Shape> theSubShape,
139 const std::shared_ptr<GeomAPI_Shape> theBaseShape);
141 /// \return true if theShape is valid.
142 GEOMALGOAPI_EXPORT static bool isShapeValid(const std::shared_ptr<GeomAPI_Shape> theShape);
144 /// \return outer wire for face. If theShape has different type returns empty pointer.
145 GEOMALGOAPI_EXPORT static
146 std::shared_ptr<GeomAPI_Shape> getFaceOuterWire(const std::shared_ptr<GeomAPI_Shape> theFace);
148 /// \return \c true if edges are tangent in the specified point
149 GEOMALGOAPI_EXPORT static bool isTangent(const std::shared_ptr<GeomAPI_Edge> theEdge1,
150 const std::shared_ptr<GeomAPI_Edge> theEdge2,
151 const std::shared_ptr<GeomAPI_Vertex> theTgPoint);
153 /// \return true if edge is parallel to face.
154 GEOMALGOAPI_EXPORT static bool isParallel(const std::shared_ptr<GeomAPI_Edge> theEdge,
155 const std::shared_ptr<GeomAPI_Face> theFace);
157 /// Computes intersection point between the edge curve and a face surface (only one point, with
158 /// preferences to point that belongs to edge and face boundaries.
159 /// \returns null if there is no intersection
160 GEOMALGOAPI_EXPORT static std::list<std::shared_ptr<GeomAPI_Vertex> > intersect(
161 const std::shared_ptr<GeomAPI_Edge> theEdge, const std::shared_ptr<GeomAPI_Face> theFace);
163 typedef std::map<std::shared_ptr<GeomAPI_Pnt>,
164 std::pair<std::list<std::shared_ptr<GeomDataAPI_Point2D> >,
165 std::list<std::shared_ptr<ModelAPI_Object> > > > PointToRefsMap;
166 /// \brief Performs the split of the shape by points.
167 /// \param[in] theBaseShape shape that should be divided.
168 /// \param[in] thePoints container of points to split
169 /// \param[out] theShapes container of shapes after split
170 GEOMALGOAPI_EXPORT static void splitShape(const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
171 const PointToRefsMap& thePointsInfo,
172 std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
174 /// \brief Performs the split of the shape by points.
175 /// \param[in] theBaseShape shape that should be divided.
176 /// \param[in] thePoints container of points to split
177 /// \param[out] theShapes container of shapes after split
178 GEOMALGOAPI_EXPORT static void splitShape_p(const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
179 const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints,
180 std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
182 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> findShape(
183 const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints,
184 const std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
186 #ifdef FEATURE_MULTIROTATION_TWO_DIRECTIONS
187 /// \brief Returns a direction from a shape and an axis.
188 /// \param[in] theBaseShape shape whose center of mass serves as the starting point of the dir.
189 /// \param[in] theAxis axis that serves as a direction for the dir
190 /// \return dir that builds from center of mass of the base shape and the axis
191 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Dir> buildDirFromAxisAndShape(
192 const std::shared_ptr<GeomAPI_Shape> theBaseShape,
193 const std::shared_ptr<GeomAPI_Ax1> theAxis);
196 /// \brief Re-approximate a wire to build a single edge
197 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Edge> wireToEdge(
198 const std::shared_ptr<GeomAPI_Wire>& theWire);
200 /// \brief Get non-composite sub-shapes of the given shape.
201 /// \param[in] theShape shape that should be exploded
202 /// \return list of sub-shapes (vertices, edges, faces, solids)
203 GEOMALGOAPI_EXPORT static ListOfShape getLowLevelSubShapes(const GeomShapePtr& theShape);
205 /// \brief Calculate prism sizes to ensure that it passes through all objects
206 /// \param[in] theObjects objects to be joined/cutted by the prism
207 /// \param[in] theBaseShapes bases of the prism
208 /// \param[in] theDir direction of the prism
209 /// \param[out] theToSize upper offset of the prism
210 /// \param[out] theFromSize lower offset of the prism
211 GEOMALGOAPI_EXPORT static void computeThroughAll(const ListOfShape& theObjects,
212 const ListOfShape& theBaseShapes,
213 const std::shared_ptr<GeomAPI_Dir> theDir,
214 double& theToSize, double& theFromSize);