0024750: Replace instantiations of TCollection generic classes by NCollection templat...
[occt.git] / src / ShapeCustom / ShapeCustom_RestrictionParameters.cdl
1 -- Created on: 2000-05-22
2 -- Created by: data exchange team
3 -- Copyright (c) 2000-2014 OPEN CASCADE SAS
4 --
5 -- This file is part of Open CASCADE Technology software library.
6 --
7 -- This library is free software; you can redistribute it and/or modify it under
8 -- the terms of the GNU Lesser General Public License version 2.1 as published
9 -- by the Free Software Foundation, with special exception defined in the file
10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 -- distribution for complete text of the license and disclaimer of any warranty.
12 --
13 -- Alternatively, this file may be used under the terms of Open CASCADE
14 -- commercial license or contractual agreement.
15
16 class RestrictionParameters from ShapeCustom inherits TShared from MMgt
17
18         ---Purpose: This class is axuluary tool which contains parameters for
19         --          BSplineRestriction class.
20
21
22 is
23
24     Create returns RestrictionParameters from ShapeCustom;
25         ---Purpose: Sets default parameters.
26     
27     ---Methods for modifying fields.
28     
29     GMaxDegree(me: mutable) returns Integer;
30         ---C++: inline
31         ---C++: return &
32         ---Purpose: Returns (modifiable) maximal degree of approximation.
33     
34     GMaxSeg(me: mutable) returns Integer;  
35         ---C++: inline
36         ---C++: return &
37         ---Purpose: Returns (modifiable) maximal number of spans of 
38         --          approximation.
39     
40     ConvertPlane (me: mutable) returns Boolean;
41         ---C++: inline
42         ---C++: return &
43         ---Purpose: Sets flag for define if Plane converted to BSpline surface.
44     
45     ConvertBezierSurf(me: mutable) returns Boolean;
46         ---C++: inline
47         ---C++: return &
48         ---Purpose: Sets flag for define if Bezier surface converted to BSpline
49         --          surface.
50     
51     ConvertRevolutionSurf(me: mutable) returns Boolean;
52         ---C++: inline
53         ---C++: return &
54         ---Purpose: Sets flag for define if surface of Revolution converted to 
55         --          BSpline surface.
56     
57     ConvertExtrusionSurf(me: mutable) returns Boolean;
58         ---C++: inline
59         ---C++: return &
60         ---Purpose: Sets flag for define if surface of LinearExtrusion converted
61         --          to BSpline surface.
62     
63     ConvertOffsetSurf(me: mutable) returns Boolean;
64         ---C++: inline
65         ---C++: return &
66         ---Purpose: Sets flag for define if Offset surface converted to BSpline
67         --          surface.
68     
69     ConvertCylindricalSurf(me: mutable) returns Boolean;
70         ---C++: inline
71         ---C++: return &
72         ---Purpose: Sets flag for define if cylindrical surface converted to BSpline
73         --          surface.
74     ConvertConicalSurf(me: mutable) returns Boolean;
75         ---C++: inline
76         ---C++: return &
77         ---Purpose: Sets flag for define if conical surface converted to BSpline
78         --          surface.
79     ConvertToroidalSurf(me: mutable) returns Boolean;
80         ---C++: inline
81         ---C++: return &
82         ---Purpose: Sets flag for define if toroidal surface converted to BSpline
83         --          surface.
84    
85     ConvertSphericalSurf(me: mutable) returns Boolean;
86         ---C++: inline
87         ---C++: return &
88         ---Purpose: Sets flag for define if spherical surface converted to BSpline
89         --          surface.
90     
91    -- ConvertElementarySurf(me: mutable) returns Boolean;
92    --   ---C++: inline
93    --   ---C++: return &
94    --   ---Purpose: Sets flag for define if Offset surface converted to BSpline
95    --   --          surface.
96     
97     SegmentSurfaceMode(me: mutable)returns Boolean;
98         ---C++: inline
99         ---C++: return &
100         ---Purpose: Sets Segment mode for surface. If Segment is True surface is
101         --          approximated in the bondaries of face lying on this surface.
102     
103     ConvertCurve3d(me: mutable) returns Boolean;
104         ---C++: inline
105         ---C++: return &
106         ---Purpose: Sets flag for define if 3d curve converted to BSpline curve.
107     
108     ConvertOffsetCurv3d(me: mutable) returns Boolean;
109         ---C++: inline
110         ---C++: return &
111         ---Purpose: Sets flag for define if Offset curve3d converted to BSpline
112         --          surface.
113     
114     ConvertCurve2d(me: mutable) returns Boolean;
115         ---C++: inline
116         ---C++: return &
117         ---Purpose: Returns (modifiable) flag for define if 2d curve converted 
118         --          to BSpline curve.
119     
120     ConvertOffsetCurv2d(me: mutable) returns Boolean;
121         ---C++: inline
122         ---C++: return &
123         ---Purpose: Returns (modifiable) flag for define if Offset curve2d 
124         --          converted to BSpline surface.
125
126 fields
127
128     myGMaxDegree: Integer from Standard;
129     myGMaxSeg   : Integer from Standard;
130         
131     myConvPlane         : Boolean;
132     --myConvElementarySurf: Boolean;
133     myConvConicalSurf : Boolean;
134     myConvSphericalSurf : Boolean;
135     myConvCylindricalSurf : Boolean;
136     myConvToroidalSurf : Boolean;
137     myConvBezierSurf    : Boolean;
138     myConvRevolSurf     : Boolean;
139     myConvExtrSurf      : Boolean;
140     myConvOffsetSurf    : Boolean;
141     mySegmentSurfaceMode: Boolean;
142     myConvCurve3d       : Boolean;
143     myConvOffsetCurv3d  : Boolean;
144     myConvCurve2d       : Boolean;
145     myConvOffsetCurv2d  : Boolean;
146
147 end RestrictionParameters;