0022554: Application hangs on selection
[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     -- In some cases this class can raise Standard_ConstructionError and 
14     -- Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.
15 uses
16     Pnt             from gp,
17     Pnt2d           from gp,
18     Projector       from Select3D,
19     Lin             from gp,
20     EntityOwner     from SelectBasics,
21     ListOfBox2d     from SelectBasics,
22     Circle          from Geom,
23     Array1OfPnt     from TColgp,
24     HArray1OfPnt    from TColgp,
25     Array1OfPnt2d   from TColgp,
26     Box2d           from Bnd,
27     Location        from TopLoc,
28     Pnt             from Select3D, 
29     Pnt2d           from Select3D, 
30     Projector       from Select3D,
31     SensitiveEntity from Select3D, 
32     Circle          from Geom
33
34 raises
35     ConstructionError from Standard,
36     OutOfRange from Standard
37
38 is
39     Create (OwnerId      : EntityOwner from SelectBasics;
40             TheCircle    : Circle from Geom;
41             FilledCircle : Boolean = Standard_False;
42             NbOfPoints   : Integer = 6)
43      returns mutable SensitiveCircle;
44         ---Level: Public 
45         ---Purpose: Constructs the sensitive circle object defined by the
46         -- owner OwnerId, the circle Circle, the Boolean
47         -- FilledCircle and the number of points NbOfPoints.
48
49     Create (OwnerId      : EntityOwner from SelectBasics;
50             TheCircle    : Circle from Geom;
51             u1           : Real ;   
52             u2           : Real;
53             FilledCircle : Boolean = Standard_False;
54             NbOfPoints   : Integer = 6)
55      returns mutable SensitiveCircle;
56         ---Level: Public 
57         ---Purpose: Constructs the sensitive arc object defined by the
58         -- owner OwnerId, the circle Circle, the parameters u1
59         -- and u2, the Boolean FilledCircle and the number of points NbOfPoints.
60         -- u1 and u2 define the first and last points of the arc on Circle.
61
62     Create(OwnerId  : EntityOwner from SelectBasics;
63            apolyg3d : HArray1OfPnt   from TColgp;
64        FilledCircle : Boolean from Standard = Standard_False)
65     returns mutable SensitiveCircle;
66         ---Level: Internal 
67         ---Purpose: Constructs the sensitive circle object defined by the
68         -- owner OwnerId, the array of triangles apolyg3d, and the Boolean FilledCircle.
69         -- apolyg3d is an array of consecutive triangles on the
70         -- circle. The triangle i+1 lies on the intersection of the
71         -- tangents to the circle of i and i+2. Note, that the first point of apolyg3d 
72         -- must be equal to the last point of apolyg3d. 
73
74     Create(OwnerId  : EntityOwner from SelectBasics;
75            apolyg3d : Array1OfPnt   from TColgp;
76        FilledCircle : Boolean from Standard = Standard_False)
77     returns mutable SensitiveCircle;
78         ---Purpose: Constructs the sensitive circle object defined by the
79         -- owner OwnerId, the array of points apolyg3d, and the Boolean FilledCircle. 
80         -- If the length of apolyg3d is more then 1, the first point of apolyg3d 
81         -- must be equal to the last point of apolyg3d. 
82
83     Matches(me  :mutable; 
84             X,Y : Real from Standard;
85             aTol: Real from Standard;
86             DMin: out Real from Standard) 
87     returns Boolean
88     is static;
89
90     Matches (me  :mutable; 
91              XMin,YMin,XMax,YMax : Real from Standard;
92              aTol: Real from Standard)
93     returns Boolean
94     is redefined static;
95      
96     Matches (me  :mutable; 
97              Polyline:Array1OfPnt2d from TColgp;
98              aBox:Box2d from Bnd;
99              aTol: Real from Standard) 
100     returns Boolean
101     is redefined virtual;
102         ---Level: Public 
103     
104
105     ComputeDepth(me;EyeLine: Lin from gp) 
106     returns Real from Standard is redefined static;
107     
108     ArrayBounds(me;Low,Up:in out Integer);
109     
110     GetPoint3d(me;rank:Integer) returns Pnt from gp;
111         ---Level: Internal 
112
113     Dump(me; S: in out OStream;FullDump : Boolean from Standard = Standard_True) is redefined virtual; 
114
115     GetConnected(me: mutable; theLocation : Location from TopLoc) 
116     returns SensitiveEntity from Select3D 
117     is redefined virtual; 
118         ---Level: Public 
119         ---Purpose: Returns the copy of this. 
120
121     Project(me: mutable;aProjector: Projector from Select3D) is redefined virtual;
122
123     ComputeCenter3D(me: mutable) is private; 
124         ---Level: Internal 
125         ---Purpose: Computes myCenter3D as the barycenter of points from mypolyg3d
126
127 fields
128
129     myFillStatus    : Boolean;
130     myDetectedIndex : Integer from Standard; -- used for depth...
131     myCenter2D      : Pnt2d from Select3D; -- used for Matches()
132     myCenter3D      : Pnt from Select3D; -- used for Matches()
133     myCircle        : Circle from Geom;
134     mystart         : Real from Standard; -- used for GetConnected() 
135     myend           : Real from Standard; -- used for GetConnected()
136     
137 end SensitiveCircle;
138