src/BRepOffset/BRepOffset.cdl

   1 -- Created on: 1995-10-12
   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 package BRepOffset
  18
  19         ---Purpose:
  20
  21 uses
  22     MMgt,
  23     Geom,
  24     TopoDS,
  25     TopAbs,
  26     TCollection,
  27     TopTools,
  28     GeomAbs,
  29     BRepAlgo,
  30     BOPAlgo,
  31     BOPDS,
  32     BOPTools
  33
  34 is
  35     enumeration Type is
  36         Concave,
  37         Convex,
  38         Tangent,
  39         FreeBoundary,
  40         Other
  41     end Type;
  42
  43     enumeration Mode is
  44         Skin,
  45         Pipe,
  46         RectoVerso
  47     end Mode;
  48 ---Purpose:
  49 -- Lists the offset modes. These are the following:
  50 -- - BRepOffset_Skin which describes the offset along
  51 --   the surface of a solid, used to obtain a manifold topological space,
  52 -- - BRepOffset_Pipe which describes the offset of a
  53 --   curve, used to obtain a pre-surface,
  54 -- - BRepOffset_RectoVerso which describes the offset
  55 --   of a given surface shell along both sides of the surface.
  56
  57     enumeration Status is
  58         ---Purpose: status of an offset face
  59         --          Good :
  60         --          Reversed : e.g. Offset > Radius of a cylinder
  61         --          Degenerated : e.g. Offset = Radius of a cylinder
  62         --          Unknown : e.g. for a Beziersurf
  63         Good,
  64         Reversed,
  65         Degenerated,
  66         Unknown
  67     end Status;
  68
  69     enumeration Error is
  70         NoError,
  71         OffsetSurfaceFailed,
  72         UnCorrectClosingFace,
  73         ExtentFaceFailed,
  74         RadiusEqualOffset,
  75         UnknownError
  76     end Error;
  77
  78     class MakeOffset;
  79
  80     --class Loop;
  81
  82     class Inter3d;
  83
  84     class Inter2d;
  85
  86     class Offset;
  87
  88     class Analyse;
  89
  90     class MakeLoops;
  91
  92     class Tool;
  93
  94     --class Image;
  95
  96     --class AsDes;
  97
  98
  99     class Interval;
 100
 101     class ListOfInterval instantiates
 102         List from TCollection  (Interval from BRepOffset);
 103
 104     class DataMapOfShapeListOfInterval  instantiates
 105         DataMap from TCollection(Shape           from TopoDS,
 106                                  ListOfInterval  from BRepOffset,
 107                                  ShapeMapHasher  from TopTools );
 108
 109     class DataMapOfShapeOffset instantiates
 110         DataMap from TCollection(Shape           from TopoDS,
 111                                  Offset          from BRepOffset,
 112                                  ShapeMapHasher  from TopTools );
 113
 114     class DataMapOfShapeMapOfShape instantiates
 115         DataMap from TCollection(Shape           from TopoDS,
 116                                  MapOfShape      from TopTools,
 117                                  ShapeMapHasher  from TopTools);
 118
 119
 120     Surface( Surface : in  Surface from Geom;
 121              Offset  : in  Real    from Standard;
 122              Status  : out Status  from BRepOffset)
 123         ---Purpose: returns   the  Offset  surface  computed from  the
 124         --          surface <Surface> at an OffsetDistance <Offset>.
 125         --
 126         --          If possible, this method returns  the real type of
 127         --          the surface ( e.g. An Offset of a plane is a plane).
 128         --
 129         --          If  no particular  case  is detected, the returned
 130         --          surface will have the Type Geom_OffsetSurface.
 131     returns Surface from Geom;
 132
 133 end BRepOffset;