src/BRepOffset/BRepOffset_Offset.cdl

   1 -- Created on: 1995-10-19
   2 -- Created by: Bruno DUMORTIER
   3 -- Copyright (c) 1995-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class Offset from BRepOffset
  18
  19         ---Purpose: class for the creation of Offseting.
  20
  21 uses
  22
  23     Status              from BRepOffset,
  24     Shape               from TopoDS,
  25     Face                from TopoDS,
  26     Edge                from TopoDS,
  27     Vertex              from TopoDS,
  28     ListOfShape         from TopTools,
  29     DataMapOfShapeShape from TopTools,
  30     Shape               from GeomAbs,
  31     JoinType            from GeomAbs
  32
  33 is
  34
  35     Create returns Offset from BRepOffset;
  36
  37     Create( Face   : Face from TopoDS;
  38             Offset : Real from Standard;
  39             OffsetOutside : Boolean from Standard = Standard_True;
  40             JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
  41         ---Purpose:
  42     returns Offset from BRepOffset;
  43
  44     Create( Face    : Face                from TopoDS;
  45             Offset  : Real                from Standard;
  46             Created : DataMapOfShapeShape from TopTools;
  47             OffsetOutside : Boolean from Standard = Standard_True;
  48             JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
  49         ---Purpose: This method will be  called when you want to share
  50         --          the  edges  soon generated  from  an other  face.
  51         --          e.g. when two faces are  tangents the common  edge
  52         --          will generate only one edge ( no pipe).
  53         --
  54         --          The Map  will be fill  as  follow:
  55         --
  56         --          Created(E) = E'
  57         --          with: E  = an edge of <Face>
  58         --                E' = the image of E in the offseting  of
  59         --                     another  face  sharing E  with a
  60         --                     continuity at least G1
  61         --
  62     returns Offset from BRepOffset;
  63
  64     Create( Path      : Edge    from TopoDS;
  65             Edge1     : Edge    from TopoDS;
  66             Edge2     : Edge    from TopoDS;
  67             Offset    : Real    from Standard;
  68             Polynomial: Boolean from Standard = Standard_False;
  69             Tol       : Real    from Standard =  1.0e-4;
  70             Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
  71         ---Purpose:
  72     returns Offset from BRepOffset;
  73
  74     Create( Path      : Edge    from TopoDS;
  75             Edge1     : Edge    from TopoDS;
  76             Edge2     : Edge    from TopoDS;
  77             Offset    : Real    from Standard;
  78             FirstEdge : Edge    from TopoDS;
  79             LastEdge  : Edge    from TopoDS;
  80             Polynomial: Boolean from Standard = Standard_False;
  81             Tol       : Real    from Standard =  1.0e-4;
  82             Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
  83         ---Purpose:
  84     returns Offset from BRepOffset;
  85
  86     Create( Vertex    : Vertex      from TopoDS;
  87             LEdge     : ListOfShape from TopTools;
  88             Offset    : Real        from Standard;
  89             Polynomial: Boolean     from Standard = Standard_False;
  90             Tol       : Real        from Standard =  1.0e-4;
  91             Conti     : Shape       from GeomAbs  =  GeomAbs_C1)
  92         ---Purpose: Tol and Conti are only used if Polynomial is True
  93         --          (Used to perfrom the approximation)
  94     returns Offset from BRepOffset;
  95
  96     Init( me     : in out;
  97           Face   : Face from TopoDS;
  98           Offset : Real from Standard;
  99           OffsetOutside : Boolean from Standard = Standard_True;
 100           JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
 101         ---Purpose:
 102     is static;
 103
 104     Init( me      : in out;
 105           Face    : Face                from TopoDS;
 106           Offset  : Real                from Standard;
 107           Created : DataMapOfShapeShape from TopTools;
 108           OffsetOutside : Boolean from Standard = Standard_True;
 109           JoinType      : JoinType from GeomAbs = GeomAbs_Arc)
 110         ---Purpose:
 111     is static;
 112
 113     Init( me : in out;
 114           Path      : Edge    from TopoDS;
 115           Edge1     : Edge    from TopoDS;
 116           Edge2     : Edge    from TopoDS;
 117           Offset    : Real    from Standard;
 118           Polynomial: Boolean from Standard = Standard_False;
 119           Tol       : Real    from Standard =  1.0e-4;
 120           Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
 121         ---Purpose:
 122     is static;
 123
 124     Init( me : in out;
 125           Path      : Edge    from TopoDS;
 126           Edge1     : Edge    from TopoDS;
 127           Edge2     : Edge    from TopoDS;
 128           Offset    : Real    from Standard;
 129           FirstEdge : Edge    from TopoDS;
 130           LastEdge  : Edge    from TopoDS;
 131           Polynomial: Boolean from Standard = Standard_False;
 132           Tol       : Real    from Standard =  1.0e-4;
 133           Conti     : Shape   from GeomAbs  =  GeomAbs_C1)
 134         ---Purpose:
 135     is static;
 136
 137     Init( me: in out;
 138           Vertex    : Vertex      from TopoDS;
 139           LEdge     : ListOfShape from TopTools;
 140           Offset    : Real        from Standard;
 141           Polynomial: Boolean     from Standard = Standard_False;
 142           Tol       : Real        from Standard =  1.0e-4;
 143           Conti     : Shape       from GeomAbs  =  GeomAbs_C1)
 144         ---Purpose: Tol and Conti are only used if Polynomial is True
 145         --          (Used to perfrom the approximation)
 146     is static;
 147
 148     Init( me     : in out;
 149           Edge   : Edge from TopoDS;
 150           Offset : Real from Standard)
 151         ---Purpose: Only used in Rolling Ball. Pipe on Free Boundary
 152     is static;
 153
 154     InitialShape(me)
 155         ---C++: return const &
 156         ---C++: inline
 157     returns Shape from TopoDS;
 158
 159
 160     Face( me)
 161         ---C++: return const &
 162     returns Face from TopoDS;
 163
 164     Generated(me; Shape : Shape from TopoDS)
 165         ---Purpose:
 166     returns Shape from TopoDS;
 167
 168     Status( me)
 169         ---Purpose:
 170     returns Status from BRepOffset;
 171
 172 fields
 173
 174     myShape  : Shape               from TopoDS;
 175     myStatus : Status              from BRepOffset;
 176     myFace   : Face                from TopoDS;
 177     myMap    : DataMapOfShapeShape from TopTools;
 178
 179 end Offset;