0023510: Integration of test grid "vis" into the new testing system
[occt.git] / src / Graphic2d / Graphic2d_Polyline.cdl
1 -- Created on: 1993-06-22
2 -- Created by: Jean Louis FRENKEL, Gerard GRAS
3 -- Copyright (c) 1993-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
24 class Polyline from Graphic2d inherits Line from Graphic2d
25
26         ---Version:
27
28         ---Purpose: The primitive Polyline
29
30         ---Keywords: Primitive, Polyline
31         ---Warning:
32         ---References:
33
34 uses
35         Length                  from Quantity,
36         Drawer                  from Graphic2d,
37         Array1OfReal            from TColStd,
38         Array1OfShortReal       from TShort,
39         GraphicObject           from Graphic2d,
40         Array1OfVertex          from Graphic2d,
41         FStream                 from Aspect,
42         IFStream                from Aspect
43
44
45 raises
46         PolylineDefinitionError from Graphic2d,
47         OutOfRange from Standard
48
49 is
50         -------------------------
51         -- Category: Constructors
52         -------------------------
53
54         Create( aGraphicObject: GraphicObject from Graphic2d;
55                     aListVertex: Array1OfVertex from Graphic2d )
56         returns mutable Polyline from Graphic2d
57         ---Level: Public
58         ---Purpose: Creates a polyline.
59         --  Warning: Raises an error if the length of the polyline
60         --          is less than 2 points.
61         raises PolylineDefinitionError from Graphic2d;
62         ---Category: Constructors
63
64         Create (aGraphicObject: GraphicObject from Graphic2d;
65                 aListX: Array1OfReal from TColStd;
66                 aListY: Array1OfReal from TColStd)
67         returns mutable Polyline from Graphic2d
68         ---Level: Public
69         ---Purpose: Creates a polyline.
70         --  Warning: Raises an error if the length of the polyline
71         --          is less than 2 points or if length of <aListX>
72         --          is not equal to length of <aListY>.
73         raises PolylineDefinitionError from Graphic2d;
74         
75     -------------------------
76     ---Category: Inquire methods
77     -------------------------
78         
79     Length(me) returns Integer from Standard;
80     ---Level: Public
81     ---Purpose: Returns the number of points of the line.
82     ---Category: Inquiry method
83
84     Values(me; aRank: Integer from Standard;
85            X,Y: out Length from Quantity)
86     ---Level: Public
87     ---Purpose: Returns the point of rank <aRank> from the line.
88     ---Trigger: Raises OutOfRange if <aRank> is <1 or >Length()
89        raises OutOfRange from Standard;
90     ---Category: Inquiry method
91
92         --------------------------
93         -- Category: Draw and Pick
94         --------------------------
95
96         Draw( me : mutable; aDrawer: Drawer from Graphic2d)
97         is static protected;
98         ---Level: Internal
99         ---Purpose: Draws the polyline <me>.
100
101     DrawElement( me : mutable; aDrawer: Drawer from Graphic2d;
102                  anIndex: Integer from Standard)
103         is redefined protected;
104     ---Level: Internal
105     ---Purpose: Draws edge <anIndex> of the polyline <me>.
106
107     DrawVertex( me : mutable; aDrawer: Drawer from Graphic2d;
108                 anIndex: Integer from Standard)
109         is redefined protected;
110     ---Level: Internal
111     ---Purpose: Draws vertex <anIndex> of the polyline <me>.
112
113         Pick( me : mutable;
114                   X, Y: ShortReal from Standard;
115                   aPrecision: ShortReal from Standard;
116                   aDrawer: Drawer from Graphic2d)
117         returns Boolean from Standard
118         is static protected;
119         ---Level: Internal
120         ---Purpose: Returns Standard_True if the polyline <me> is picked,
121         --          Standard_False if not.
122         --  Warning: The method PickIndex() returns the last picked point 
123         --          rank of the line or 0 if picking occurs inside
124         --          the filled line.
125
126         ----------------------------------------------------------------------
127
128         Save(me; aFStream: in out FStream from Aspect) is virtual;
129         Retrieve(myclass; anIFStream: in out IFStream from Aspect;
130                 aGraphicObject: GraphicObject from Graphic2d);
131
132 fields
133
134         myX:    Array1OfShortReal from TShort;
135         myY:    Array1OfShortReal from TShort;
136
137 end Polyline from Graphic2d;