0023024: Update headers of OCCT files
[occt.git] / 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-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23
24
25 class SolidClassifier from BRepClass3d  inherits SClassifier from BRepClass3d
26      
27      ---Purpose: Provides an algorithm to classify a point in a solid.
28
29
30
31 uses 
32     Pnt           from gp,
33     Face          from TopoDS,
34     Shape         from TopoDS,
35     SolidExplorer from BRepClass3d
36
37 raises
38
39     DomainError from Standard
40         
41 is 
42
43
44     Create
45         ---Purpose : empty constructor
46     returns SolidClassifier from BRepClass3d;
47         
48     Load(me:in out; S   :        Shape from TopoDS)
49     is static;
50     
51
52     Create(S   :        Shape from TopoDS)
53         ---Purpose: Constructor from a Shape.
54     returns SolidClassifier from BRepClass3d;
55     
56     
57     Create(S   :        Shape from TopoDS; 
58            P   :        Pnt from gp;
59            Tol :        Real from Standard)
60         ---Purpose: Constructor to classify the point P with the 
61         --          tolerance Tol on the solid S.
62     returns SolidClassifier from BRepClass3d;
63     
64
65     Perform(me: in out;
66             P   :        Pnt from gp;
67             Tol :        Real from Standard)
68         ---Purpose: Classify the point P with the 
69         --          tolerance Tol on the solid S.
70     is static;
71
72     PerformInfinitePoint(me: in out;
73                          Tol :        Real from Standard)
74         ---Purpose: Classify an infinite point with the 
75         --          tolerance Tol on the solid S.
76         --          Useful for compute the orientation of a solid. 
77     is static;
78     
79     Destroy(me:in out)
80         ---C++: alias ~
81     is static;
82     
83
84 fields
85     aSolidLoaded   : Boolean       from Standard;
86     explorer       : SolidExplorer from BRepClass3d;
87     isaholeinspace : Boolean       from Standard;
88 end SolidClassifier;