Integration of OCCT 6.5.0 from SVN
[occt.git] / src / IGESConvGeom / IGESConvGeom.cdl
1 -- File:        IGESConvGeom.cdl
2 -- Created:     Thu Sep  1 15:31:13 1994
3 -- Author:      Christian CAILLET
4 --              <cky@anion>
5 ---Copyright:    Matra Datavision 1994
6
7
8 package IGESConvGeom
9
10     ---Purpose : This package is intended to gather geometric conversion which
11     --           are not immediate but can be used for several purposes :
12     --           mainly, standard conversion to and from CasCade geometric and
13     --           topologic data, and adaptations of IGES files as required
14     --           (as replacing Spline entities to BSpline equivalents).
15
16 uses Standard, gp, TColgp, Geom, Geom2d, IGESGeom
17
18 is
19
20     class GeomBuilder;
21     ---Purpose : basic tool to build curves from IGESGeom (arrays of points,
22     --           Transformations, evaluation of points in a datum)
23
24     SplineCurveFromIGES
25         (igesent : SplineCurve from IGESGeom;
26          epscoef, epsgeom : Real;
27          result  : out mutable BSplineCurve from Geom)
28     returns Integer;
29     ---Purpose : Converts a SplineCurve from IGES to a BSplineCurve from CasCade
30     --           <epscoef> gives tolerance to consider coefficient to be nul
31     --           <epsgeom> gives tolerance to consider poles to be equal
32     --           The returned value is a status with these possible values :
33     --           - 0  OK, done
34     --           - 1  the result is not guaranteed to be C0 (with <epsgeom>)
35     --           - 2  SplineType not processed (allowed : max 3)
36     --                (no result produced)
37     --           - 3  error during creation of control points
38     --                (no result produced)
39     --           - 4  polynomial equation is not correct (no result produced)
40     --           - 5  less than one segment (no result produced)
41
42     IncreaseCurveContinuity
43         (curve      : mutable BSplineCurve from Geom;
44          epsgeom    : Real;
45          continuity : Integer = 2)  returns Integer;
46     ---Purpose : Tries to increase curve continuity with tolerance <epsgeom>
47     --           <continuity> is the new desired continuity, can be 1 or 2
48     --           (more than 2 is considered as 2).
49     --           Returns the new maximum continuity obtained on all knots.
50     --           Remark that, for instance with <continuity> = 2, even if not
51     --           all the knots can be passed to C2, all knots which can be are.
52     
53     IncreaseCurveContinuity
54         (curve      : mutable BSplineCurve from Geom2d;
55          epsgeom    : Real;
56          continuity : Integer = 2)  returns Integer;
57
58     SplineSurfaceFromIGES
59         (igesent : SplineSurface from IGESGeom;
60          epscoef, epsgeom : Real;
61          result  : out mutable BSplineSurface from Geom)
62     returns Integer;
63     ---Purpose : Converts a SplineSurface from IGES to a BSplineSurface from CasCade
64     --           <epscoef> gives tolerance to consider coefficient to be nul
65     --           <epsgeom> gives tolerance to consider poles to be equal
66     --           The returned value is a status with these possible values :
67     --           - 0  OK, done
68     --           - 1  the result is not guaranteed to be C0 (with <epsgeom>)
69     --           - 2  degree is not compatible with code boundary type
70     --                (warning) but C0 is OK
71     --           - 3  idem but C0 is not guaranteed (warning)
72     --           - 4  degree has been determined to be nul, either in U or V
73     --                (no result produced)
74     --           - 5  less than one segment in U or V (no result produced)
75
76     IncreaseSurfaceContinuity
77         (surface      : mutable BSplineSurface from Geom;
78          epsgeom    : Real;
79          continuity : Integer = 2)  returns Integer;
80     ---Purpose : Tries to increase Surface continuity with tolerance <epsgeom>
81     --           <continuity> is the new desired continuity, can be 1 or 2
82     --           (more than 2 is considered as 2).
83     --           Returns the new maximum continuity obtained on all knots.
84     --           Remark that, for instance with <continuity> = 2, even if not
85     --           all the knots can be passed to C2, all knots which can be are.
86
87 end IGESConvGeom;