src/Intf/Intf_Polygon2d.cdl

   1 -- Created on: 2012-02-10
   2 -- Created by: Serey ZERCHANINOV
   3 -- Copyright (c) 2012-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 deferred class Polygon2d from Intf
  17
  18         ---Purpose: Describes the necessary polygon information to compute
  19     --        the interferences.
  20
  21 uses Pnt2d from gp,
  22      Box2d from Bnd
  23
  24 raises OutOfRange from Standard
  25
  26 is
  27
  28     Bounding (me)
  29         returns Box2d from Bnd;
  30     ---C++: return const &
  31     ---C++: inline
  32     ---Purpose: Returns the bounding box of the polygon.
  33
  34     Closed (me)
  35         returns Boolean from Standard is virtual;
  36     ---Purpose: Returns True if the polyline is closed.
  37     ---C++: alias "  virtual ~Intf_Polygon2d() {}"
  38
  39     DeflectionOverEstimation (me) returns Real from Standard is deferred;
  40     ---Purpose: Returns the tolerance of the polygon.
  41
  42     NbSegments (me) returns Integer from Standard is deferred;
  43     ---Purpose: Returns the number of Segments in the polyline.
  44
  45     Segment (me; theIndex : in Integer from Standard;
  46                  theBegin, theEnd : in out Pnt2d from gp)
  47         raises OutOfRange from Standard is deferred;
  48     ---Purpose: Returns the points of the segment <Index> in the Polygon.
  49
  50 fields
  51
  52     myBox   : Box2d from Bnd is protected;
  53
  54 end Polygon2d;