0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepBlend / BRepBlend_PointOnRst.cdl
1 -- Created on: 1993-12-02
2 -- Created by: Jacques GOUSSARD
3 -- Copyright (c) 1993-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 class PointOnRst from BRepBlend
18
19
20         ---Purpose: Definition of an intersection point between a line
21         --          and a restriction on a surface.
22         --          Such a point is contains geometrical informations (see
23         --          the Value method) and logical informations.
24
25
26 uses Transition from IntSurf,
27      HCurve2d   from Adaptor2d
28      
29 raises DomainError from Standard
30
31 is
32
33
34     Create
35     
36         ---Purpose: Empty constructor.
37
38         returns PointOnRst from BRepBlend;
39
40
41     Create( A: HCurve2d from Adaptor2d; Param: Real from Standard;
42             TLine, TArc: Transition from IntSurf)
43
44         ---Purpose: Creates the PointOnRst on the arc A, at parameter Param,
45         --          with the transition TLine on the walking line, and
46         --          TArc on the arc A.
47
48         returns PointOnRst from BRepBlend;
49
50
51
52     SetArc(me: in out; A: HCurve2d from Adaptor2d; Param: Real from Standard;
53                        TLine, TArc: Transition from IntSurf)
54
55         ---Purpose: Sets the values of a point which is on the arc
56         --          A, at parameter Param.
57
58
59         is static;
60
61
62
63     Arc(me)
64     
65         ---Purpose: Returns the arc of restriction containing the
66         --          vertex.
67
68         returns any HCurve2d from Adaptor2d
69         ---C++: return const&
70         ---C++: inline
71         
72         is static;
73
74
75     TransitionOnLine(me)
76     
77         ---Purpose: Returns the transition of the point on the
78         --          line on surface.
79
80         returns Transition from IntSurf
81         ---C++: return const&
82         ---C++: inline
83         
84         is static;
85
86
87     TransitionOnArc(me)
88     
89         ---Purpose: Returns the transition of the point on the arc
90         --          returned by Arc().
91
92         returns Transition from IntSurf
93         ---C++: return const&
94         ---C++: inline
95         
96         is static;
97
98
99     ParameterOnArc(me)
100     
101         ---Purpose: Returns the parameter of the point on the
102         --          arc returned by the method Arc().
103
104         returns Real from Standard
105         ---C++: inline
106         
107         is static;
108
109
110 fields
111
112     arc       : HCurve2d from Adaptor2d;
113     traline   : Transition from IntSurf;
114     traarc    : Transition from IntSurf;
115     prm       : Real       from Standard;
116
117 end PointOnRst;