0023510: Integration of test grid "vis" into the new testing system
[occt.git] / src / Select2D / Select2D_SensitiveSegment.cdl
CommitLineData
b311480e 1-- Created on: 1995-01-26
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
7fd59977 21
22
23class SensitiveSegment from Select2D
24inherits SensitiveEntity from Select2D
25
26
27 ---Purpose: A framework to define sensitive areas along a line segment.
28
29uses
30 Pnt2d from gp,
31 EntityOwner from SelectBasics,
32 ListOfBox2d from SelectBasics
33
34is
35
36
37 Create (OwnerId : EntityOwner from SelectBasics;
38 FirstP,LastP : Pnt2d from gp;
39 MaxRect : Integer = 3)
40 returns mutable SensitiveSegment;
41 ---Purpose: Constructs the sensitive line segment object defined
42 -- by the owner OwnerId, the 2D starting and ending
43 -- points FirstPoint and LastPoint and the maximum
44 -- number of sensitive bounding boxes MaxRect.
45 -- The parameters can be modified using the functions provided.
46
47 Set (me:mutable; MaxRect : Integer) is static;
48 ---Purpose: Sets the maximum number of 2D sensitive bounding boxes - MaxRect.
49
50
51
52 StartPoint (me : mutable ; aPt : Pnt2d from gp) is static;
53 ---Level: Public
54 ---C++: inline
55 ---Purpose: changes the start Point of the Segment;
56
57
58
59 EndPoint (me : mutable ; aPt : Pnt2d from gp) is static;
60 ---Level: Public
61 ---C++: inline
62 ---Purpose: changes the end point of the segment
63
64
65 StartPoint (me) returns Pnt2d from gp;
66 ---Level: Public
67 ---Purpose: gives the 3D start Point of the Segment
68 ---C++: return const&
69 ---C++: inline
70
71
72 EndPoint(me) returns Pnt2d from gp;
73 ---Level: Public
74 ---Purpose: Returnes the 3D start Point of the Segment
75 ---C++: return const&
76 ---C++: inline
77
78
79 Areas (me:mutable;aSeq : in out ListOfBox2d from SelectBasics) is static;
80
81
82 Matches (me : mutable;
83 X,Y : Real from Standard;
84 aTol : Real from Standard;
85 DMin : out Real from Standard)
86 returns Boolean is static;
87
88 Matches (me :mutable;
89 XMin,YMin,XMax,YMax : Real from Standard;
90 aTol: Real from Standard)
91 returns Boolean
92 is static;
93
94
95 MaxBoxes(me) returns Integer is redefined static;
96 ---Level: Public
97 ---Purpose: Returns the max number of sensitive aeas describing the sensitive segment
98 ---C++: inline
99
100fields
101
102 mymaxrect : Integer;
103 mystart : Pnt2d from gp;
104 myend : Pnt2d from gp;
105
106end SensitiveSegment;