0024624: Lost word in license statement in source files
[occt.git] / src / AppCont / AppCont_TheLineTool.cdl
CommitLineData
b311480e 1-- Created on: 1993-04-22
2-- Created by: Laurent PAINNOT
3-- Copyright (c) 1993-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17deferred generic class TheLineTool from AppCont(MLine as any)
18
19 ---Purpose: Template for desribing a continuous MultiLine.
20 -- The Vectors returned by the methods Tangency are
21 -- the derivative values.
22
23uses
24 Pnt from gp,
25 Pnt2d from gp,
26 Vec from gp,
27 Vec2d from gp,
28 Array1OfPnt from TColgp,
29 Array1OfPnt2d from TColgp,
30 Array1OfVec from TColgp,
31 Array1OfVec2d from TColgp
32
33is
34
35 FirstParameter(myclass; ML: MLine) returns Real;
36 ---Purpose: returns the first parameter of the Line.
37
38 LastParameter(myclass; ML: MLine) returns Real;
39 ---Purpose: returns the last parameter of the Line.
40
41 NbP2d(myclass; ML: MLine) returns Integer;
42 ---Purpose: Returns the number of 2d points of a MLine.
43
44
45 NbP3d(myclass; ML: MLine) returns Integer;
46 ---Purpose: Returns the number of 3d points of a MLine.
47
48
49 Value(myclass; ML: MLine; U: Real; tabPt: out Array1OfPnt);
50 ---Purpose: returns the 3d points of the multipoint <MPointIndex>
51 -- when only 3d points exist.
52
53
54 Value(myclass; ML: MLine; U: Real; tabPt2d: out Array1OfPnt2d);
55 ---Purpose: returns the 2d points of the multipoint <MPointIndex>
56 -- when only 2d points exist.
57
58
59 Value(myclass; ML: MLine; U: Real;
60 tabPt: out Array1OfPnt; tabPt2d: out Array1OfPnt2d);
61 ---Purpose: returns the 3d and 2d points of the multipoint
62 -- <MPointIndex>.
63
64
65 D1(myclass; ML: MLine; U: Real; tabV: out Array1OfVec)
66 returns Boolean;
67 ---Purpose: returns the 3d derivative values of the multipoint
68 -- <MPointIndex> when only 3d points exist.
69
70
71 D1(myclass; ML: MLine; U: Real; tabV2d: out Array1OfVec2d)
72 returns Boolean;
73 ---Purpose: returns the 2d derivative values of the multipoint
74 -- <MPointIndex> only when 2d points exist.
75
76
77 D1(myclass; ML: MLine; U: Real;
78 tabV: out Array1OfVec; tabV2d: out Array1OfVec2d)
79 returns Boolean;
80 ---Purpose: returns the 3d and 2d derivative values of the multipoint
81 -- <MPointIndex>.
82
83
84end TheLineTool;
85