0023024: Update headers of OCCT files
[occt.git] / src / BRepFill / BRepFill_Draft.cdl
1 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
2 --
3 -- The content of this file is subject to the Open CASCADE Technology Public
4 -- License Version 6.5 (the "License"). You may not use the content of this file
5 -- except in compliance with the License. Please obtain a copy of the License
6 -- at http://www.opencascade.org and read it completely before using this file.
7 --
8 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
9 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
10 --
11 -- The Original Code and all software distributed under the License is
12 -- distributed on an "AS IS" basis, without warranty of any kind, and the
13 -- Initial Developer hereby disclaims all such warranties, including without
14 -- limitation, any warranties of merchantability, fitness for a particular
15 -- purpose or non-infringement. Please see the License for the specific terms
16 -- and conditions governing the rights and limitations under the License.
17
18
19
20 class Draft from BRepFill 
21
22 uses 
23     LocationDraft  from  GeomFill, 
24     Dir  from  gp,  
25     Box  from  Bnd,
26     Surface  from  Geom,  
27
28     SectionLaw  from  BRepFill,
29     DraftLaw  from  BRepFill, 
30     TransitionStyle from  BRepFill, 
31     
32     HCurve  from  Adaptor3d, 
33     Shape   from GeomAbs, 
34     Shape   from TopoDS,
35     Shell  from  TopoDS, 
36     Face   from  TopoDS, 
37     Wire    from  TopoDS, 
38     ListOfShape from TopTools, 
39     HArray2OfShape from TopTools 
40      
41 raises   
42   NotDone
43  
44 is    
45   Create(Shape  :  Shape  from  TopoDS; 
46           Dir    :  Dir  from  gp; 
47           Angle  :  Real)  
48      ---Purpose:
49              
50   returns Draft from BRepFill; 
51    
52   SetOptions(me : in out; 
53              Style  :  TransitionStyle  from  BRepFill  =  BRepFill_Right; 
54              AngleMin :  Real  =  0.01; 
55              AngleMax :  Real  =  3.0); 
56      ---Purpose: 
57                        
58   SetDraft(me:  in  out;  IsInternal  :  Boolean  =  Standard_False); 
59      ---Purpose:
60               
61   
62              
63   Perform(me  :  in  out; 
64           LengthMax  :  Real) 
65   is  static;  
66   ---Purpose: 
67              
68   Perform(me  :  in  out; 
69           Surface  : Surface  from  Geom;    
70           KeepInsideSurface  :  Boolean  =  Standard_True) 
71   is  static;  
72    ---Purpose: 
73   
74    
75   Perform(me  :  in  out; 
76           StopShape  : Shape  from  TopoDS; 
77           KeepOutSide  :  Boolean  =  Standard_True) 
78   is  static;   
79   ---Purpose: 
80       
81   IsDone(me) 
82   returns  Boolean;   
83      
84   Shell(me)   
85   ---Purpose: Returns the draft surface 
86   --          To have the complete shape
87   --          you have to use the Shape() methode.         
88   returns  Shell  from  TopoDS    
89   raises  NotDone; 
90    
91   Generated (me: in out; S : Shape from TopoDS)
92         ---Purpose: Returns the  list   of shapes generated   from the
93         --          shape <S>. 
94         ---C++: return const & 
95         ---Level: Public
96   returns ListOfShape from TopTools;
97      
98    Shape(me) 
99    returns  Shape  from  TopoDS;  
100         -- retourne la shape resultat 
101
102    Init(me:in  out; Surf  :  Surface  from  Geom; 
103                     Length  :  Real; 
104                     Box  :  Box  from  Bnd)   
105    is  private;  
106     
107                       
108    BuildShell(me:in  out;  Surf  :  Surface  from  Geom; 
109                            KeepOutSide  :  Boolean  =  Standard_False) 
110    is  private; 
111             
112    Fuse(me:in  out;  S  :  Shape  from  TopoDS;   
113                      KeepOutSide  :  Boolean)  
114    returns  Boolean  is  private; 
115     
116    Sewing(me:  in  out)    
117    returns  Boolean  is  private;
118     
119 fields   
120     myDir   : Dir  from  gp; 
121     myAngle : Real;  
122     angmin,  angmax  :  Real;
123     myTol   : Real;
124     myLoc   : DraftLaw from  BRepFill;  
125     mySec   : SectionLaw  from  BRepFill;    
126     mySections: HArray2OfShape from TopTools; 
127     myFaces   : HArray2OfShape from TopTools;  
128     myGenerated  : ListOfShape from TopTools; 
129      
130     myShape : Shape from  TopoDS; 
131     myTop   : Shape from  TopoDS; 
132     myShell : Shell from  TopoDS; 
133     myWire  : Wire  from  TopoDS; 
134     myCont  : Shape from  GeomAbs; 
135     myStyle : TransitionStyle from  BRepFill; 
136     IsInternal  : Boolean;     
137     myDone  : Boolean;
138 end  Draft;
139                 
140