1 // Copyright (C) 2014-2019 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>
35 class GeomAPI_PlanarEdges;
39 class GeomDataAPI_Point2D;
40 class ModelAPI_Object;
42 /// \class GeomAlgoAPI_ShapeTools
44 /// \brief Useful tools for working with shapes.
45 class GeomAlgoAPI_ShapeTools
48 /// \return the total volume of the solids of the current shape or 0.0 if it can be computed.
49 GEOMALGOAPI_EXPORT static double volume(const std::shared_ptr<GeomAPI_Shape> theShape);
51 /// \return the total area of the faces of the current shape or 0.0 if it can be computed.
52 GEOMALGOAPI_EXPORT static double area(const std::shared_ptr<GeomAPI_Shape> theShape);
54 /// \return the center of mass of the current face.
55 /// The coordinates returned for the center of mass
56 /// are expressed in the absolute Cartesian coordinate system.
57 /// (This function works only for surfaces).
58 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Pnt>
59 centreOfMass(const std::shared_ptr<GeomAPI_Shape> theShape);
61 /// \brief Obtain radius of cylindrical face.
62 /// Return negative value if the face is not a cylinder
63 GEOMALGOAPI_EXPORT static double radius(const std::shared_ptr<GeomAPI_Face>& theCylinder);
65 /// \brief Calculate minimal distance between shapes
66 GEOMALGOAPI_EXPORT static double minimalDistance(const GeomShapePtr& theShape1,
67 const GeomShapePtr& theShape2);
69 /// \brief Combines faces with common edges to shells, or solids to compsolids.
70 /// \param[in] theCompound compound of shapes.
71 /// \param[in] theType type of combine.
72 /// \param[out] theResults resulting shapes.
73 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> combineShapes(
74 const std::shared_ptr<GeomAPI_Shape> theCompound,
75 const GeomAPI_Shape::ShapeType theType, ListOfShape& theResults);
77 /// \brief Groups shapes with shared topology to compounds.
78 /// \param[in] theCompound compound of shapes.
79 /// \return compound of compounds with shared topology.
80 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape>
81 groupSharedTopology(const std::shared_ptr<GeomAPI_Shape> theCompound);
83 /// \brief Check group of shapes has shared sub-shapes of the given type
84 /// \param[in] theShapes list of shapes
85 /// \param[in] theShapeType type of sub-shapes to check
86 /// \return \c true if shared topology exists
87 GEOMALGOAPI_EXPORT static bool hasSharedTopology(const ListOfShape& theShapes,
88 const GeomAPI_Shape::ShapeType theShapeType);
90 /// \brief Calculates bounding box for theShapes
91 /// \return list of eight points.
92 /// \param[in] theShapes list of shapes.
93 /// \param[in] theEnlarge enlarges bounding box size.
94 GEOMALGOAPI_EXPORT static
95 std::list<std::shared_ptr<GeomAPI_Pnt> > getBoundingBox(const ListOfShape& theShapes,
96 const double theEnlarge = 0.0);
98 /// \brief Enlarges or reduces plane to fit bounding box.
99 /// \return plane that fits to bounding box.
100 /// \param[in] thePlane base plane.
101 /// \param[in] thePoints bounding box points (should be eight).
102 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Face> fitPlaneToBox(
103 const std::shared_ptr<GeomAPI_Shape> thePlane,
104 const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints);
106 /// \brief Finds the start and end vertices of theShape. theShape can be of the following type:\n
107 /// Vertex: theV1 and theV2 are the same and equal to theShape;\n
108 /// Edge : theV1 is start and theV2 is end vertex;\n
109 /// Wire : theV1 is start vertex of the first edge, theV2 is end vertex of the last edge. If wire
110 /// contains no edges theV1 and theV2 are nullified.\n
111 /// If none of the above theV1 and theV2 are nullified.
112 GEOMALGOAPI_EXPORT static void findBounds(const std::shared_ptr<GeomAPI_Shape> theShape,
113 std::shared_ptr<GeomAPI_Vertex>& theV1,
114 std::shared_ptr<GeomAPI_Vertex>& theV2);
116 /// \brief Creates faces with holes from wires.
117 /// \param[in] theWires base wires.
118 /// \param[out] theFaces resulting faces.
119 GEOMALGOAPI_EXPORT static void makeFacesWithHoles(const std::shared_ptr<GeomAPI_Pnt> theOrigin,
120 const std::shared_ptr<GeomAPI_Dir> theDirection,
121 const ListOfShape& theWires,
122 ListOfShape& theFaces);
124 /// \brief Return a plane for list of shapes if they are all planar.
125 /// \param[in] theShapes shapes to find plane.
126 /// \return plane where all shapes lie or empty pointer if they not planar.
127 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Pln> findPlane(const ListOfShape& theShapes);
129 /// \brief Checks that vertex/edge is inside face or vertex inside wire.
130 /// \param[in] theSubShape shape that should be inside.
131 /// \param[in] theBaseShape base shape.
132 /// \return true if edge inside the face.
133 GEOMALGOAPI_EXPORT static bool isSubShapeInsideShape(
134 const std::shared_ptr<GeomAPI_Shape> theSubShape,
135 const std::shared_ptr<GeomAPI_Shape> theBaseShape);
137 /// \return true if theShape is valid.
138 GEOMALGOAPI_EXPORT static bool isShapeValid(const std::shared_ptr<GeomAPI_Shape> theShape);
140 /// \return outer wire for face. If theShape has different type returns empty pointer.
141 GEOMALGOAPI_EXPORT static
142 std::shared_ptr<GeomAPI_Shape> getFaceOuterWire(const std::shared_ptr<GeomAPI_Shape> theFace);
144 /// \return true if edge is parallel to face.
145 GEOMALGOAPI_EXPORT static bool isParallel(const std::shared_ptr<GeomAPI_Edge> theEdge,
146 const std::shared_ptr<GeomAPI_Face> theFace);
148 // Computes intersection point between the edge curve and a face surface (only one point, with
149 // preferences to point that belongs to edge and face boundaries.
150 /// \returns null if there is no intersection
151 GEOMALGOAPI_EXPORT static std::list<std::shared_ptr<GeomAPI_Vertex> > intersect(
152 const std::shared_ptr<GeomAPI_Edge> theEdge, const std::shared_ptr<GeomAPI_Face> theFace,
153 const bool thePointsOutsideFace);
155 typedef std::map<std::shared_ptr<GeomAPI_Pnt>,
156 std::pair<std::list<std::shared_ptr<GeomDataAPI_Point2D> >,
157 std::list<std::shared_ptr<ModelAPI_Object> > > > PointToRefsMap;
158 /// \brief Performs the split of the shape by points.
159 /// \param[in] theBaseShape shape that should be divided.
160 /// \param[in] thePoints container of points to split
161 /// \param[out] theShapes container of shapes after split
162 GEOMALGOAPI_EXPORT static void splitShape(const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
163 const PointToRefsMap& thePointsInfo,
164 std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
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_p(const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
171 const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints,
172 std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
174 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> findShape(
175 const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints,
176 const std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
178 #ifdef FEATURE_MULTIROTATION_TWO_DIRECTIONS
179 /// \brief Returns a direction 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);
188 /// \brief Re-approximate a wire to build a single edge
189 GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Edge> wireToEdge(
190 const std::shared_ptr<GeomAPI_Wire>& theWire);
192 /// \brief Get non-composite sub-shapes of the given shape.
193 /// \param[in] theShape shape that should be exploded
194 /// \return list of sub-shapes (vertices, edges, faces, solids)
195 GEOMALGOAPI_EXPORT static ListOfShape getLowLevelSubShapes(const GeomShapePtr& theShape);
197 /// \brief Calculate prism sizes to ensure that it passes through all objects
198 /// \param[in] theObjects objects to be joined/cutted by the prism
199 /// \param[in] theBaseShapes bases of the prism
200 /// \param[in] theDir direction of the prism
201 /// \param[out] theToSize upper offset of the prism
202 /// \param[out] theFromSize lower offset of the prism
203 GEOMALGOAPI_EXPORT static void computeThroughAll(const ListOfShape& theObjects,
204 const ListOfShape& theBaseShapes,
205 const std::shared_ptr<GeomAPI_Dir> theDir,
206 double& theToSize, double& theFromSize);