X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGEOMUtils%2FGEOMUtils.hxx;h=5546211fa96e45e176c4a51aaaba2948b805ff4e;hb=46676347f26294f60ec56f5d31abb87bceebf317;hp=48cef6533ce9574f6d287faf718a2e297d241b53;hpb=5a2b52664a2ade723df5940f655a0197075f80e8;p=modules%2Fgeom.git diff --git a/src/GEOMUtils/GEOMUtils.hxx b/src/GEOMUtils/GEOMUtils.hxx index 48cef6533..5546211fa 100644 --- a/src/GEOMUtils/GEOMUtils.hxx +++ b/src/GEOMUtils/GEOMUtils.hxx @@ -1,4 +1,4 @@ -// Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE +// Copyright (C) 2007-2022 CEA/DEN, EDF R&D, OPEN CASCADE // // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS @@ -55,11 +55,43 @@ inline Standard_Boolean IsEqual (const TopoDS_Shape& S1, const TopoDS_Shape& S2) namespace GEOMUtils { + /** + * This enumeration represents comparison conditions. + */ + enum ComparisonCondition { + CC_GT, ///< Greater then + CC_GE, ///< Greater then or equal to + CC_LT, ///< Less then + CC_LE ///< Less then or equal to + }; + typedef std::vector NodeLinks; typedef std::map LevelInfo; typedef std::vector LevelsList; typedef std::map > TreeModel; + /*! + * \brief Compute numerical functor for the shape. + * + * Resulting value can be used to sort out shapes according to some parameter. + * + * Returns a pair of two values (dist, functor) where + * - \a dist is a some value that is computed according to the center of mass of given shape; + * - \a functor is a numerical functor value + * + * The numerical functor is computed according to the shape's topological properties as follows: + * - orientation for vertices + * - length for edges and wires + * - area for faces and shells + * - volume for solids, compounds, compsolids + * + * If \a isOldSorting parameter is set to \c true, for all cases linear properties of the shape + * are used (to support backward compatibility in some methods). By default, this parameter is + * set to \c false. + */ + Standard_EXPORT std::pair ShapeToDouble (const TopoDS_Shape& theShape, + bool isOldSorting = false); + /*! * \brief Get Local Coordinate System, corresponding to the given shape. * @@ -84,7 +116,7 @@ namespace GEOMUtils * \brief Sort shapes in the list by their coordinates. * \param SL The list of shapes to sort. */ - struct CompareShapes : public std::binary_function + struct CompareShapes //: public std::binary_function { CompareShapes (bool isOldSorting) : myIsOldSorting(isOldSorting) {} @@ -183,6 +215,19 @@ namespace GEOMUtils const TopoDS_Shape& theShape2, gp_Pnt& thePnt1, gp_Pnt& thePnt2); + /*! + * \brief Computes normal projection of \a thePoint to \a theFace. + * + * \param thePoint the 3d point + * \param theFace the face shape + * \param theU the output U parameter of the point on the face + * \param theV the output V parameter of the point on the face + * \retval the projection (3d point) if found, throws an exception otherwise + */ + Standard_EXPORT gp_Pnt ProjectPointOnFace(const gp_Pnt& thePoint, + const TopoDS_Shape& theFace, + double& theU, double& theV); + /*! * \brief Returns the point clicked in 3D view. * @@ -220,6 +265,15 @@ namespace GEOMUtils * \return \c true if shape is valid or \c false otherwise */ Standard_EXPORT bool CheckShape( TopoDS_Shape& shape, bool checkGeometry = false ); + + /*! + * \brief Check boolean and partition operations arguments + * + * \param theShape the argument of an operation to be checked + * \return \c true if the argument is valid for a boolean or partition + * operation or \c false otherwise + */ + Standard_EXPORT bool CheckBOPArguments(const TopoDS_Shape &theShape); /*! * \brief Limit shape tolerance to the given value @@ -278,6 +332,77 @@ namespace GEOMUtils */ Standard_EXPORT bool Write( const TopoDS_Shape& shape, const char* fileName ); -}; + + /*! + * \brief Extract single SOLID from COMPSOLID or COMPOUND. + * + * If the argument shape is a COMPOUND or COMPSOLID and there's + * only single simple-shape type inside, this sub-shape is returned as a result; + * otherwise, the shape is not changed. + * + * \param shape compound or compsolid being processed. + * \retval TopoDS_Shape resulting shape + */ + Standard_EXPORT TopoDS_Shape ReduceCompound( const TopoDS_Shape& shape ); + + /*! + * \brief Generate triangulation for the shape. + * + * \param shape shape being meshed + * \param deflection deflection coefficient to be used + * \param forced if \c true, causes generation of mesh regardless it is already present in the shape + */ + Standard_EXPORT void MeshShape( const TopoDS_Shape shape, + double deflection, bool forced = true ); + + /*! + * \brief Get default deflection coefficient used for triangulation + * \return default deflection value + */ + Standard_EXPORT double DefaultDeflection(); + + /** + * \brief Check if the shape is not a closed wire or edge. + * + * This function is used for pipe creation algorithm to test if + * the pipe path is not closed. It returns false if theShape is a wire or + * an edge with coincident end vertices. Otherwise it returns true. + * + * \param theShape the shape to be tested. + * \return true if theShape is not a closed wire or edge. + */ + Standard_EXPORT bool IsOpenPath(const TopoDS_Shape &theShape); + + /** + * This function compares two tolerances. The shape tolerance (the first + * argument) is considered less than the reference tolerance (the second + * argument) if theTolShape < theTolRef - Tolerance(theTolRef). theTolShape is + * considered greater than theTolRef if theTolShape > theTolRef + + * Tolerance(theTolRef). Otherwise these tolerances are equal. + * Tolerance(theTolRef) = theTolRef*DEFAULT_TOLERANCE_TOLERANCE. But this value + * should not be greated than DEFAULT_MAX_TOLERANCE_TOLERANCE. + * + * \param theTolShape the shape tolerance + * \param theTolRef the reference tolerance + * \return -1 if theTolShape is less than theTolRef; 1 if theTolShape is greater + * than theTolRef; 0 if they are equal + */ + Standard_EXPORT int CompareToleranceValues(const double theTolShape, + const double theTolRef); + + /** + * Check if the comarison of tolerances fit the condition. The comparison of + * tolerances is performed using the function CompareToleranceValues. + * + * \param theCondition the condition + * \param theTolShape the shape tolerance + * \param theTolRef the reference tolerance + * \return true if the shape tolerance fits the condition; false otherwise. + */ + Standard_EXPORT bool IsFitCondition(const ComparisonCondition theCondition, + const double theTolShape, + const double theTolRef); + +} #endif