33c7bcdedaf02fb1870a8623ecf953e3dafb058e
[occt.git] / src / Select3D / Select3D_SensitivePoint.cdl
1 -- Created on: 1995-02-23
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
22
23 class SensitivePoint from Select3D 
24 inherits SensitiveEntity from Select3D
25
26         ---Purpose: A framework to define sensitive 3D points.
27
28 uses
29     Pnt             from gp,
30     Pnt2d           from gp,
31     Projector       from Select3D,
32     Lin             from gp,
33     EntityOwner     from SelectBasics,
34     ListOfBox2d     from SelectBasics,
35     Location        from TopLoc,
36     Box2d             from Bnd,
37     Array1OfPnt2d     from TColgp, 
38     Pnt               from Select3D,
39     Pnt2d             from Select3D
40
41 is
42
43     Create (OwnerId : EntityOwner from SelectBasics;
44             Point   : Pnt from gp)
45     returns mutable SensitivePoint;
46         ---Purpose: Constructs a sensitive point object defined by the
47         -- owner OwnerId and the point Point. 
48
49
50     Project (me:mutable;aProjector : Projector from Select3D) 
51     is redefined static;
52     ---Level: Public 
53     ---Purpose:Converts the stored 3D point into a 2D point according 
54     --         to <aProjector> ; this method is called by the selection Manager.
55
56     
57     Areas(me:mutable; aresult : in out ListOfBox2d from SelectBasics) 
58     is redefined static;
59     ---Level: Public 
60     ---Purpose: stores in <aresult> the 2D sensitive box which represents 
61     --          the point area in the selection process. 
62
63     GetConnected(me:mutable;aLocation: Location from TopLoc)
64     returns SensitiveEntity from Select3D is redefined static;
65     
66     Matches(me  :mutable; 
67             X,Y : Real from Standard;
68             aTol: Real from Standard;
69             DMin: out Real from Standard) 
70     returns Boolean
71     is redefined static;    
72     ---Level: Public 
73     ---Purpose: returns true if the X,Y position matches the point
74     --          else gives the distance between them.
75
76     Matches (me  :mutable; 
77              XMin,YMin,XMax,YMax : Real from Standard;
78              aTol: Real from Standard) 
79     returns Boolean
80     is static;
81
82      
83     Matches (me  :mutable; 
84              Polyline:Array1OfPnt2d from TColgp;
85              aBox:Box2d from Bnd;
86              aTol: Real from Standard) 
87     returns Boolean
88     is redefined virtual;
89     ---Level: Public 
90     
91
92     ComputeDepth(me;EyeLine: Lin from gp) 
93     returns Real from Standard is redefined static;
94
95       
96     Point(me) returns Pnt from gp;
97     ---Purpose: Returns the point used at the time of construction.
98
99
100     Dump(me; S: in out OStream;FullDump : Boolean from Standard = Standard_True) is redefined virtual;
101
102 fields
103
104     mypoint   : Pnt from Select3D;
105     myprojpt  : Pnt2d from Select3D;
106     
107     
108 end SensitivePoint;
109
110