src/BRepTools/BRepTools_Modifier.cdl

   1 -- File:        BRepTools_Modifier.cdl
   2 -- Created:     Thu Aug 25 10:03:36 1994
   3 -- Author:      Jacques GOUSSARD
   4 --              <jag@ecolox>
   5 ---Copyright:    Matra Datavision 1994
   6
   7
   8 class Modifier from BRepTools
   9
  10         ---Purpose:
  11
  12 uses Shape               from TopoDS,
  13      Modification        from BRepTools,
  14      DataMapOfShapeShape from TopTools
  15
  16 raises NullObject   from Standard,
  17        NoSuchObject from Standard
  18
  19 is
  20
  21     Create returns Modifier from BRepTools;
  22         ---Purpose: Creates an empty Modifier.
  23
  24
  25     Create(S: Shape from TopoDS)
  26         returns Modifier from BRepTools;
  27         ---Purpose: Creates a modifier on the shape <S>.
  28
  29
  30     Create(S: Shape from TopoDS; M: Modification from BRepTools)
  31         returns Modifier from BRepTools;
  32         ---Purpose: Creates a modifier on  the shape <S>, and performs
  33         --          the modifications described by <M>.
  34
  35
  36     Init(me: in out; S: Shape from TopoDS)
  37         is static;
  38         ---Purpose: Initializes the modifier with the shape <S>.
  39
  40
  41     Perform(me: in out; M: Modification from BRepTools)
  42         ---Purpose: Performs the modifications described by <M>.
  43         raises NullObject from Standard
  44         -- if the modifier has not been initialized with a shape.
  45         is static;
  46
  47     IsDone(me)
  48
  49         ---Purpose: Returns Standard_True if the modification has
  50         --          been computed successfully.
  51         --
  52         ---C++: inline
  53         returns Boolean from Standard
  54         is static;
  55
  56
  57     ModifiedShape(me; S: Shape from TopoDS)
  58         returns Shape from TopoDS
  59         ---Purpose: Returns the modified shape corresponding to <S>.
  60         ---C++: return const&
  61         ---C++: inline
  62         raises NoSuchObject from Standard
  63                -- if S is not the initial shape or a sub-shape
  64                -- of the initial shape.
  65
  66         is static;
  67
  68
  69     -- private implementation methods
  70
  71     Put(me: in out; S: Shape from TopoDS)
  72
  73         is static private;
  74
  75
  76     Rebuild(me: in out; S: Shape from TopoDS; M: Modification from BRepTools)
  77         returns Boolean from Standard
  78         is static private;
  79
  80
  81 fields
  82
  83     myMap  : DataMapOfShapeShape from TopTools;
  84     myShape: Shape               from TopoDS;
  85     myDone : Boolean             from Standard;
  86
  87 end Modifier;