0023024: Update headers of OCCT files
[occt.git] / src / AppDef / AppDef_MyLineTool.cdl
1 -- Created on: 1993-01-20
2 -- Created by: Laurent PAINNOT
3 -- Copyright (c) 1993-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23
24
25 class MyLineTool from AppDef
26
27 uses MultiLine     from AppDef,
28      Pnt           from gp,
29      Pnt2d         from gp,
30      Vec           from gp,
31      Vec2d         from gp,
32      Array1OfPnt   from TColgp,
33      Array1OfPnt2d from TColgp,
34      Array1OfVec   from TColgp,
35      Array1OfVec2d from TColgp,
36      Status        from Approx
37
38 is
39     
40     
41     FirstPoint(myclass; ML: MultiLine) returns Integer;
42         ---Purpose: Returns the first index of multipoints of the MultiLine.
43
44
45     LastPoint(myclass; ML: MultiLine) returns Integer;
46         ---Purpose: Returns the last index of multipoints of the MultiLine.
47
48
49
50     NbP2d(myclass; ML: MultiLine) returns Integer;
51         ---Purpose: Returns the number of 2d points of a MultiLine.
52
53
54     NbP3d(myclass; ML: MultiLine) returns Integer;
55         ---Purpose: Returns the number of 3d points of a MultiLine.
56
57
58     Value(myclass; ML: MultiLine; MPointIndex: Integer; 
59           tabPt: out Array1OfPnt);
60         ---Purpose: returns the 3d points of the multipoint <MPointIndex>
61         --          when only 3d points exist.
62
63
64     Value(myclass; ML: MultiLine; MPointIndex: Integer; 
65           tabPt2d: out Array1OfPnt2d);
66         ---Purpose: returns the 2d points of the multipoint <MPointIndex>
67         --          when only 2d points exist.
68
69
70     Value(myclass; ML: MultiLine; MPointIndex: Integer; 
71           tabPt: out Array1OfPnt; tabPt2d: out Array1OfPnt2d);
72         ---Purpose: returns the 3d and 2d points of the multipoint 
73         --          <MPointIndex>.
74
75
76     Tangency(myclass; ML: MultiLine; MPointIndex: Integer; 
77              tabV: out Array1OfVec) returns Boolean;
78         ---Purpose: returns the 3d points of the multipoint <MPointIndex>
79         --          when only 3d points exist.
80
81
82     Tangency(myclass; ML: MultiLine; MPointIndex: Integer; 
83           tabV2d: out Array1OfVec2d) returns Boolean;
84         ---Purpose: returns the 2d tangency points of the multipoint 
85         --          <MPointIndex> only when 2d points exist.
86
87
88     Tangency(myclass; ML: MultiLine; MPointIndex: Integer; 
89              tabV: out Array1OfVec; tabV2d: out Array1OfVec2d)
90     returns Boolean;
91         ---Purpose: returns the 3d and 2d points of the multipoint 
92         --          <MPointIndex>.
93
94
95     Curvature(myclass; ML: MultiLine; MPointIndex: Integer; 
96              tabV: out Array1OfVec) returns Boolean;
97         ---Purpose: returns the 3d curvatures of the multipoint <MPointIndex>
98         --          when only 3d points exist.
99
100
101     Curvature(myclass; ML: MultiLine; MPointIndex: Integer; 
102           tabV2d: out Array1OfVec2d) returns Boolean;
103         ---Purpose: returns the 2d curvatures of the multipoint 
104         --          <MPointIndex> only when 2d points exist.
105
106
107     Curvature(myclass; ML: MultiLine; MPointIndex: Integer; 
108              tabV: out Array1OfVec; tabV2d: out Array1OfVec2d)
109     returns Boolean;
110         ---Purpose: returns the 3d and 2d curvatures of the multipoint 
111         --          <MPointIndex>.
112
113
114
115     WhatStatus(myclass; ML: MultiLine; I1, I2: Integer) 
116     returns Status from Approx;
117         ---Purpose:  returns NoPointsAdded
118     
119     MakeMLBetween(myclass; ML: MultiLine; I1, I2: Integer;
120                   NbPMin: Integer) 
121     returns MultiLine;
122         ---Purpose: Is never called in the algorithms.
123         --          Nothing is done.
124         ---C++: return &
125
126
127 end MyLineTool;