0023024: Update headers of OCCT files
[occt.git] / src / Aspect / Aspect_CircularGrid.cdl
1 -- Created on: 1995-03-17
2 -- Created by: Mister rmi
3 -- Copyright (c) 1995-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 class CircularGrid from Aspect
23
24 inherits Grid from Aspect
25
26
27 uses
28     PlaneAngle, Length from Quantity
29
30 raises 
31     NegativeValue,NullValue,NumericError from Standard
32
33 is 
34
35     Create(aRadiusStep: Length from Quantity;
36                aDivisionNumber: Integer from Standard;
37                XOrigin: Length from Quantity = 0;
38                anYOrigin: Length from Quantity = 0;
39                aRotationAngle: PlaneAngle from Quantity = 0)
40     returns mutable CircularGrid from Aspect;
41     ---Purpose: creates a new grid. By default this grid is not
42     --          active.
43     
44 ---Category: grid definition methods
45
46
47     SetRadiusStep(me: mutable; aStep: Length from Quantity) 
48     ---Purpose: defines the x step of the grid.
49     raises NegativeValue,NullValue from Standard
50     ---Warning: raises an exception if <aStep> is not strictly positive.
51     is static;
52
53     SetDivisionNumber(me: mutable; aNumber: Integer from Standard)
54     ---Purpose: defines the step of the grid.
55     raises NegativeValue,NullValue from Standard
56     ---Warning: raises an exception if <aNumber> is not strictly positive.
57     is static;
58
59     SetGridValues(me: mutable; XOrigin, YOrigin: Length from Quantity;
60                                RadiusStep: Length from Quantity;
61                                DivisionNumber: Integer from Standard;
62                                RotationAngle: PlaneAngle from Quantity)
63     raises NegativeValue,NullValue from Standard
64     ---Warning: raises an exception if <RadiusStep> is not strictly positive.
65     ---Warning: raises an exception if <DivisionNumber> is not strictly positive.
66     is static;
67  
68    
69 ---Category: Pick methods
70 --           
71     Compute(me; X,Y: Length from Quantity; gridX, gridY : out Length from Quantity)
72     ---Purpose: returns the point of the grid the closest to the point X,Y
73     is static;
74     
75
76     
77 ---Category: inquire methods
78
79     RadiusStep(me) returns Length from Quantity
80     ---Purpose: returns the x step of the grid.
81     is static;
82
83     DivisionNumber(me) returns Integer from Standard
84     ---Purpose: returns the x step of the grid.
85     is static;
86     
87 ---Category: private methods.
88
89     
90     Init(me: mutable)
91     is redefined static;
92     
93 fields
94
95     myRadiusStep: Length from Quantity;
96     myDivisionNumber: Integer from Standard;
97     myAlpha: Real from Standard;
98     myA1,myB1: Real from Standard;
99     
100 end CircularGrid from Aspect;