0023024: Update headers of OCCT files
[occt.git] / src / ApproxInt / ApproxInt_MultiLineTool.cdl
CommitLineData
b311480e 1-- Created on: 1993-03-26
2-- Created by: Laurent BUCHARD
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
7fd59977 21
22generic class MultiLineTool from ApproxInt (TheMultiLine as any;
23 TheMultiMPoint as any)
24
25
26uses
27 Status from Approx,
28 Array1OfPnt from TColgp,
29 Array1OfPnt2d from TColgp,
30 Array1OfVec from TColgp,
31 Array1OfVec2d from TColgp
32
33is
34
35
36 FirstPoint(myclass; ML: TheMultiLine) returns Integer;
37 ---C++:inline
38 ---Purpose: Returns the number of multipoints of the TheMultiLine.
39
40 LastPoint(myclass; ML: TheMultiLine) returns Integer;
41 ---C++:inline
42 ---Purpose: Returns the number of multipoints of the TheMultiLine.
43
44 NbP2d(myclass; ML: TheMultiLine) returns Integer;
45 ---C++:inline
46 ---Purpose: Returns the number of 2d points of a TheMultiLine.
47
48
49 NbP3d(myclass; ML: TheMultiLine) returns Integer;
50 ---C++:inline
51 ---Purpose: Returns the number of 3d points of a TheMultiLine.
52
53
54 Value(myclass; ML: TheMultiLine; MPointIndex: Integer; tabPt: out Array1OfPnt);
55 ---C++:inline
56 ---Purpose: returns the 3d points of the multipoint <MPointIndex>
57 -- when only 3d points exist.
58
59
60 Value(myclass; ML: TheMultiLine; MPointIndex: Integer;
61 tabPt2d: out Array1OfPnt2d from TColgp);
62 ---C++:inline
63 ---Purpose: returns the 2d points of the multipoint <MPointIndex>
64 -- when only 2d points exist.
65
66
67 Value(myclass; ML: TheMultiLine; MPointIndex: Integer;
68 tabPt: out Array1OfPnt from TColgp; tabPt2d: out Array1OfPnt2d);
69 ---C++:inline
70 ---Purpose: returns the 3d and 2d points of the multipoint
71 -- <MPointIndex>.
72
73 Tangency(myclass; ML: TheMultiLine; MPointIndex: Integer; tabV: out Array1OfVec from TColgp)
74 returns Boolean;
75 ---C++:inline
76 ---Purpose: returns the 3d points of the multipoint <MPointIndex>
77 -- when only 3d points exist.
78
79
80 Tangency(myclass; ML: TheMultiLine; MPointIndex: Integer;
81 tabV2d: out Array1OfVec2d from TColgp)
82 returns Boolean;
83 ---C++:inline
84 ---Purpose: returns the 2d tangency points of the multipoint
85 -- <MPointIndex> only when 2d points exist.
86
87
88 Tangency(myclass; ML: TheMultiLine; MPointIndex: Integer;
89 tabV: out Array1OfVec from TColgp; tabV2d: out Array1OfVec2d from TColgp)
90 returns Boolean;
91 ---C++:inline
92 ---Purpose: returns the 3d and 2d points of the multipoint
93 -- <MPointIndex>.
94
95
96--- methods not used but necessary
97
98
99 Curvature(myclass; ML: TheMultiLine; MPointIndex: Integer;
100 tabV: out Array1OfVec from TColgp)
101 returns Boolean;
102 ---C++:inline
103 ---Purpose: returns the 3d curvature of the multipoint <MPointIndex>
104 -- when only 3d points exist.
105
106
107 Curvature(myclass; ML: TheMultiLine; MPointIndex: Integer;
108 tabV2d: out Array1OfVec2d from TColgp)
109 returns Boolean;
110 ---C++:inline
111 ---Purpose: returns the 2d curvature points of the multipoint
112 -- <MPointIndex> only when 2d points exist.
113
114
115 Curvature(myclass; ML: TheMultiLine; MPointIndex: Integer;
116 tabV: out Array1OfVec from TColgp;
117 tabV2d: out Array1OfVec2d from TColgp)
118 returns Boolean;
119 ---C++:inline
120 ---Purpose: returns the 3d and 2d curvature of the multipoint
121 -- <MPointIndex>.
122
123
124
125 MakeMLBetween(myclass; ML: TheMultiLine; I1, I2: Integer;
126 NbPMin: Integer)
127 returns TheMultiLine;
128 ---C++:inline
129 ---Purpose: Is called if WhatStatus returned "PointsAdded".
130
131 WhatStatus(myclass; ML: TheMultiLine; I1, I2: Integer)
132 ---C++:inline
133 returns Status from Approx;
134
135end MultiLineTool;
136