src/TopClass/TopClass_SolidClassifier.cdl

   1 -- File:        TopClass_SolidClassifier.cdl
   2 -- Created:     Wed Mar 30 18:28:29 1994
   3 -- Author:      Laurent BUCHARD
   4 --              <lbr@fuegox>
   5 ---Copyright:    Matra Datavision 1994
   6
   7
   8
   9
  10 generic class SolidClassifier from TopClass
  11     (TheSolidExplorer    as any;
  12      TheIntersection3d   as any)
  13
  14      ---Purpose: Provides an algorithm to classify a point in a solid.
  15
  16
  17
  18 uses
  19     Pnt     from gp,
  20     Face    from TopoDS,
  21     Shape   from TopoDS,
  22     State   from TopAbs
  23
  24 raises
  25     DomainError from Standard
  26
  27
  28
  29 is
  30
  31     Create
  32         ---Purpose: Empty constructor.
  33     returns SolidClassifier from TopClass;
  34
  35
  36     Create(S   : in out TheSolidExplorer;
  37            P   :        Pnt from gp;
  38            Tol :        Real from Standard)
  39         ---Purpose: Constructor to classify the point P with the
  40         --          tolerance Tol on the solid S.
  41     returns SolidClassifier from TopClass;
  42
  43
  44     Perform(me  : in out;
  45             S   : in out  TheSolidExplorer;
  46             P   :         Pnt from gp;
  47             Tol :         Real from Standard);
  48         ---Purpose: Classify the point P with the
  49         --          tolerance Tol on the solid S.
  50
  51
  52     Rejected(me)
  53         ---Purpose: Returns True if the classification has been
  54         --          computed by rejection.
  55         --          The State is then OUT.
  56     returns Boolean from Standard;
  57
  58
  59     State(me)  returns State  from TopAbs;
  60         ---Purpose: Returns the result of the classification.
  61
  62     IsOnAFace(me) returns Boolean from Standard;
  63         ---Purpose: Returns True when the point is a point of a face.
  64
  65     Face(me)
  66         ---Purpose: Returns the face used to determine the
  67         --          classification. When the state is ON, this is the
  68         --          face containing the point.
  69         --
  70         --          When Rejected() returns True, Face() has no signification.
  71     returns Face from TopoDS;
  72
  73 fields
  74
  75     myFace         : Face       from TopoDS;
  76     myState        : Integer    from Standard;  -- 1: Rejected     2: IsOnFace  3: In  4: Out
  77
  78 end SolidClassifier;