Integration of OCCT 6.5.0 from SVN
[occt.git] / src / Prs3d / Prs3d_Line.cdl
1 -- File:        Prs3d_Line.cdl
2 -- Created:     Wed Dec 16 12:39:30 1992
3 -- Author:      Jean Louis FRENKEL
4 --              <jlf@mastox>
5 ---Copyright:    Matra Datavision 1992
6
7 generic class Line from Prs3d 
8                             (anyLine as any; 
9                              LineTool as any) -- as LineTool from Prs3d
10 inherits Root from Prs3d
11
12 ---Purpose: draws a broken line.
13 --          
14           
15 uses 
16     Presentation from Prs3d,
17     Drawer from Prs3d,
18     TypeOfLinePicking from Prs3d,
19     Length from Quantity
20     
21 is
22     Add(myclass; aPresentation: Presentation from Prs3d; 
23                  aLine: anyLine;
24                  aDrawer: Drawer from Prs3d);
25                  
26     ---Purpose: adds to the presentation aPresentation the drawing of the
27     --          broken line aLine.     
28     --          The aspect is defined by LineAspect in aDrawer.
29
30
31     Add(myclass; aPresentation: Presentation from Prs3d; 
32                  aLine: anyLine);
33     
34     ---Purpose: adds to the presentation aPresentation the drawing of the
35     --          broken line aLine.     
36     --          The aspect is the current aspect.
37
38
39
40     Pick(myclass; X,Y,Z: Length from Quantity;
41                   aDistance: Length from Quantity;
42                   aLine: anyLine;
43                   aDrawer: Drawer from Prs3d;
44                   TypeOfPicking: TypeOfLinePicking from Prs3d)
45     returns Integer from Standard;
46
47     ---Purpose: if TypeOfLinePicking is set to Prs3d_TOLP_Point
48     --          returns the number of the point the most near of the 
49     --          point (X,Y,Z). The distance between the point and
50     --          (X,Y,Z) must be less then aDistance. If no point corresponds,
51     --          0 is returned.
52     --          if TypeOfLinePicking is set to Prs3d_TOLP_Segment returns
53     --          the number of the segment the most near of the point (X,Y,Z).
54     --          The distance between the segment and (X,Y,Z) must be less 
55     --          then aDistance. If no segment corresponds, 0 is returned.
56
57
58 end Line;