Integration of OCCT 6.5.0 from SVN
[occt.git] / src / BRepOffset / BRepOffset.cdl
1 -- File:        BRepOffset.cdl
2 -- Created:     Thu Oct 12 10:59:22 1995
3 -- Author:      Bruno DUMORTIER
4 --              <dub@fuegox>
5 ---Copyright:    Matra Datavision 1995
6
7
8
9 package BRepOffset 
10
11         ---Purpose: 
12
13 uses
14     MMgt,
15     Geom,
16     TopoDS,
17     TopAbs,     
18     TCollection,
19     TopTools,
20     GeomAbs,
21     BRepAlgo
22
23 is
24     enumeration Type is 
25         Concave, 
26         Convex, 
27         Tangent,
28         FreeBoundary,
29         Other
30     end Type;
31     
32     enumeration Mode is 
33         Skin,
34         Pipe,
35         RectoVerso 
36     end Mode;
37 ---Purpose:
38 -- Lists the offset modes. These are the following:
39 -- - BRepOffset_Skin which describes the offset along
40 --   the surface of a solid, used to obtain a manifold topological space,
41 -- - BRepOffset_Pipe which describes the offset of a
42 --   curve, used to obtain a pre-surface,
43 -- - BRepOffset_RectoVerso which describes the offset
44 --   of a given surface shell along both sides of the surface.
45         
46     enumeration Status is 
47         ---Purpose: status of an offset face
48         --          Good : 
49         --          Reversed : e.g. Offset > Radius of a cylinder
50         --          Degenerated : e.g. Offset = Radius of a cylinder
51         --          Unknown : e.g. for a Beziersurf
52         Good,
53         Reversed,
54         Degenerated,
55         Unknown
56     end Status;
57             
58     enumeration Error is
59         NoError,                        
60         OffsetSurfaceFailed,
61         UnCorrectClosingFace,
62         ExtentFaceFailed,
63         RadiusEqualOffset,
64         UnknownError
65     end Error;
66     
67     class MakeOffset;
68         
69     --class Loop;
70     
71     class Inter3d;
72     
73     class Inter2d;
74     
75     class Offset;
76         ---Purpose: This class compute elemenary offset surface.
77         --          Evaluate the offset generated :
78         --               1 - from a face.
79         --               2 - from an edge.
80         --               3 - from a vertex.
81         --               
82
83     class Analyse;
84
85     class MakeLoops;
86     
87     class Tool;
88
89     --class Image;
90     
91     --class AsDes;
92
93
94     class Interval;
95    
96     class ListOfInterval instantiates 
97         List from TCollection  (Interval from BRepOffset);
98     
99     class DataMapOfShapeListOfInterval  instantiates
100         DataMap from TCollection(Shape           from TopoDS,
101                                  ListOfInterval  from BRepOffset,
102                                  ShapeMapHasher  from TopTools );   
103     
104     class DataMapOfShapeOffset instantiates
105         DataMap from TCollection(Shape           from TopoDS,
106                                  Offset          from BRepOffset,
107                                  ShapeMapHasher  from TopTools );   
108                                  
109     class DataMapOfShapeMapOfShape instantiates
110         DataMap from TCollection(Shape           from TopoDS,
111                                  MapOfShape      from TopTools,
112                                  ShapeMapHasher  from TopTools);     
113
114   
115     Surface( Surface : in  Surface from Geom;
116              Offset  : in  Real    from Standard;
117              Status  : out Status  from BRepOffset)
118         ---Purpose: returns   the  Offset  surface  computed from  the
119         --          surface <Surface> at an OffsetDistance <Offset>.
120         --          
121         --          If possible, this method returns  the real type of
122         --          the surface ( e.g. An Offset of a plane is a plane).
123         --          
124         --          If  no particular  case  is detected, the returned
125         --          surface will have the Type Geom_OffsetSurface.
126     returns Surface from Geom;
127
128 end BRepOffset;