src/BOPTools/BOPTools_ShapeSet.cdl

   1 -- Created by: Peter KURNEV
   2 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   3 --
   4 -- The content of this file is subject to the Open CASCADE Technology Public
   5 -- License Version 6.5 (the "License"). You may not use the content of this file
   6 -- except in compliance with the License. Please obtain a copy of the License
   7 -- at http://www.opencascade.org and read it completely before using this file.
   8 --
   9 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  10 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  11 --
  12 -- The Original Code and all software distributed under the License is
  13 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  14 -- Initial Developer hereby disclaims all such warranties, including without
  15 -- limitation, any warranties of merchantability, fitness for a particular
  16 -- purpose or non-infringement. Please see the License for the specific terms
  17 -- and conditions governing the rights and limitations under the License.
  18
  19
  20 class ShapeSet from BOPTools
  21
  22         ---Purpose: Implementation of some formal
  23         --          opereations with a set of shapes
  24
  25 uses
  26     Shape from TopoDS,
  27     Edge from TopoDS,
  28     ShapeEnum from TopAbs,
  29     BaseAllocator from BOPCol,
  30     MapOfOrientedShape from BOPCol,
  31     ListOfShape from BOPCol
  32
  33 --raises
  34
  35 is
  36     Create
  37         returns ShapeSet from BOPTools;
  38     ---C++: alias "virtual ~BOPTools_ShapeSet();"
  39     ---C++: inline
  40
  41     Create (theAllocator: BaseAllocator from BOPCol)
  42         returns ShapeSet from BOPTools;
  43     ---C++: inline
  44
  45     SetShape(me:out;
  46             theS:Shape from TopoDS);
  47     ---C++: inline
  48
  49     Shape(me)
  50          returns Shape from TopoDS;
  51     ---C++: return const &
  52     ---C++: inline
  53
  54     Add(me:out;
  55             theLS:ListOfShape from BOPCol);
  56
  57     Add(me:out;
  58             theShape:Shape from TopoDS);
  59     ---C++: inline
  60
  61     Add(me:out;
  62             theShape:Shape from TopoDS;
  63             theType: ShapeEnum from TopAbs);
  64
  65     AddEdge(me:out;
  66             theEdge:Edge from TopoDS);
  67     ---C++: inline
  68
  69     AddEdges(me:out;
  70             theLS:ListOfShape from BOPCol);
  71
  72     AddEdges(me:out;
  73             theFace:Shape from TopoDS);
  74     ---C++: inline
  75
  76     Subtract(me:out;
  77             theSet:ShapeSet from BOPTools);
  78     ---C++: alias operator -=
  79     ---C++: inline
  80
  81     Clear(me:out);
  82     ---C++: inline
  83
  84     Get(me;
  85             theLS:out ListOfShape from BOPCol);
  86     ---C++: inline
  87
  88     Contains(me;
  89             theSet:ShapeSet from BOPTools)
  90         returns Boolean from Standard;
  91     ---C++: inline
  92
  93
  94 fields
  95     myShape: Shape from TopoDS is protected;
  96     myMap  : MapOfOrientedShape from BOPCol is protected;
  97
  98 end ShapeSet;