0023024: Update headers of OCCT files
[occt.git] / src / Intf / Intf_Polygon2d.cdl
1 -- Created on: 2012-02-10
2 -- Created by: Serey ZERCHANINOV
3 -- Copyright (c) -1999 Matra Datavision
4 -- Copyright (c) 2012-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 deferred class Polygon2d from Intf
24
25         ---Purpose: 
26
27 uses Pnt2d from gp,
28      Box2d from Bnd
29
30 raises OutOfRange from Standard
31
32 is
33
34     Bounding (me)
35         returns Box2d from Bnd;
36     ---C++: return const &
37     ---C++: inline
38     ---Purpose: Returns the bounding box of the polygon.
39
40     Closed (me)
41         returns Boolean from Standard is virtual;
42     ---Purpose: Returns True if the polyline is closed.
43
44     DeflectionOverEstimation (me) returns Real from Standard is deferred;
45     ---Purpose: Returns the tolerance of the polygon.
46
47     NbSegments (me) returns Integer from Standard is deferred;
48     ---Purpose: Returns the number of Segments in the polyline.
49
50     Segment (me; theIndex : in Integer from Standard;
51                  theBegin, theEnd : in out Pnt2d from gp)
52         raises OutOfRange from Standard is deferred;
53     ---Purpose: Returns the points of the segment <Index> in the Polygon.
54
55 fields
56
57     myBox   : Box2d from Bnd is protected;
58
59 end Polygon2d;