0024428: Implementation of LGPL license
[occt.git] / src / Aspect / Aspect_RectangularGrid.cdl
CommitLineData
b311480e 1-- Created on: 1995-03-02
2-- Created by: Jean-Louis Frenkel
3-- Copyright (c) 1995-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--
973c2be1 8-- This library is free software; you can redistribute it and / or modify it
9-- under the terms of the GNU Lesser General Public version 2.1 as published
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
17class RectangularGrid from Aspect
18inherits Grid from Aspect
19
20uses
21 PlaneAngle, Length from Quantity
22
23raises
24 NegativeValue,NullValue,NumericError from Standard
25
26is
27
28 Create(aXStep, aYStep: Length from Quantity;
29 anXOrigin: Length from Quantity = 0;
30 anYOrigin: Length from Quantity = 0;
31 aFirstAngle: PlaneAngle from Quantity = 0;
32 aSecondAngle: PlaneAngle from Quantity = 0;
33 aRotationAngle: PlaneAngle from Quantity = 0)
34 returns mutable RectangularGrid from Aspect
35 ---Purpose: creates a new grid. By default this grid is not
36 -- active.
37 -- The first angle is given relatively to the horizontal.
38 -- The second angle is given relatively to the vertical.
39 raises NumericError from Standard;
40 ---Warning: raises NumericError from Standard if the two
41 -- networks are parallel.
42
43---Category: grid definition methods
44
45
46 SetXStep(me: mutable; aStep: Length from Quantity)
47 ---Purpose: defines the x step of the grid.
48 raises NegativeValue,NullValue from Standard
49 ---Warning: raises an exception is the step is not strictly positive.
50 is static;
51
52 SetYStep(me: mutable; aStep: Length from Quantity)
53 ---Purpose: defines the y step of the grid.
54 raises NegativeValue,NullValue from Standard
55 ---Warning: raises an exception is the step is not strictly positive.
56 is static;
57
58 SetAngle(me: mutable; anAngle1: PlaneAngle from Quantity;
59 anAngle2: PlaneAngle from Quantity)
60 ---Purpose: defines the angle of the second network
61 -- the fist angle is given relatively to the horizontal.
62 -- the second angle is given relatively to the vertical.
63 raises NumericError from Standard
64 ---Warning: raises NumericError from Standard if the two
65 -- line networks are parallel.
66 is static;
67
68 SetGridValues(me: mutable; XOrigin, YOrigin: Length from Quantity;
69 XStep, YStep: Length from Quantity;
70 RotationAngle: PlaneAngle from Quantity)
71 is static;
72
73---Category: Pick methods
74--
75 Compute(me; X,Y: Length from Quantity; gridX, gridY : out Length from Quantity)
76 ---Purpose: returns the point of the grid the closest to the point X,Y
77 is static;
78
79
80
81---Category: inquire methods
82
83 XStep(me) returns Length from Quantity
84 ---Purpose: returns the x step of the grid.
85 is static;
86
87 YStep(me) returns Length from Quantity
88 ---Purpose: returns the x step of the grid.
89 is static;
90
91 FirstAngle(me) returns PlaneAngle from Quantity
92 ---Purpose: returns the x Angle of the grid, relatively to the horizontal.
93 is static;
94
95 SecondAngle(me) returns PlaneAngle from Quantity
96 ---Purpose: returns the y Angle of the grid, relatively to the vertical.
97 is static;
98
99
100
101
102---Category: private methods.
103
104
105 Init(me: mutable)
106 is redefined static;
107
108 CheckAngle(me;alpha,beta: PlaneAngle from Quantity)
109 returns Boolean from Standard
110 is static private;
111
112fields
113
114 myXStep: Length from Quantity;
115 myYStep: Length from Quantity;
116 myFirstAngle: PlaneAngle from Quantity;
117 mySecondAngle: PlaneAngle from Quantity;
118 a1,b1,c1: Real from Standard;
119 a2,b2,c2: Real from Standard;
120
121
122end RectangularGrid from Aspect;