0022018: Select3D_SensitiveCircle::Matches(): DMin parameter left uninitialized
[occt.git] / src / Select3D / Select3D_SensitiveCircle.cdl
1 -- File:    Select3D_SensitiveCircle.cdl
2 -- Created: Tue Feb  6 11:35:02 1996
3 -- Author:  Robert COUBLANC
4 --      <rob@fidox>
5 ---Copyright:    Matra Datavision 1996
6
7
8
9 class SensitiveCircle from Select3D 
10 inherits SensitivePoly from Select3D
11
12     ---Purpose: A framework to define sensitive 3D arcs and circles. 
13 uses
14     Pnt             from gp,
15     Pnt2d           from gp,
16     Projector       from Select3D,
17     Lin             from gp,
18     EntityOwner     from SelectBasics,
19     ListOfBox2d     from SelectBasics,
20     Circle          from Geom,
21     Array1OfPnt     from TColgp,
22     HArray1OfPnt    from TColgp,
23     Array1OfPnt2d   from TColgp,
24     Box2d           from Bnd,
25     Location        from TopLoc,
26     Pnt             from Select3D, 
27     Pnt2d           from Select3D, 
28     Projector       from Select3D
29
30 is
31     Create (OwnerId      : EntityOwner from SelectBasics;
32             TheCircle    : Circle from Geom;
33             FilledCircle : Boolean = Standard_False;
34             NbOfPoints   : Integer = 6)
35      returns mutable SensitiveCircle;
36         ---Level: Public 
37         ---Purpose: Constructs the sensitive circle object defined by the
38         -- owner OwnerId, the circle Circle, the Boolean
39         -- FilledCircle and the number of points NbOfPoints.
40
41     Create (OwnerId      : EntityOwner from SelectBasics;
42             TheCircle    : Circle from Geom;
43             u1           : Real ;   
44             u2           : Real;
45             FilledCircle : Boolean = Standard_False;
46             NbOfPoints   : Integer = 6)
47      returns mutable SensitiveCircle;
48         ---Level: Public 
49         ---Purpose: Constructs the sensitive arc object defined by the
50         -- owner OwnerId, the circle Circle, the parameters u1
51         -- and u2, the Boolean FilledCircle and the number of points NbOfPoints.
52         -- u1 and u2 define the first and last points of the arc on Circle.
53
54     Create(OwnerId  : EntityOwner from SelectBasics;
55            apolyg3d : HArray1OfPnt   from TColgp;
56        FilledCircle : Boolean from Standard = Standard_False)
57     returns mutable SensitiveCircle;
58         ---Level: Internal 
59         ---Purpose: Constructs the sensitive circle object defined by the
60         -- owner OwnerId, the array of triangles apolyg3d, and the Boolean FilledCircle.
61         -- apolyg3d is an array of consecutive triangles on the
62         -- circle. The triangle i+1 lies on the intersection of the
63         -- tangents to the circle of i and i+2. Note, that the first point of apolyg3d 
64         -- must be equal to the last point of apolyg3d. 
65
66     Create(OwnerId  : EntityOwner from SelectBasics;
67            apolyg3d : Array1OfPnt   from TColgp;
68        FilledCircle : Boolean from Standard = Standard_False)
69     returns mutable SensitiveCircle;
70         ---Purpose: Constructs the sensitive circle object defined by the
71         -- owner OwnerId, the array of points apolyg3d, and the Boolean FilledCircle.
72         -- If the length of apolyg3d is more then 1, the first point of apolyg3d 
73         -- must be equal to the last point of apolyg3d. 
74
75     Matches(me  :mutable; 
76             X,Y : Real from Standard;
77             aTol: Real from Standard;
78             DMin: out Real from Standard) 
79     returns Boolean
80     is static;
81
82     Matches (me  :mutable; 
83              XMin,YMin,XMax,YMax : Real from Standard;
84              aTol: Real from Standard)
85     returns Boolean
86     is redefined static;
87      
88     Matches (me  :mutable; 
89              Polyline:Array1OfPnt2d from TColgp;
90              aBox:Box2d from Bnd;
91              aTol: Real from Standard) 
92     returns Boolean
93     is redefined virtual;
94         ---Level: Public 
95     
96
97     ComputeDepth(me;EyeLine: Lin from gp) 
98     returns Real from Standard is redefined static;
99     
100     ArrayBounds(me;Low,Up:in out Integer);
101     
102     GetPoint3d(me;rank:Integer) returns Pnt from gp;
103         ---Level: Internal 
104
105     Dump(me; S: in out OStream;FullDump : Boolean from Standard = Standard_True) is redefined virtual;
106
107     Project(me: mutable;aProjector: Projector from Select3D) is redefined virtual;
108
109     ComputeCenter3D(me: mutable); 
110         ---Level: Internal 
111         ---Purpose: Computes myCenter3D as the barycenter of points from mypolyg3d
112
113 fields
114
115     myFillStatus    : Boolean;
116     myDetectedIndex : Integer from Standard; -- used for depth...
117     myCenter2D      : Pnt2d from Select3D; -- used for Matches()
118     myCenter3D      : Pnt from Select3D; -- used for Matches()
119     
120 end SensitiveCircle;
121