0024070: OpenGL capped object-level clipping planes
[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     PickArgs        from SelectBasics,
40     Curve           from Geom,
41     Array1OfPnt     from TColgp,
42     Array1OfPnt2d   from TColgp,
43     HArray1OfPnt     from TColgp,
44     Box2d           from Bnd,
45     Location                 from TopLoc, 
46     SensitiveEntity   from Select3D
47
48 raises
49     ConstructionError from Standard,
50     OutOfRange from Standard
51 is
52
53
54     Create (OwnerId      : EntityOwner from SelectBasics;
55             TheCurve     : Curve from Geom;
56             MaxPoints    : Integer = 17)
57      returns mutable SensitiveCurve;
58         ---Level: Public 
59         ---Purpose: Constructs a sensitive curve object defined by the
60         -- owner OwnerId, the curve TheCurve, and the
61         -- maximum number of points on the curve: MaxPoints.
62
63     Create (OwnerId      : EntityOwner from SelectBasics;
64             ThePoints    : HArray1OfPnt from TColgp)
65      returns mutable SensitiveCurve;
66         ---Level: Public 
67         ---Purpose: Constructs a sensitive curve object defined by the
68         -- owner OwnerId and the set of points ThePoints.
69         
70     Create (OwnerId      : EntityOwner from SelectBasics;
71             ThePoints    : Array1OfPnt from TColgp)
72      returns mutable SensitiveCurve;
73         ---Level: Public 
74         ---Purpose: Creation of Sensitive Curve from Points.
75         --          Warning : This Method should disappear in the next version...
76
77     Matches (me : mutable;
78              thePickArgs : PickArgs from SelectBasics;
79              theMatchDMin, theMatchDepth : out Real from Standard)
80     returns Boolean is redefined static;
81     ---Level: Public
82     ---Purpose: Checks whether the sensitive entity matches the picking
83     -- detection area (close to the picking line).
84     -- For details please refer to base class declaration.
85
86     Matches (me  :mutable; 
87              XMin,YMin,XMax,YMax : Real from Standard;
88              aTol: Real from Standard)
89     returns Boolean
90     is static;
91      
92     Matches (me  :mutable; 
93              Polyline:Array1OfPnt2d from TColgp;
94              aBox:Box2d from Bnd;
95              aTol: Real from Standard) 
96     returns Boolean
97     is redefined virtual;
98         ---Level: Public 
99     
100
101     ComputeDepth (me;
102                   thePickLine : Lin from gp;
103                   theDetectedIndex : Integer from Standard)
104     returns Real from Standard;
105     ---Level: Public
106     ---Purpose: Compute depth of sensitive circle for the detected sub-part.
107     -- @param thePickLine [in] the picking line.
108     -- @param theDetectedIndex [in] index of the detected sub-part.
109     -- @return depth on the picking line.
110  
111     GetLastDetected(me) returns Integer from Standard;
112     ---Purpose: Gets index of last detected segment 
113     ---C++: inline
114
115
116         ---Category: Internal Methods
117     Dump(me; S: in out OStream;FullDump : Boolean from Standard = Standard_True) is redefined virtual; 
118      
119     LoadPoints(me:mutable;aCurve:Curve from Geom;NbPoints: Integer) is static private; 
120
121     GetConnected(me: mutable; theLocation : Location from TopLoc) 
122     returns SensitiveEntity from Select3D 
123     is redefined virtual; 
124         ---Level: Public 
125         ---Purpose: Returns the copy of this
126
127 fields
128     mylastseg : Integer        from Standard;
129     myCurve  : Curve from Geom;
130 end SensitiveCurve;
131