0024070: OpenGL capped object-level clipping planes
[occt.git] / src / Select3D / Select3D_SensitiveWire.cdl
CommitLineData
b311480e 1-- Created on: 1996-10-17
2-- Created by: Odile OLIVIER
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
7fd59977 21
22
23class SensitiveWire from Select3D
24inherits SensitiveEntity from Select3D
25
26 ---Purpose: A framework to define selection of a wire owner by an
27 -- elastic wire band.
28
29uses
30 Pnt from gp,
31 Projector from Select3D,
32 Lin from gp,
33 EntityOwner from SelectBasics,
34 SensitiveEntity from Select3D,
35 SensitiveEntitySequence from Select3D,
36 ListOfBox2d from SelectBasics,
4269bd1b 37 PickArgs from SelectBasics,
7fd59977 38 Array1OfPnt2d from TColgp,
39 Box2d from Bnd,
40 Location from TopLoc
41
42is
43
44
45 Create (OwnerId : EntityOwner from SelectBasics;
46 MaxRect : Integer = 1)
47 returns mutable SensitiveWire;
48 ---Purpose: Constructs a sensitive wire object defined by the
49 -- owner OwnerId, and the maximum number of
50 -- sensitive rectangles MaxRect.
51 Add (me :mutable;aSensitive : SensitiveEntity from Select3D)
52 is static;
53 ---Purpose: Adds the sensitive entity aSensitive to this framework.
54 Project (me:mutable;aProjector : Projector from Select3D)
55 is redefined static;
56 ---Level: Public
57 ---Purpose: projection of the sensitive primitive in order to
58 -- get 2D boxes for the Sort Algorithm
59
60 Areas (me:mutable ; boxes : in out ListOfBox2d from SelectBasics)
61 is redefined static;
62 ---Level: Public
63 ---Purpose: gives the 2D boxes which represent the segment in the
64 -- selection process...
65
66 GetConnected(me:mutable;aLocation: Location from TopLoc)
67 returns SensitiveEntity from Select3D is redefined static;
68
69 GetEdges(me : mutable;
70 theEdges : in out SensitiveEntitySequence from Select3D);
71 ---Level: Public
72 ---Purpose: returns the sensitive edges stored in this wire
73
74
75 SetLocation(me:mutable;aLoc:Location from TopLoc) is redefined static;
76 ---Purpose: propagation of location on all the sensitive inside...
77 ResetLocation(me:mutable) is redefined static;
78 ---Purpose: propagation of location on all the sensitive inside...
79
4269bd1b 80 Matches (me : mutable;
81 thePickArgs : PickArgs from SelectBasics;
82 theMatchDMin, theMatchDepth : out Real from Standard)
7fd59977 83 returns Boolean
4269bd1b 84 is redefined static;
85 ---Level: Public
86 ---Purpose: Checks whether the sensitive entity matches the picking
87 -- detection area (close to the picking line).
88 -- For details please refer to base class declaration.
7fd59977 89
90 Matches (me :mutable;
91 XMin,YMin,XMax,YMax : Real from Standard;
92 aTol: Real from Standard)
93 returns Boolean
94 is static;
95
96 Matches (me :mutable;
97 Polyline:Array1OfPnt2d from TColgp;
98 aBox:Box2d from Bnd;
99 aTol: Real from Standard)
100 returns Boolean
101 is redefined virtual;
102 ---Level: Public
103
104
7fd59977 105 MaxBoxes(me) returns Integer is redefined static;
106 ---Level: Public
107 ---Purpose:returns <mymaxrect>
108
109
ac04d101
SA
110 Dump(me; S: in out OStream;FullDump : Boolean from Standard = Standard_True) is redefined virtual;
111
112 Set(me:mutable;TheOwnerId: EntityOwner from SelectBasics) is redefined static;
113 ---Purpose: Sets the owner for all entities in wire
4269bd1b 114
7fd59977 115 GetLastDetected(me)
116 returns SensitiveEntity from Select3D is static;
117 ---Purpose:returns <mymaxrect>
118
119fields
7fd59977 120 mysensitive : SensitiveEntitySequence from Select3D;
121 myDetectedIndex : Integer from Standard;
122end SensitiveWire;
123
124
125
126
127
128
129
130