Salome HOME
Copyright update 2022
[modules/geom.git] / src / GEOMImpl / GEOMImpl_IShapesOperations.hxx
index 002f338e611bd1b2d54a1d88b7fff0279f97088e..f11bd4fc45a24291428f962893590b68691beec9 100644 (file)
@@ -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
 #include "GEOM_IOperations.hxx"
 
 #include "GEOMAlgo_State.hxx"
+#include "GEOMUtils.hxx"
 
 #include <TColStd_HSequenceOfTransient.hxx>
 #include <TColStd_HSequenceOfInteger.hxx>
+#include <TColStd_HArray1OfInteger.hxx>
 
 #include <Geom_Surface.hxx>
 
 #include <list>
+#include <vector>
 
 class GEOM_Engine;
-class Handle(GEOM_Object);
-class Handle(TColStd_HArray1OfInteger);
+class GEOM_Object;
 class TopoDS_Shape;
 
 class GEOMImpl_IShapesOperations : public GEOM_IOperations
@@ -58,7 +60,26 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
     All       = Groups | Fields | SubShapes,
   };
 
-  Standard_EXPORT GEOMImpl_IShapesOperations(GEOM_Engine* theEngine, int theDocID);
+  /**
+   * This enumeration represents an extraction statistics type.
+   */
+  enum ExtractionStatType
+  {
+    EST_Removed,  ///< Removed sub-shapes
+    EST_Modified, ///< Modified sub-shapes
+    EST_Added     ///< Newly created sub-shapes
+  };
+
+  /*!
+   * This structure defines a format of extraction statistics.
+   */
+  struct ExtractionStat
+  {
+    ExtractionStatType          type;    ///< Type of extraction statistics.
+    std::list<Standard_Integer> indices; ///< Shape indices touched by this type of modification.
+  };
+
+  Standard_EXPORT GEOMImpl_IShapesOperations(GEOM_Engine* theEngine);
   Standard_EXPORT ~GEOMImpl_IShapesOperations();
 
   Standard_EXPORT Handle(GEOM_Object) MakeEdge (Handle(GEOM_Object) thePoint1,
@@ -255,9 +276,9 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
     * \param theShape - the shape to explore
     * \param theShapeType - type of sub-shape of theShape
     * \param theTopLeftPoint - top left quadrangle corner
-    * \param theTopRigthPoint - top right quadrangle corner
+    * \param theTopRightPoint - top right quadrangle corner
     * \param theBottomLeftPoint - bottom left quadrangle corner
-    * \param theBottomRigthPoint - bottom right quadrangle corner
+    * \param theBottomRightPoint - bottom right quadrangle corner
     * \param theState - required state
     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
    */
@@ -265,9 +286,9 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
     GetShapesOnQuadrangle (const Handle(GEOM_Object)& theShape,
                            const Standard_Integer     theShapeType,
                            const Handle(GEOM_Object)& theTopLeftPoint,
-                           const Handle(GEOM_Object)& theTopRigthPoint,
+                           const Handle(GEOM_Object)& theTopRightPoint,
                            const Handle(GEOM_Object)& theBottomLeftPoint,
-                           const Handle(GEOM_Object)& theBottomRigthPoint,
+                           const Handle(GEOM_Object)& theBottomRightPoint,
                            const GEOMAlgo_State       theState);
 
   /*!
@@ -275,9 +296,9 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
     * \param theShape - the shape to explore
     * \param theShapeType - type of sub-shape of theShape
     * \param theTopLeftPoint - top left quadrangle corner
-    * \param theTopRigthPoint - top right quadrangle corner
+    * \param theTopRightPoint - top right quadrangle corner
     * \param theBottomLeftPoint - bottom left quadrangle corner
-    * \param theBottomRigthPoint - bottom right quadrangle corner
+    * \param theBottomRightPoint - bottom right quadrangle corner
     * \param theState - required state
     * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
    */
@@ -285,9 +306,9 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
     GetShapesOnQuadrangleIDs (const Handle(GEOM_Object)& theShape,
                               const Standard_Integer     theShapeType,
                               const Handle(GEOM_Object)& theTopLeftPoint,
-                              const Handle(GEOM_Object)& theTopRigthPoint,
+                              const Handle(GEOM_Object)& theTopRightPoint,
                               const Handle(GEOM_Object)& theBottomLeftPoint,
-                              const Handle(GEOM_Object)& theBottomRigthPoint,
+                              const Handle(GEOM_Object)& theBottomRightPoint,
                               const GEOMAlgo_State       theState);
 
   Standard_EXPORT Handle(GEOM_Object) GetShapesOnCylinderOld (Handle(GEOM_Object)    theShape,
@@ -309,6 +330,10 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
   Standard_EXPORT Handle(GEOM_Object) GetInPlaceByHistory (Handle(GEOM_Object) theShapeWhere,
                                                            Handle(GEOM_Object) theShapeWhat);
 
+  Standard_EXPORT void GetInPlaceMap (Handle(GEOM_Object)                 theShapeWhere,
+                                      Handle(GEOM_Object)                 theShapeWhat,
+                                      std::vector< std::vector< int > > & theResVec);
+
   /*!
    * \brief Searches a shape equal to theWhat in the context of theWhere
    * \param theShapeWhere - a context shap
@@ -388,21 +413,102 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
                                        const Standard_Integer theShapeType,
                                        GEOMAlgo_State theState);
 
+  /*!
+   * \brief Resize the input edge with the new Min and Max parameters.
+   * The input edge parameters range is [0, 1]. If theMin parameter is
+   * negative, the input edge is extended, otherwise it is shrinked by
+   * theMin parameter. If theMax is greater than 1, the edge is extended,
+   * otherwise it is shrinked by theMax parameter
+   * \param theEdge the input edge to be resized
+   * \param theMin the minimal parameter value
+   * \param theMax the maximal parameter value
+   * \retval Handle(GEOM_Object) - newly created edge
+   */
   Standard_EXPORT Handle(GEOM_Object)
-                            ExtendEdge(const Handle(GEOM_Object) &theEdge,
+                            ExtendEdge(const Handle(GEOM_Object)theEdge,
                                        const Standard_Real        theMin,
                                        const Standard_Real        theMax);
 
+  /*!
+   * \brief Resize the input face with the new UMin, UMax, VMin and VMax
+   * parameters. The input face U and V parameters range is [0, 1]. If
+   * theUMin parameter is negative, the input face is extended, otherwise
+   * it is shrinked along U direction by theUMin parameter. If theUMax is
+   * greater than 1, the face is extended, otherwise it is shrinked along
+   * U direction by theUMax parameter. So as for theVMin, theVMax and
+   * V direction of the input face.
+   * \param theFace the input face to be resized
+   * \param theUMin the minimal U parameter value
+   * \param theUMax the maximal U parameter value
+   * \param theVMin the minimal V parameter value
+   * \param theVMax the maximal V parameter value
+   * \retval Handle(GEOM_Object) - newly created face
+   */
   Standard_EXPORT Handle(GEOM_Object)
-                            ExtendFace(const Handle(GEOM_Object) &theFace,
+                            ExtendFace(const Handle(GEOM_Object)theFace,
                                        const Standard_Real        theUMin,
                                        const Standard_Real        theUMax,
                                        const Standard_Real        theVMin,
                                        const Standard_Real        theVMax);
-
+  
+  /*!
+   * \brief Make a surface from a face. This function takes some face as
+   * input parameter and creates new GEOM_Object, i.e. topological shape
+   * by extracting underlying surface of the source face and limiting it
+   * by the Umin, Umax, Vmin, Vmax parameters of the source face (in the
+   * parametrical space).
+   * \param theFace the input face
+   * \retval Handle(GEOM_Object) - newly created face
+   */
   Standard_EXPORT Handle(GEOM_Object)
                    MakeSurfaceFromFace(const Handle(GEOM_Object) &theFace);
 
+  /*!
+   * \brief Explode a shape into edges sorted in a row from a starting point.
+   * \param theShape - the shape to be exploded on edges.
+   * \param theStartPoint - the starting point.
+   * \return Ordered list of edges sorted in a row from a starting point.
+   */
+  Standard_EXPORT Handle(TColStd_HSequenceOfTransient)
+    GetSubShapeEdgeSorted (const Handle(GEOM_Object) &theShape,
+                           const Handle(GEOM_Object) &theStartPoint);
+
+  /*!
+   * \brief Return the list of subshapes that satisfies a certain tolerance
+   * criterion. The user defines the type of shapes to be returned, the
+   * condition and the tolerance value. The operation is defined for
+   * faces, edges and vertices only. E.g. for theShapeType FACE, theCondition
+   * CC_GT and theTolerance 1.e-7 this method returns all faces of theShape
+   * that have tolerances greater then 1.e7.
+   *
+   * \param theShape the shape to be exploded
+   * \param theShapeType the type of shapes to be returned. Can have the
+   *        values FACE, EDGE and VERTEX only.
+   * \param theCondition the condition type.
+   * \param theTolerance the tolerance filter.
+   * \return the list of shapes that satisfy the conditions.
+   */
+  Standard_EXPORT Handle(TColStd_HSequenceOfTransient) GetSubShapesWithTolerance
+                     (const Handle(GEOM_Object)            &theShape,
+                      const Standard_Integer                theShapeType,
+                      const GEOMUtils::ComparisonCondition  theCondition,
+                      const Standard_Real                   theTolerance);
+
+  /*!
+   * \brief Return the shape that is constructed from theShape without
+   * extracted sub-shapes from the input list.
+   *
+   * \param theShape the original shape.
+   * \param theSubShapeIDs the list of sub-shape IDs to be extracted from
+   *        the original shape.
+   * \param theStats the operation statistics. Output parameter.
+   * \return the shape without extracted sub-shapes.
+   */
+  Standard_EXPORT Handle(GEOM_Object) MakeExtraction
+                     (const Handle(GEOM_Object)              &theShape,
+                      const Handle(TColStd_HArray1OfInteger) &theSubShapeIDs,
+                      std::list<ExtractionStat>              &theStats);
+
  private:
   Handle(GEOM_Object) MakeShape (std::list<Handle(GEOM_Object)>      theShapes,
                                  const Standard_Integer         theObjectType,
@@ -471,9 +577,9 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
    * \param theShape - the shape to explore
    * \param theShapeType - type of sub-shape of theShape
    * \param theTopLeftPoint - top left quadrangle corner
-   * \param theTopRigthPoint - top right quadrangle corner
+   * \param theTopRightPoint - top right quadrangle corner
    * \param theBottomLeftPoint - bottom left quadrangle corner
-   * \param theBottomRigthPoint - bottom right quadrangle corner
+   * \param theBottomRightPoint - bottom right quadrangle corner
    * \param theState - required state
    * \retval Handle(TColStd_HSequenceOfInteger) - IDs of found sub-shapes
    */
@@ -481,9 +587,9 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
     getShapesOnQuadrangleIDs (const Handle(GEOM_Object)& theShape,
                               const Standard_Integer     theShapeType,
                               const Handle(GEOM_Object)& theTopLeftPoint,
-                              const Handle(GEOM_Object)& theTopRigthPoint,
+                              const Handle(GEOM_Object)& theTopRightPoint,
                               const Handle(GEOM_Object)& theBottomLeftPoint,
-                              const Handle(GEOM_Object)& theBottomRigthPoint,
+                              const Handle(GEOM_Object)& theBottomRightPoint,
                               const GEOMAlgo_State       theState);
 
   /*!
@@ -525,6 +631,16 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
                        const Handle(TColStd_HSequenceOfInteger)& theShapeIDs,
                        TCollection_AsciiString &                 theShapeEntries);
 
+  /*!
+   * \brief Explode a shape into edges sorted in a row from a starting point.
+   * \param theShape - the shape to be exploded on edges.
+   * \param theStartPoint - the starting point.
+   * \return Ordered list of edges sorted in a row from a starting point.
+   */
+  Handle(TColStd_HSequenceOfInteger) getSubShapeEdgeSortedIDs
+                                (const Handle(GEOM_Object) &theShape,
+                                 const Handle(GEOM_Object) &theStartPoint);
+
   /*!
    * \brief Select the object created last
    * \param theObj1 - Object 1