1 // Copyright (C) 2007-2022 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef GeomAlgoAPI_Utils_H_
24 #define GeomAlgoAPI_Utils_H_
26 #include "GeomAlgoAPI.h"
28 #include <Precision.hxx>
29 #include <TopoDS_Shape.hxx>
32 namespace GeomAlgoAPI_Utils
35 /// \brief Limit shape tolerance to the given value
37 /// \param theShape shape being fixed
38 /// \param theType topology type which tolerance is to be limited; TopAbs_SHAPE means
39 /// all types of topology
40 /// \param theTolerance expected tolerance value (1e-7 by default)
41 /// \param theCheckGeometry check geometry validity of result
42 /// \return \c true if resulting shape is valid
44 /// \note Resulting tolerance of the shape is not mandatory equal to requested value
45 /// as it might be changed by fixshape operation in order to get valid shape where possible
46 /// \note By default, the result is only checked for topology validity; check of geometry can be done by
47 /// passing \c true to \a theCheckGeometry parameter
49 GEOMALGOAPI_EXPORT bool FixShapeTolerance(TopoDS_Shape& theShape,
50 const TopAbs_ShapeEnum theType,
51 const double theTolerance = Precision::Confusion(),
52 const bool theCheckGeometry = false);
55 /// \brief Limit shape tolerance to the given value
56 /// This is overloaded function, it behaves exactly as previous one
58 GEOMALGOAPI_EXPORT bool FixShapeTolerance(TopoDS_Shape& theShape,
59 const double theTolerance = Precision::Confusion(),
60 const bool theCheckGeometry = false);
63 /// \brief Limit shape tolerance to the given value
64 /// This is overloaded function, it behaves exactly as previous one
66 GEOMALGOAPI_EXPORT bool FixShapeTolerance(TopoDS_Shape& theShape,
67 const bool theCheckGeometry);
70 /// \brief Check shape
72 /// \param theShape input shape object
73 /// \param theCheckGeometry when set to \c true, causes check of underlying geometry
74 /// in addition to the topology
75 /// \return \c true if shape is valid or \c false otherwise
77 GEOMALGOAPI_EXPORT bool CheckShape(TopoDS_Shape& theShape,
78 const bool theCheckGeometry = false);