src/BRepLib/BRepLib_FindSurface.cdl

   1 -- Created on: 1994-07-22
   2 -- Created by: Remi LEQUETTE
   3 -- Copyright (c) 1994-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 FindSurface from BRepLib
  18
  19         ---Purpose: Provides an  algorithm to find  a Surface  through a
  20         --          set of edges.
  21         --
  22         --          The edges  of  the  shape  given  as  argument are
  23         --          explored if they are not coplanar at  the required
  24         --          tolerance  the method Found returns false.
  25         --
  26         --          If a null tolerance is given the max of the  edges
  27         --          tolerances is used.
  28         --
  29         --          The method Tolerance returns the true distance  of
  30         --          the edges to the Surface.
  31         --
  32         --          The method Surface returns the Surface if found.
  33         --
  34         --          The method Existed  returns returns  True  if  the
  35         --          Surface was already attached to some of the edges.
  36         --
  37         --          When Existed  returns True  the  Surface  may have a
  38         --          location given by the Location method.
  39
  40 uses
  41
  42     Shape    from TopoDS,
  43     Location from TopLoc,
  44     Surface    from Geom
  45
  46 raises
  47
  48     NoSuchObject from Standard
  49
  50 is
  51
  52     Create returns FindSurface from BRepLib;
  53
  54     Create (S         : Shape   from TopoDS;
  55             Tol       : Real    from Standard = -1;
  56             OnlyPlane : Boolean from Standard = Standard_False;
  57             OnlyClosed: Boolean from Standard = Standard_False)
  58         ---Purpose: Computes the Surface from the edges of  <S> with the
  59         --          given tolerance.
  60         --          if <OnlyPlane> is true, the computed surface will be
  61         --          a plane. If it is not possible to find a plane, the
  62         --          flag NotDone will be set.
  63         --          If <OnlyClosed> is true,  then  S  sould be a wire
  64         --          and the existing surface,  on  which wire S is not
  65         --          closed in 2D, will be ignored.
  66     returns FindSurface from BRepLib;
  67
  68     Init (me : in out;
  69           S         : Shape   from TopoDS;
  70           Tol       : Real    from Standard = -1;
  71           OnlyPlane : Boolean from Standard = Standard_False;
  72           OnlyClosed: Boolean from Standard = Standard_False)
  73         ---Purpose: Computes the Surface from the edges of  <S> with the
  74         --          given tolerance.
  75         --          if <OnlyPlane> is true, the computed surface will be
  76         --          a plane. If it is not possible to find a plane, the
  77         --          flag NotDone will be set.
  78         --          If <OnlyClosed> is true,  then  S  sould be a wire
  79         --          and the existing surface,  on  which wire S is not
  80         --          closed in 2D, will be ignored.
  81     is static;
  82
  83     Found(me) returns Boolean
  84     is static;
  85
  86     Surface(me) returns mutable Surface from Geom
  87     is static;
  88
  89     Tolerance(me) returns Real
  90     is static;
  91
  92     ToleranceReached(me) returns Real
  93     is static;
  94
  95     Existed(me) returns Boolean
  96     is static;
  97
  98     Location(me) returns Location from TopLoc
  99     is static;
 100
 101 fields
 102
 103     mySurface    : Surface from Geom;
 104     myTolerance  : Real;
 105     myTolReached : Real;
 106     isExisted    : Boolean;
 107     myLocation   : Location from TopLoc;
 108
 109 end FindSurface;