0022627: Change OCCT memory management defaults
[occt.git] / src / IntSurf / IntSurf_PathPointTool.cdl
1 -- File:        PathPointTool.cdl
2 -- Created:     Fri Sep 25 16:41:41 1992
3 -- Author:      Jacques GOUSSARD
4 --              <jag@sdsun2>
5 ---Copyright:    Matra Datavision 1992
6
7
8 class PathPointTool from IntSurf
9
10 uses Pnt       from gp,
11      Vec       from gp,
12      Dir2d     from gp,
13      PathPoint from IntSurf
14
15 raises OutOfRange          from Standard,
16        UndefinedDerivative from StdFail
17
18
19
20 is
21
22
23     Value3d(myclass; PStart: PathPoint from IntSurf)
24     
25         ---Purpose: Returns the 3d coordinates of the starting point.
26
27         returns Pnt from gp;
28         
29         ---C++: inline
30
31
32     Value2d(myclass; PStart: PathPoint from IntSurf;
33                      U, V: out Real from Standard);
34     
35         ---Purpose: Returns the <U, V> parameters which are associated 
36         --          with <P>
37         --          it's the parameters which start the marching algorithm
38
39         ---C++: inline
40
41
42     IsPassingPnt(myclass; PStart: PathPoint from IntSurf)
43     
44         ---Purpose: Returns True if the point is a point on a non-oriented
45         --          arc, which means that the intersection line does not
46         --          stop at such a point but just go through such a point.
47         --          IsPassingPnt is True when IsOnArc is True 
48
49         returns Boolean from Standard;
50
51         ---C++: inline
52
53
54     IsTangent(myclass; PStart: PathPoint from IntSurf )
55     
56         ---Purpose: Returns True if the surfaces are tangent at this point.
57         --          IsTangent can be True when IsOnArc is True
58         --          if IsPassingPnt is True and IsTangent is True,this point
59         --          is a stopped point.
60
61         returns Boolean from Standard;
62
63         ---C++: inline
64
65
66     Direction3d(myclass; PStart: PathPoint from IntSurf)
67     
68         ---Purpose: returns the tangent at the intersection in 3d space
69         --          associated to <P>
70         --         an exception is raised if IsTangent is true.
71
72         returns Vec from gp
73
74         ---C++: inline
75
76         raises UndefinedDerivative from StdFail;
77
78
79     Direction2d(myclass; PStart: PathPoint from IntSurf)
80     
81         ---Purpose: returns the tangent at the intersection in the
82         --          parametric space of the parametrized surface.This tangent
83         --          is associated to the value2d
84         --          la tangente a un sens signifiant (indique le sens de chemin
85         --          ement)
86         --          an exception is raised if IsTangent is true.
87
88         returns Dir2d from gp
89
90         ---C++: inline
91
92         raises UndefinedDerivative from StdFail;
93
94
95     Multiplicity(myclass; PStart: PathPoint from IntSurf)
96     
97         ---Purpose: Returns the multiplicity of the point i-e 
98         --          the number of auxillar parameters associated to the
99         --          point which the principal parameters are given by Value2d 
100
101         returns Integer from Standard;
102
103         ---C++: inline
104
105
106     Parameters(myclass; PStart: PathPoint from IntSurf;
107                         Mult: Integer from Standard;
108                         U, V: out Real from Standard) 
109                
110         ---Purpose: Parametric coordinates associated to the multiplicity.
111         --          An exception is raised if Mult<=0 or Mult>multiplicity.
112
113         ---C++: inline
114
115         raises OutOfRange from Standard;
116
117
118 end PathPointTool;