src/Sweep/Sweep_Tool.cdl

   1 -- Created on: 1993-05-26
   2 -- Created by: Laurent BOURESCHE
   3 -- Copyright (c) 1993-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 deferred generic class Tool from Sweep (TheShape as any)
  18
  19     ---Purpose: This  is a signature  class  describing the indexation
  20     --          and type analysis  services required by  the Directing
  21     --          and Generating Shapes of Swept Primitives.
  22     --
  23
  24 uses
  25
  26     ShapeEnum from TopAbs,
  27     Orientation from TopAbs
  28
  29 raises
  30
  31     OutOfRange from Standard
  32
  33 is
  34
  35     Initialize(aShape: TheShape);
  36         ---Purpose: Initialize the tool  with <aShape>.  The IndexTool
  37         --          must prepare an indexation for  all  the subshapes
  38         --          of this shape.
  39
  40     NbShapes(me) returns Integer
  41         ---Purpose: Returns the number of subshapes in the shape.
  42     is deferred;
  43
  44     Index(me; aShape : TheShape) returns Integer
  45         ---Purpose: Returns the index of <aShape>.
  46     is deferred;
  47
  48     Shape(me; anIndex : Integer from Standard) returns TheShape
  49         ---Purpose: Returns the Shape of index anIndex
  50     is deferred;
  51
  52     Type(me; aShape : TheShape) returns ShapeEnum from TopAbs
  53         ---Purpose: Returns the type of <aShape>.
  54     is deferred;
  55
  56     Orientation(me; aShape : TheShape) returns Orientation from TopAbs
  57         ---Purpose: Returns the Orientation of <aShape>.
  58     is deferred;
  59
  60     SetOrientation(me; aShape : in out TheShape; Or : Orientation from TopAbs)
  61         ---Purpose: Set the Orientation of <aShape> with Or.
  62     is deferred;
  63
  64 ------------------------------------------
  65 --- Methods used for Directing Shapes only
  66 ------------------------------------------
  67
  68     HasFirstVertex(me) returns Boolean from Standard
  69         ---Purpose: Returns true if there is a First Vertex in the Shape.
  70     is deferred;
  71
  72     HasLastVertex(me) returns Boolean from Standard
  73         ---Purpose: Returns true if there is a Last Vertex in the Shape.
  74     is deferred;
  75
  76     FirstVertex(me) returns TheShape
  77         ---Purpose: Returns the first vertex.
  78     is deferred;
  79
  80     LastVertex(me) returns TheShape
  81         ---Purpose: Returns the last vertex.
  82     is deferred;
  83
  84 end Tool from Sweep;