0024662: Removing unused "generic" classes. Part 3
[occt.git] / src / Sweep / Sweep_NumShapeTool.cdl
CommitLineData
b311480e 1-- Created on: 1993-06-02
2-- Created by: Laurent BOURESCHE
3-- Copyright (c) 1993-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
93cb31a6 17class NumShapeTool from Sweep
7fd59977 18
19 ---Purpose: This class provides the indexation and type analysis
20 -- services required by the NumShape Directing Shapes of
21 -- Swept Primitives.
22 --
23
24uses
25 NumShape from Sweep,
26 ShapeEnum from TopAbs,
27 Orientation from TopAbs
28
29raises
30
31 OutOfRange from Standard
32is
33
34 Create(aShape: NumShape from Sweep);
35 ---Purpose: Create a new NumShapeTool with <aShape>. The Tool
36 -- must prepare an indexation for all the subshapes
37 -- of this shape.
38
39 NbShapes(me) returns Integer
40 ---Purpose: Returns the number of subshapes in the shape.
41 is static;
42
43 Index(me; aShape : NumShape from Sweep) returns Integer
44 ---Purpose: Returns the index of <aShape>.
45 is static;
46
47 Shape(me; anIndex : Integer from Standard) returns NumShape from Sweep
48 ---Purpose: Returns the Shape at index anIndex
49 is static;
50
51 Type(me; aShape : NumShape from Sweep) returns ShapeEnum from TopAbs
52 ---Purpose: Returns the type of <aShape>.
53 is static;
54
55 Orientation(me; aShape : NumShape from Sweep)
56 returns Orientation from TopAbs
57 ---Purpose: Returns the orientation of <aShape>.
58 is static;
59
60 HasFirstVertex(me) returns Boolean from Standard
61 ---Purpose: Returns true if there is a First Vertex in the Shape.
62 is static;
63
64 HasLastVertex(me) returns Boolean from Standard
65 ---Purpose: Returns true if there is a Last Vertex in the Shape.
66 is static;
67
68 FirstVertex(me) returns NumShape from Sweep
69 ---Purpose: Returns the first vertex.
70 is static;
71
72 LastVertex(me) returns NumShape from Sweep
73 ---Purpose: Returns the last vertex.
74 is static;
75fields
76
77 myNumShape : NumShape from Sweep;
78
79end NumShapeTool from Sweep;