src/BRepClass3d/BRepClass3d_SolidClassifier.cdl

   1 -- Created on: 1994-03-30
   2 -- Created by: Laurent BUCHARD
   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 SolidClassifier from BRepClass3d  inherits SClassifier from BRepClass3d
  18
  19      ---Purpose: Provides an algorithm to classify a point in a solid.
  20
  21
  22
  23 uses
  24     Pnt           from gp,
  25     Face          from TopoDS,
  26     Shape         from TopoDS,
  27     SolidExplorer from BRepClass3d
  28
  29 raises
  30
  31     DomainError from Standard
  32
  33 is
  34
  35
  36     Create
  37         ---Purpose : empty constructor
  38     returns SolidClassifier from BRepClass3d;
  39
  40     Load(me:in out; S   :        Shape from TopoDS)
  41     is static;
  42
  43
  44     Create(S   :        Shape from TopoDS)
  45         ---Purpose: Constructor from a Shape.
  46     returns SolidClassifier from BRepClass3d;
  47
  48
  49     Create(S   :        Shape from TopoDS;
  50            P   :        Pnt from gp;
  51            Tol :        Real from Standard)
  52         ---Purpose: Constructor to classify the point P with the
  53         --          tolerance Tol on the solid S.
  54     returns SolidClassifier from BRepClass3d;
  55
  56
  57     Perform(me: in out;
  58             P   :        Pnt from gp;
  59             Tol :        Real from Standard)
  60         ---Purpose: Classify the point P with the
  61         --          tolerance Tol on the solid S.
  62     is static;
  63
  64     PerformInfinitePoint(me: in out;
  65                          Tol :        Real from Standard)
  66         ---Purpose: Classify an infinite point with the
  67         --          tolerance Tol on the solid S.
  68         --          Useful for compute the orientation of a solid.
  69     is static;
  70
  71     Destroy(me:in out)
  72         ---C++: alias ~
  73     is static;
  74
  75
  76 fields
  77     aSolidLoaded   : Boolean       from Standard;
  78     explorer       : SolidExplorer from BRepClass3d;
  79     isaholeinspace : Boolean       from Standard;
  80 end SolidClassifier;