0024070: OpenGL capped object-level clipping planes
[occt.git] / src / Select3D / Select3D_SensitiveFace.cdl
1 -- Created on: 1995-03-24
2 -- Created by: Robert COUBLANC
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
22
23 class SensitiveFace from Select3D 
24 inherits SensitivePoly from Select3D
25
26     ---Purpose: Sensitive Entity to make a face selectable.
27     -- In some cases this class can raise Standard_ConstructionError and 
28     -- Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.
29
30 uses
31     EntityOwner       from SelectBasics,
32     Projector         from Select3D,
33     Lin               from gp,
34     ListOfBox2d       from SelectBasics,
35     PickArgs          from SelectBasics,
36     Array1OfPnt       from TColgp,
37     HArray1OfPnt      from TColgp,
38     Array1OfPnt2d     from TColgp,
39     Box2d             from Bnd,
40     TypeOfSensitivity from Select3D,
41     Location          from TopLoc, 
42     SensitiveEntity   from Select3D
43
44 raises
45     ConstructionError from Standard,
46     OutOfRange from Standard
47
48 is
49
50     Create (OwnerId      : EntityOwner from SelectBasics;
51             ThePoints    : Array1OfPnt from TColgp;
52             Sensitivity  : TypeOfSensitivity = Select3D_TOS_INTERIOR)
53      returns mutable SensitiveFace;
54         ---Level: Public 
55         ---Purpose: Constructs a sensitive face object defined by the
56         -- owner OwnerId, the array of points ThePoints, and
57         -- the sensitivity type Sensitivity.
58         -- The array of points is the outer polygon of the geometric face.
59
60     Create (OwnerId      : EntityOwner from SelectBasics;
61             ThePoints    : HArray1OfPnt from TColgp;
62             Sensitivity  : TypeOfSensitivity = Select3D_TOS_INTERIOR)
63      returns mutable SensitiveFace;
64         ---Level: Public 
65         ---Purpose: Constructs a sensitive face object defined by the
66         -- owner OwnerId, the array of points ThePoints, and
67         -- the sensitivity type Sensitivity.
68         -- The array of points is the outer polygon of the geometric face.
69    
70     Matches (me : mutable;
71              thePickArgs : PickArgs from SelectBasics;
72              theMatchDMin, theMatchDepth : out Real from Standard)
73     returns Boolean is redefined virtual;
74     ---Level: Public
75     ---Purpose: Checks whether the sensitive entity matches the picking
76     -- detection area (close to the picking line).
77     -- For details please refer to base class declaration.
78
79     Matches (me  :mutable; 
80              XMin,YMin,XMax,YMax : Real from Standard;
81              aTol: Real from Standard) 
82     returns Boolean
83     is redefined virtual;
84     ---Level: Public 
85      
86     Matches (me  :mutable; 
87              Polyline:Array1OfPnt2d from TColgp;
88              aBox:Box2d from Bnd;
89              aTol: Real from Standard) 
90     returns Boolean
91     is redefined virtual;
92     ---Level: Public 
93     
94
95     ComputeDepth (me;
96                   thePickLine : Lin from gp;
97                   theDepthMin, theDepthMax : Real from Standard)
98     returns Real from Standard
99     is virtual;
100     ---Level: Public
101     ---Purpose: Computes the depth values for all 3D points defining this face and returns
102     -- the minimal value among them.
103     -- If the "minimal depth" approach is not suitable and gives wrong detection results
104     -- in some particular case, a custom sensitive face class can redefine this method.
105
106     ComputeDepth(me;EyeLine: Lin from gp)
107     is private;
108     ---Level: Public
109     ---Purpose: Warning: Obsolete.
110     -- Use newer version of the method with min, max limits passed as arguments.
111
112     Dump(me; S: in out OStream;FullDump : Boolean from Standard = Standard_True) is redefined virtual; 
113
114     GetConnected(me: mutable; theLocation : Location from TopLoc) 
115     returns SensitiveEntity from Select3D 
116     is redefined virtual; 
117         ---Level: Public 
118         ---Purpose: Returns the copy of this
119
120
121 fields
122
123     mytype          : TypeOfSensitivity;
124 end SensitiveFace;