src/GEOMAlgo/BlockFix_PeriodicSurfaceModifier.cdl

   1 -- File:        BlockFix_PeriodicSurfaceModifier.cdl
   2 -- Created:     Wed Dec 15 10:03:50 2004
   3 -- Author:      Sergey KUUL
   4 --              <skl@strelox.nnov.matra-dtv.fr>
   5 ---Copyright:   Open CASCADE SA 2004
   6
   7 class PeriodicSurfaceModifier from BlockFix inherits Modification from BRepTools
   8
   9         ---Purpose:
  10
  11 uses
  12     Vertex   from TopoDS,
  13     Edge     from TopoDS,
  14     Face     from TopoDS,
  15     Location from TopLoc,
  16     Shape    from GeomAbs,
  17     Pnt      from gp,
  18     Curve    from Geom,
  19     Curve    from Geom2d,
  20     Surface  from Geom,
  21     IndexedMapOfTransient from TColStd,
  22     DataMapOfShapeInteger from TopTools
  23
  24 is
  25
  26     Create returns mutable PeriodicSurfaceModifier from BlockFix;
  27
  28     SetTolerance(me: mutable; Toler: Real);
  29         ---Purpose: Sets the tolerance for recognition of geometry
  30
  31     NewSurface(me: mutable; F  :     Face     from TopoDS;
  32                             S  : out Surface  from Geom;
  33                             L  : out Location from TopLoc;
  34                             Tol: out Real     from Standard;
  35                             RevWires : out Boolean from Standard;
  36                             RevFace  : out Boolean from Standard)
  37     returns Boolean from Standard;
  38         ---Purpose: Returns Standard_True if the face <F> has  been
  39         --          modified. In this case, <S> is the new geometric
  40         --          support of the face, <L> the new location,  <Tol>
  41         --          the new tolerance.  Otherwise, returns
  42         --          Standard_False, and <S>, <L>, <Tol> are  not
  43         --          significant.
  44
  45     NewCurve(me: mutable; E  :     Edge     from TopoDS;
  46                           C  : out Curve    from Geom;
  47                           L  : out Location from TopLoc;
  48                           Tol: out Real     from Standard)
  49     returns Boolean from Standard;
  50         ---Purpose: Returns Standard_True  if  the edge  <E> has  been
  51         --          modified.  In this case,  <C> is the new geometric
  52         --          support of the  edge, <L> the  new location, <Tol>
  53         --          the         new    tolerance.   Otherwise, returns
  54         --          Standard_False,    and  <C>,  <L>,   <Tol> are not
  55         --          significant.
  56
  57     NewPoint(me: mutable; V  :     Vertex   from TopoDS;
  58                           P  : out Pnt      from gp;
  59                           Tol: out Real     from Standard)
  60     returns Boolean from Standard;
  61         ---Purpose: Returns  Standard_True if the  vertex <V> has been
  62         --          modified.  In this  case, <P> is the new geometric
  63         --          support of the vertex,   <Tol> the new  tolerance.
  64         --          Otherwise, returns Standard_False, and <P>,  <Tol>
  65         --          are not significant.
  66
  67     NewCurve2d(me: mutable; E    :     Edge     from TopoDS;
  68                             F    :     Face     from TopoDS;
  69                             NewE :     Edge     from TopoDS;
  70                             NewF :     Face     from TopoDS;
  71                             C    : out Curve    from Geom2d;
  72                             Tol  : out Real     from Standard)
  73     returns Boolean from Standard;
  74         ---Purpose: Returns Standard_True if  the edge  <E> has a  new
  75         --          curve on surface on the face <F>.In this case, <C>
  76         --          is the new geometric support of  the edge, <L> the
  77         --          new location, <Tol> the new tolerance.
  78         --
  79         --          Otherwise, returns  Standard_False, and <C>,  <L>,
  80         --          <Tol> are not significant.
  81         --
  82         --          <NewE> is the new  edge created from  <E>.  <NewF>
  83         --          is the new face created from <F>. They may be usefull.
  84
  85     NewParameter(me: mutable; V  :     Vertex from TopoDS;
  86                               E  :     Edge   from TopoDS;
  87                               P  : out Real   from Standard;
  88                               Tol: out Real   from Standard)
  89     returns Boolean from Standard;
  90         ---Purpose: Returns Standard_True if the Vertex  <V> has a new
  91         --          parameter on the  edge <E>. In  this case,  <P> is
  92         --          the parameter,    <Tol>  the     new    tolerance.
  93         --          Otherwise, returns Standard_False, and <P>,  <Tol>
  94         --          are not significant.
  95
  96     Continuity(me: mutable; E          : Edge from TopoDS;
  97                             F1,F2      : Face from TopoDS;
  98                             NewE       : Edge from TopoDS;
  99                             NewF1,NewF2: Face from TopoDS)
 100     returns Shape from GeomAbs;
 101         ---Purpose: Returns the  continuity of  <NewE> between <NewF1>
 102         --          and <NewF2>.
 103         --
 104         --          <NewE> is the new  edge created from <E>.  <NewF1>
 105         --          (resp. <NewF2>) is the new  face created from <F1>
 106         --          (resp. <F2>).
 107
 108
 109 fields
 110
 111     myTolerance    : Real;
 112     myMapOfFaces   : DataMapOfShapeInteger from TopTools;
 113     myMapOfSurfaces: IndexedMapOfTransient from TColStd;
 114
 115 end PeriodicSurfaceModifier;