src/IntTools/IntTools_FClass2d.cdl

   1 -- Created on: 1995-03-22
   2 -- Created by: Laurent BUCHARD
   3 -- Copyright (c) 1995-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class FClass2d from IntTools
  18
  19         ---Purpose: Class provides an algorithm to classify a 2d Point
  20         ---         in 2d space of face using boundaries of the face.
  21
  22 uses
  23     Pnt2d             from gp,
  24     Face              from TopoDS,
  25     State             from TopAbs,
  26     SequenceOfInteger from TColStd,
  27     SeqOfPtr          from BRepTopAdaptor
  28
  29 is
  30     Create
  31         returns FClass2d from IntTools;
  32         ---Purpose:
  33         --- Empty constructor
  34         ---
  35
  36     Create( F: Face from TopoDS;
  37             Tol: Real from Standard)
  38         returns FClass2d from IntTools;
  39         ---Purpose:
  40         --- Initializes algorithm by the face F
  41         --- and tolerance Tol
  42         ---
  43
  44     Init  (me:out;
  45            F: Face from TopoDS;
  46            Tol: Real from Standard);
  47         ---Purpose:
  48         --- Initializes algorithm by the face F
  49         --- and tolerance Tol
  50         ---
  51
  52     PerformInfinitePoint(me)
  53         returns State from TopAbs;
  54         ---Purpose:
  55         --- Returns state of infinite 2d point relatively to (0, 0)
  56         ---
  57
  58     Perform(me;
  59             Puv: Pnt2d from gp;
  60             RecadreOnPeriodic: Boolean from Standard=Standard_True)
  61         returns State from TopAbs;
  62         ---Purpose:
  63         --- Returns state of the 2d point Puv.
  64         --- If RecadreOnPeriodic is true (defalut value),
  65         --- for the periodic surface 2d point, adjusted to period, is
  66         --- classified.
  67         ---
  68
  69     Destroy(me: in out);
  70         ---C++: alias ~
  71         ---Purpose:
  72         --- Destructor
  73         ---
  74
  75
  76     TestOnRestriction(me;
  77                         Puv: Pnt2d from gp;
  78                         Tol: Real from Standard;
  79                         RecadreOnPeriodic: Boolean from Standard  =  Standard_True)
  80         returns State from TopAbs;
  81         ---Purpose:
  82         --- Test a point with +- an offset (Tol) and returns
  83         --- On if some points are OUT an some are IN
  84         --  (Caution: Internal use . see the code for more details)
  85         ---
  86
  87 --modified by NIZNHY-PKV Mon May 29 10:47:52 2006f
  88     IsHole(me)
  89         returns Boolean from Standard;
  90 --modified by NIZNHY-PKV Mon May 29 10:47:54 2006t
  91
  92 fields
  93
  94     TabClass    : SeqOfPtr          from BRepTopAdaptor;
  95     TabOrien    : SequenceOfInteger from TColStd;
  96     Toluv       : Real              from Standard;
  97     Face        : Face              from TopoDS;
  98     U1          : Real              from Standard;
  99     V1          : Real              from Standard;
 100     U2          : Real              from Standard;
 101     V2          : Real              from Standard;
 102
 103     Umin        : Real              from Standard;
 104     Umax        : Real              from Standard;
 105     Vmin        : Real              from Standard;
 106     Vmax        : Real              from Standard;
 107     --modified by NIZNHY-PKV Mon May 29 10:44:12 2006f
 108     myIsHole    : Boolean           from Standard;
 109     --modified by NIZNHY-PKV Mon May 29 10:44:14 2006t
 110
 111
 112 end FClass2d ;