include/opencascade/BRepClass3d_SClassifier.hxx

0001 // Created on: 1996-07-15
0002 // Created by: Laurent BUCHARD
0003 // Copyright (c) 1996-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _BRepClass3d_SClassifier_HeaderFile
0018 #define _BRepClass3d_SClassifier_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <TopoDS_Face.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <TopAbs_State.hxx>
0026 class BRepClass3d_SolidExplorer;
0027 class gp_Pnt;
0028
0029 //! Provides an algorithm to classify a point in a solid.
0030 class BRepClass3d_SClassifier
0031 {
0032 public:
0033   DEFINE_STANDARD_ALLOC
0034
0035   //! Empty constructor.
0036   Standard_EXPORT BRepClass3d_SClassifier();
0037
0038   //! Constructor to classify the point P with the
0039   //! tolerance Tol on the solid S.
0040   Standard_EXPORT BRepClass3d_SClassifier(BRepClass3d_SolidExplorer& S,
0041                                           const gp_Pnt&              P,
0042                                           const double               Tol);
0043
0044   //! Classify the point P with the
0045   //! tolerance Tol on the solid S.
0046   Standard_EXPORT void Perform(BRepClass3d_SolidExplorer& S, const gp_Pnt& P, const double Tol);
0047
0048   //! Classify an infinite point with the
0049   //! tolerance Tol on the solid S.
0050   Standard_EXPORT void PerformInfinitePoint(BRepClass3d_SolidExplorer& S, const double Tol);
0051
0052   //! Returns True if the classification has been
0053   //! computed by rejection.
0054   //! The State is then OUT.
0055   Standard_EXPORT bool Rejected() const;
0056
0057   //! Returns the result of the classification.
0058   Standard_EXPORT TopAbs_State State() const;
0059
0060   //! Returns True when the point is a point of a face.
0061   Standard_EXPORT bool IsOnAFace() const;
0062
0063   //! Returns the face used to determine the
0064   //! classification. When the state is ON, this is the
0065   //! face containing the point.
0066   //!
0067   //! When Rejected() returns True, Face() has no signification.
0068   Standard_EXPORT TopoDS_Face Face() const;
0069
0070 protected:
0071   Standard_EXPORT void ForceIn();
0072
0073   Standard_EXPORT void ForceOut();
0074
0075 private:
0076   TopoDS_Face myFace;
0077
0078   //! This variable stores information about algorithm internal state.
0079   //! Type of this variable differs from TopAbs_State since it contains
0080   //! additional information about error status.
0081   //! 1 - Error inside of the algorithm.
0082   //! 2 - ON.
0083   //! 3 - IN.
0084   //! 4 - OUT.
0085   int myState;
0086 };
0087
0088 #endif // _BRepClass3d_SClassifier_HeaderFile