Merge remote branch 'origin/gdd/translations'

[modules/geom.git] / src / GEOMImpl / GEOMImpl_IShapesOperations.hxx

diff --git a/src/GEOMImpl/GEOMImpl_IShapesOperations.hxx b/src/GEOMImpl/GEOMImpl_IShapesOperations.hxx
index 002f338e611bd1b2d54a1d88b7fff0279f97088e..795a55d1b0af24729adb3aca433db0cca6aef022 100644 (file)
--- a/src/GEOMImpl/GEOMImpl_IShapesOperations.hxx
+++ b/src/GEOMImpl/GEOMImpl_IShapesOperations.hxx
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2015  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
@@ -388,21 +388,66 @@ 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);
+
  private:
   Handle(GEOM_Object) MakeShape (std::list<Handle(GEOM_Object)>      theShapes,
                                  const Standard_Integer         theObjectType,
@@ -525,6 +570,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