99eea7842de0cb45e36aa31cf16059105c013e77
[occt.git] / src / Select3D / Select3D_SensitivePoly.cdl
1 deferred class SensitivePoly from Select3D 
2 inherits SensitiveEntity from Select3D
3
4     ---Purpose: Sensitive Entity to make a face selectable.
5
6 uses
7     EntityOwner       from SelectBasics,
8     Projector         from Select3D,
9     ListOfBox2d       from SelectBasics,
10     Array1OfPnt       from TColgp,
11     HArray1OfPnt      from TColgp,
12     Array1OfPnt2d   from TColgp,
13     Box2d             from Select3D
14
15 is
16
17     Initialize (OwnerId      : EntityOwner from SelectBasics;
18             ThePoints    : Array1OfPnt from TColgp)
19      returns mutable SensitivePoly;
20         ---Level: Public 
21         ---Purpose: Constructs a sensitive face object defined by the
22         -- owner OwnerId, the array of points ThePoints, and
23         -- the sensitivity type Sensitivity.
24         -- The array of points is the outer polygon of the geometric face.
25
26     Initialize (OwnerId      : EntityOwner from SelectBasics;
27             ThePoints    : HArray1OfPnt from TColgp)
28      returns mutable SensitivePoly;
29         ---Level: Public 
30         ---Purpose: Constructs a sensitive face object defined by the
31         -- owner OwnerId, the array of points ThePoints, and
32         -- the sensitivity type Sensitivity.
33         -- The array of points is the outer polygon of the geometric face.
34
35     Initialize(OwnerId      : EntityOwner from SelectBasics;
36             NbOfPoints   : Integer = 6)
37      returns mutable SensitivePoly;
38         ---Level: Public 
39         ---Purpose: Constructs the sensitive circle object defined by the
40         -- owner OwnerId, the circle Circle, the Boolean
41         -- FilledCircle and the number of points NbOfPoints.
42
43     Project (me:mutable;aProjector : Projector from Select3D) is redefined virtual;
44     ---Level: Public 
45     ---Purpose: projection of the sensitive primitive in order to
46     --          get 2D boxes for the Sort Algorithm
47     
48     Areas   (me:mutable ; boxes : in out ListOfBox2d from SelectBasics) is redefined static;
49     ---Level: Public 
50     ---Purpose: stores in <boxes> the 2D Boxes which represent the sensitive face
51     --          in the selection algorithm.
52
53     Points3D(me:mutable; theHArrayOfPnt : in out HArray1OfPnt from TColgp);
54     ---Purpose: Returns the 3D points of the array used at construction time.
55     ---C++: inline
56
57     Points2D(me:mutable; theArrayOfPnt2d : in out Array1OfPnt2d from TColgp);
58     ---Purpose: Returns the 2D points of the array used at construction time.
59     ---C++: inline
60
61
62     Destroy(me: mutable);
63     ---C++: alias ~
64
65
66 fields
67  
68     mypolyg3d       : Address   from Standard is protected;
69     mypolyg2d       : Address   from Standard is protected;
70     mybox2d         : Box2d     from Select3D is protected;
71     mynbpoints      : Integer   from Standard is protected;
72 end SensitiveFace;