0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepFill / BRepFill_TrimSurfaceTool.cdl
1 -- Created on: 1994-10-21
2 -- Created by: Bruno DUMORTIER
3 -- Copyright (c) 1994-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
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
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.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 private class TrimSurfaceTool from BRepFill 
18
19         ---Purpose: Compute the Pcurves and  the 3d curves resulting
20           --        of the trimming of a face by an extruded surface.
21
22 uses
23
24     Curve         from Geom2d,
25     Curve         from Geom,
26     Pnt2d         from gp,
27     Face          from TopoDS,
28     Edge          from TopoDS,
29     SequenceOfPnt from TColgp,
30     Shape         from GeomAbs  
31     
32 raises
33     NoSuchObject from Standard
34     
35 is
36
37     Create(Bis   : Curve    from Geom2d;
38            Face1 : Face     from TopoDS;
39            Face2 : Face     from TopoDS;
40            Edge1 : Edge     from TopoDS;
41            Edge2 : Edge     from TopoDS;
42            Inv1  : Boolean  from Standard;
43            Inv2  : Boolean  from Standard)
44     returns TrimSurfaceTool from BRepFill;
45
46
47     IntersectWith(me; EdgeOnF1 : in     Edge          from TopoDS;
48                       EdgeOnF2 : in     Edge          from TopoDS;
49                       Points   : in out SequenceOfPnt from TColgp )
50         ---Purpose: Intersect <Bis>  with the  projection of the edges
51         --          <EdgeOnFi> and returns the intersecting parameters 
52         --          on Bis and on the edges
53         --          P.X() : Parameter on Bis
54         --          P.Y() : Parameter on EdgeOnF1 
55         --          P.Z() : Parameter on EdgeOnF2
56     raises
57         NoSuchObject from Standard
58         ---Purpose: raises if <Edge> is not a edge of Face1 or Face2.
59     is static;
60
61
62     IsOnFace(me; Point : Pnt2d from gp)
63     returns Boolean from Standard
64         ---Purpose: returns True if the Line (P, DZ) intersect the Faces
65     is static;
66
67     ProjOn(me; Point : Pnt2d from gp;
68                Edge  : Edge  from TopoDS)
69     returns Real from Standard
70         ---Purpose: returns the parameter of the  point <Point> on the
71         --          Edge <Edge>, assuming that the point is on the edge.
72     is static;
73
74
75     Project(me;
76             U1, U2           :     Real  from Standard;
77             Curve            : out Curve from Geom;
78             PCurve1, PCurve2 : out Curve from Geom2d;
79             myCont           : out Shape from GeomAbs)
80         ---Purpose: 
81     is static;
82
83 fields
84
85     myFace1       : Face    from TopoDS;
86     myFace2       : Face    from TopoDS;
87     myEdge1       : Edge    from TopoDS;
88     myEdge2       : Edge    from TopoDS;
89     myInv1        : Boolean from Standard;      
90     myInv2        : Boolean from Standard;      
91     myBis         : Curve   from Geom2d;
92     
93 end TrimSurfaceTool;