0895a03eb83e774928300cc6fe2892e0a8263c81
[occt.git] / src / Select3D / Select3D_SensitiveCurve.cdl
1 -- Created on: 1995-03-10
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 -- Modified on july 97 by ROB : Field HArray instead Of ArrayOfPnt3D
22 --                      (connected entities)
23
24
25 class SensitiveCurve   from Select3D 
26 inherits SensitivePoly from Select3D
27
28     ---Purpose: A framework to define a sensitive 3D curve.
29     -- In some cases this class can raise Standard_ConstructionError and 
30     -- Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.
31
32 uses
33     Pnt             from gp,
34     Pnt2d           from gp,
35     Projector       from Select3D,
36     Lin             from gp,
37     EntityOwner     from SelectBasics,
38     ListOfBox2d     from SelectBasics,
39     Curve           from Geom,
40     Array1OfPnt     from TColgp,
41     Array1OfPnt2d   from TColgp,
42     HArray1OfPnt     from TColgp,
43     Box2d           from Bnd,
44     Location                 from TopLoc, 
45     SensitiveEntity   from Select3D
46
47 raises
48     ConstructionError from Standard,
49     OutOfRange from Standard
50 is
51
52
53     Create (OwnerId      : EntityOwner from SelectBasics;
54             TheCurve     : Curve from Geom;
55             MaxPoints    : Integer = 17)
56      returns mutable SensitiveCurve;
57         ---Level: Public 
58         ---Purpose: Constructs a sensitive curve object defined by the
59         -- owner OwnerId, the curve TheCurve, and the
60         -- maximum number of points on the curve: MaxPoints.
61
62     Create (OwnerId      : EntityOwner from SelectBasics;
63             ThePoints    : HArray1OfPnt from TColgp)
64      returns mutable SensitiveCurve;
65         ---Level: Public 
66         ---Purpose: Constructs a sensitive curve object defined by the
67         -- owner OwnerId and the set of points ThePoints.
68         
69     Create (OwnerId      : EntityOwner from SelectBasics;
70             ThePoints    : Array1OfPnt from TColgp)
71      returns mutable SensitiveCurve;
72         ---Level: Public 
73         ---Purpose: Creation of Sensitive Curve from Points.
74         --          Warning : This Method should disappear in the next version...
75   
76     Matches(me  :mutable; 
77             X,Y : Real from Standard;
78             aTol: Real from Standard;
79             DMin: out Real from Standard) 
80     returns Boolean
81     is  redefined static;
82
83     Matches (me  :mutable; 
84              XMin,YMin,XMax,YMax : Real from Standard;
85              aTol: Real from Standard)
86     returns Boolean
87     is static;
88      
89     Matches (me  :mutable; 
90              Polyline:Array1OfPnt2d from TColgp;
91              aBox:Box2d from Bnd;
92              aTol: Real from Standard) 
93     returns Boolean
94     is redefined virtual;
95         ---Level: Public 
96     
97
98     ComputeDepth(me;EyeLine: Lin from gp) 
99     returns Real from Standard is redefined static; 
100      
101  
102     GetLastDetected(me) returns Integer from Standard;
103     ---Purpose: Gets index of last detected segment 
104     ---C++: inline
105
106
107         ---Category: Internal Methods
108     Dump(me; S: in out OStream;FullDump : Boolean from Standard = Standard_True) is redefined virtual; 
109      
110     LoadPoints(me:mutable;aCurve:Curve from Geom;NbPoints: Integer) is static private; 
111
112     GetConnected(me: mutable; theLocation : Location from TopLoc) 
113     returns SensitiveEntity from Select3D 
114     is redefined virtual; 
115         ---Level: Public 
116         ---Purpose: Returns the copy of this
117
118 fields
119     mylastseg : Integer        from Standard;
120     myCurve  : Curve from Geom;
121 end SensitiveCurve;
122