src/TopOpeBRepTool/TopOpeBRepTool_ShapeExplorer.cdl

   1 -- Created on: 1995-07-13
   2 -- Created by: Jean Yves LEBEY
   3 -- Copyright (c) 1995-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 class ShapeExplorer from TopOpeBRepTool
  24
  25 uses
  26
  27     Explorer  from TopExp,
  28     ShapeEnum from TopAbs,
  29     Shape     from TopoDS
  30
  31 is
  32
  33     Create returns ShapeExplorer from TopOpeBRepTool;
  34         ---Purpose: Creates an empty explorer, becomes usefull after Init.
  35
  36     Create(S       : Shape     from TopoDS;
  37            ToFind  : ShapeEnum from TopAbs;
  38            ToAvoid : ShapeEnum from TopAbs = TopAbs_SHAPE)
  39     returns ShapeExplorer from TopOpeBRepTool;
  40         ---Purpose: Creates an Explorer on the Shape <S>.
  41         --
  42         --          <ToFind> is the type of shapes to search.
  43         --              TopAbs_VERTEX, TopAbs_EDGE, ...
  44         --
  45         --          <ToAvoid>   is the type   of shape to  skip in the
  46         --          exploration.   If   <ToAvoid>  is  equal  or  less
  47         --          complex than <ToFind> or if  <ToAVoid> is SHAPE it
  48         --          has no effect on the exploration.
  49         --
  50
  51     Init(me : in out; S       : Shape       from TopoDS;
  52                       ToFind  : ShapeEnum from TopAbs;
  53                       ToAvoid : ShapeEnum from TopAbs = TopAbs_SHAPE)
  54     is static;
  55
  56     More(me) returns Boolean
  57         ---Purpose: Returns  True if  there are   more  shapes in  the
  58         --          exploration.
  59     is static;
  60
  61     Next(me : in out)
  62         ---Purpose: Moves to the next Shape in the exploration.
  63     is static;
  64
  65     Current(me) returns Shape from TopoDS
  66         ---Purpose: Returns the current shape in the exploration.
  67         ---C++: return const &
  68     is static;
  69
  70     -- debug
  71     NbShapes(me) returns Integer from Standard is static;
  72     Index(me) returns Integer from Standard is static;
  73     DumpCurrent(me; OS : in out OStream) returns OStream
  74         ---C++: return &
  75     is static;
  76
  77 fields
  78
  79     myExplorer : Explorer from TopExp;
  80     myIndex    : Integer from Standard;
  81     myNbShapes : Integer from Standard;
  82
  83 end ShapeExplorer from TopOpeBRepTool;
  84