X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=idl%2FGEOM_Gen.idl;h=f35c7935e7ed0be5b96fdcaa788e906f96734643;hb=refs%2Ftags%2FV6_7_0rc1;hp=8f90021eb75fdc531bd9e2afb90a426f80fd0fce;hpb=9ef623eadebba11360f4fbad944e0035cb5f7912;p=modules%2Fgeom.git diff --git a/idl/GEOM_Gen.idl b/idl/GEOM_Gen.idl index 8f90021eb..f35c7935e 100644 --- a/idl/GEOM_Gen.idl +++ b/idl/GEOM_Gen.idl @@ -209,7 +209,10 @@ module GEOM { /*! - * \brief Get an entry of the object in GEOM component. + * \brief Get internal (unique) entry of the object in the GEOM component's data tree. + * \note This is not an entry of the data object in SALOME study. + * This is internal function of GEOM component, though it can be used outside it for + appropriate reason (e.g. for unique identification of geometry object). */ string GetEntry(); @@ -715,6 +718,11 @@ module GEOM in double theTrimSize); }; + /*! + * \brief Interface for shapes transforming. + * + * Translation, rotation, scaling, mirroring, offset, projection, recomputing. + */ interface GEOM_ITransformOperations : GEOM_IOperations { /*! @@ -1077,7 +1085,8 @@ module GEOM * \param thePath Wire or Edge along that the object will be translated. * \param theDistance progress of Path (0 = actual location, 1 = end of path location). * \param theCopy is a true or false parameter. true is to create a copy, false to move the object. - * \param theReverse is a true or false parameter. true is to reverse direction, false is to move normal direction. + * \param theReverse is a true or false parameter. True is to reverse + * direction, false is to move normal direction. * \return New GEOM_Object, containing the displaced shape. */ GEOM_Object PositionAlongPath (in GEOM_Object theObject, @@ -1105,7 +1114,6 @@ module GEOM GEOM_Object RecomputeObject (in GEOM_Object theObject); }; - // # GEOM_I3DPrimOperations: /*! * \brief Interface for 3D primitives creation * @@ -1485,9 +1493,49 @@ module GEOM in GEOM_Object thePath, in GEOM_Object theVec); + /*! + * \brief Build a middle path of a pipe-like shape. + * + * The path shape can be a wire or an edge. + * \param theShape It can be closed or unclosed pipe-like shell + * or a pipe-like solid. + * \param theBase1, theBase2 Two bases of the supposed pipe. This + * should be wires or faces of \a theShape. + * \note It is not assumed that exact or approximate copy of \a theShape + * can be obtained by applying existing Pipe operation on the + * resulting "Path" wire taking \a theBase1 as the base - it is not + * always possible; though in some particular cases it might work + * it is not guaranteed. Thus, RestorePath function should not be + * considered as an exact reverse operation of the Pipe. + * \return New GEOM_Object, containing an edge or wire that represent + * source pipe's "path". + */ + GEOM_Object RestorePath (in GEOM_Object theShape, + in GEOM_Object theBase1, + in GEOM_Object theBase2); + + /*! + * \brief Build a middle path of a pipe-like shape. + * + * The path shape can be a wire or an edge. + * \param theShape It can be closed or unclosed pipe-like shell + * or a pipe-like solid. + * \param theBase1, theBase2 Two bases of the supposed pipe. This + * should be lists of edges of \a theShape. + * \note It is not assumed that exact or approximate copy of \a theShape + * can be obtained by applying existing Pipe operation on the + * resulting "Path" wire taking \a theBase1 as the base - it is not + * always possible; though in some particular cases it might work + * it is not guaranteed. Thus, RestorePath function should not be + * considered as an exact reverse operation of the Pipe. + * \return New GEOM_Object, containing an edge or wire that represent + * source pipe's "path". + */ + GEOM_Object RestorePathEdges (in GEOM_Object theShape, + in ListOfGO theBase1, + in ListOfGO theBase2); }; - // # GEOM_IShapesOperations /*! * \brief Interface for Shapes creation: * @@ -3244,8 +3292,9 @@ module GEOM * \param theFileName The file, containing the shape. * \param theFormatName Specify format for the file reading. * Available formats can be obtained with ImportTranslators() method. - * If format 'IGES_SCALE' is used instead 'IGES' length unit will be - * set to 'meter' and result model will be scaled. + * If format 'IGES_SCALE' is used instead of 'IGES' or + * format 'STEP_SCALE' is used instead of 'STEP', + * file length unit will be ignored (set to 'meter') and result model will be scaled. * \return New GEOM_Object, containing the imported shape. */ GEOM_Object ImportFile (in string theFileName, in string theFormatName);