0024624: Lost word in license statement in source files
[occt.git] / src / BRepClass3d / BRepClass3d_SClassifier.cdl
CommitLineData
b311480e 1-- Created on: 1996-07-15
2-- Created by: Laurent BUCHARD
3-- Copyright (c) 1996-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class SClassifier from BRepClass3d
18
19 ---Purpose: Provides an algorithm to classify a point in a solid.
20
21uses
22 Pnt from gp,
23 Face from TopoDS,
24 Shape from TopoDS,
25 State from TopAbs,
26 SolidExplorer from BRepClass3d
27
28raises
29 DomainError from Standard
30
31
32
33is
34
35 Create
36 ---Purpose: Empty constructor.
37 returns SClassifier from BRepClass3d;
38
39
40 Create(S : in out SolidExplorer from BRepClass3d;
41 P : Pnt from gp;
42 Tol : Real from Standard)
43 ---Purpose: Constructor to classify the point P with the
44 -- tolerance Tol on the solid S.
45 returns SClassifier from BRepClass3d;
46
47
48 Perform(me : in out;
49 S : in out SolidExplorer from BRepClass3d;
50 P : Pnt from gp;
51 Tol : Real from Standard);
52 ---Purpose: Classify the point P with the
53 -- tolerance Tol on the solid S.
54 --
55 PerformInfinitePoint(me : in out;
56 S : in out SolidExplorer from BRepClass3d;
57 Tol : Real from Standard);
58 ---Purpose: Classify an infinite point with the
59 -- tolerance Tol on the solid S.
60
61
62 Rejected(me)
63 ---Purpose: Returns True if the classification has been
64 -- computed by rejection.
65 -- The State is then OUT.
66 returns Boolean from Standard;
67
68
69 State(me) returns State from TopAbs;
70 ---Purpose: Returns the result of the classification.
71
72 IsOnAFace(me) returns Boolean from Standard;
73 ---Purpose: Returns True when the point is a point of a face.
74
75 Face(me)
76 ---Purpose: Returns the face used to determine the
77 -- classification. When the state is ON, this is the
78 -- face containing the point.
79 --
80 -- When Rejected() returns True, Face() has no signification.
81 returns Face from TopoDS;
82
83
84 ForceIn(me: in out)
85 is protected;
86
87 ForceOut(me: in out)
88 is protected;
89
90
91fields
92
93 myFace : Face from TopoDS;
94 myState : Integer from Standard; -- 1: Rejected 2: IsOnFace 3: In 4: Out
95
96end SClassifier;