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