b311480e |
1 | -- Created on: 1992-08-26 |
2 | -- Created by: Remi GILET |
3 | -- Copyright (c) 1992-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 | |
17 | class MakeLin2d from gce inherits Root from gce |
18 | |
19 | ---Purpose : This class implements the following algorithms used |
20 | -- to create Lin2d from gp. |
21 | -- |
22 | -- * Create a Lin2d parallel to another and passing |
23 | -- through a point. |
24 | -- * Create a Lin2d parallel to another at the distance |
25 | -- Dist. |
26 | -- * Create a Lin2d passing through 2 points. |
27 | -- * Create a Lin2d from its axis (Ax1 from gp). |
28 | -- * Create a Lin2d from a point and a direction. |
29 | -- * Create a Lin2d from its equation. |
30 | |
31 | uses Pnt2d from gp, |
32 | Lin2d from gp, |
33 | Ax2d from gp, |
34 | Dir2d from gp, |
35 | Real from Standard |
36 | |
37 | raises NotDone from StdFail |
38 | |
39 | is |
40 | |
41 | Create (A : Ax2d from gp) returns MakeLin2d; |
42 | --- Purpose : Creates a line located with A. |
43 | |
44 | Create (P : Pnt2d from gp; |
45 | V : Dir2d from gp) returns MakeLin2d; |
46 | --- Purpose : |
47 | -- <P> is the location point (origin) of the line and |
48 | -- <V> is the direction of the line. |
49 | |
50 | Create (A, B, C : Real) returns MakeLin2d; |
51 | --- Purpose : |
52 | -- Creates the line from the equation A*X + B*Y + C = 0.0 |
53 | -- the status is "NullAxis"if Sqrt(A*A + B*B) <= Resolution from gp. |
54 | |
55 | Create(Lin : Lin2d from gp ; |
56 | Dist : Real from Standard) returns MakeLin2d; |
57 | ---Purpose : Make a Lin2d from gp <TheLin> parallel to another |
58 | -- Lin2d <Lin> at a distance <Dist>. |
59 | -- If Dist is greater than zero the result is on the |
60 | -- right of the Line <Lin>, else the result is on the |
61 | -- left of the Line <Lin>. |
62 | |
63 | Create(Lin : Lin2d from gp; |
64 | Point : Pnt2d from gp) returns MakeLin2d; |
65 | ---Purpose : Make a Lin2d from gp <TheLin> parallel to another |
66 | -- Lin2d <Lin> and passing through a Pnt2d <Point>. |
67 | |
68 | Create(P1 : Pnt2d from gp; |
69 | P2 : Pnt2d from gp) returns MakeLin2d; |
70 | ---Purpose : Make a Lin2d from gp <TheLin> passing through 2 |
71 | -- Pnt2d <P1>,<P2>. |
72 | -- It returns false if <P1> and <P2> are confused. |
73 | -- Warning |
74 | -- If an error occurs (that is, when IsDone returns |
75 | -- false), the Status function returns: |
76 | -- - gce_NullAxis if Sqrt(A*A + B*B) is less |
77 | -- than or equal to gp::Resolution(), or |
78 | -- - gce_ConfusedPoints if points P1 and P2 are coincident. |
79 | |
80 | Value(me) returns Lin2d from gp |
81 | raises NotDone |
82 | is static; |
83 | ---Purpose: Returns the constructed line. |
84 | -- Exceptions StdFail_NotDone if no line is constructed. |
85 | |
86 | Operator(me) returns Lin2d from gp |
87 | is static; |
88 | ---C++: alias "Standard_EXPORT operator gp_Lin2d() const;" |
89 | |
90 | fields |
91 | |
92 | TheLin2d : Lin2d from gp; |
93 | --The solution from gp. |
94 | |
95 | end MakeLin2d; |