include/opencascade/BRepClass3d_Intersector3d.hxx

0001 // Created on: 1994-04-01
0002 // Created by: Laurent BUCHARD
0003 // Copyright (c) 1994-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_Intersector3d_HeaderFile
0018 #define _BRepClass3d_Intersector3d_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <gp_Pnt.hxx>
0024 #include <IntCurveSurface_TransitionOnCurve.hxx>
0025 #include <TopAbs_State.hxx>
0026 #include <TopoDS_Face.hxx>
0027 class gp_Lin;
0028
0029
0030
0031 class BRepClass3d_Intersector3d
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037
0038   //! Empty constructor.
0039   Standard_EXPORT BRepClass3d_Intersector3d();
0040
0041   //! Perform the intersection between the
0042   //! segment L(0) ... L(Prm) and the Shape <Sh>.
0043   //!
0044   //! Only the point with the smallest parameter on the
0045   //! line is returned.
0046   //!
0047   //! The Tolerance <Tol> is used to determine if the
0048   //! first point of the segment is near the face. In
0049   //! that case, the parameter of the intersection point
0050   //! on the line can be a negative value (greater than -Tol).
0051   Standard_EXPORT void Perform (const gp_Lin& L, const Standard_Real Prm, const Standard_Real Tol, const TopoDS_Face& F);
0052
0053   //! True is returned when the intersection have been computed.
0054     Standard_Boolean IsDone() const;
0055
0056   //! True is returned if a point has been found.
0057     Standard_Boolean HasAPoint() const;
0058
0059   //! Returns the U parameter of the intersection point
0060   //! on the surface.
0061     Standard_Real UParameter() const;
0062
0063   //! Returns the V parameter of the intersection point
0064   //! on the surface.
0065     Standard_Real VParameter() const;
0066
0067   //! Returns the parameter of the intersection point
0068   //! on the line.
0069     Standard_Real WParameter() const;
0070
0071   //! Returns the geometric point of the intersection
0072   //! between the line and the surface.
0073     const gp_Pnt& Pnt() const;
0074
0075   //! Returns the transition of the line on the surface.
0076     IntCurveSurface_TransitionOnCurve Transition() const;
0077
0078   //! Returns the state of the point on the face.
0079   //! The values can be either TopAbs_IN
0080   //! ( the point is in the face)
0081   //! or TopAbs_ON
0082   //! ( the point is on a boundary of the face).
0083     TopAbs_State State() const;
0084
0085   //! Returns the significant face used to determine
0086   //! the intersection.
0087     const TopoDS_Face& Face() const;
0088
0089
0090
0091
0092 protected:
0093
0094
0095
0096
0097
0098 private:
0099
0100
0101
0102   gp_Pnt pnt;
0103   Standard_Real U;
0104   Standard_Real V;
0105   Standard_Real W;
0106   IntCurveSurface_TransitionOnCurve transition;
0107   Standard_Boolean done;
0108   Standard_Boolean hasapoint;
0109   TopAbs_State state;
0110   TopoDS_Face face;
0111
0112
0113 };
0114
0115
0116 #include <BRepClass3d_Intersector3d.lxx>
0117
0118
0119
0120
0121
0122 #endif // _BRepClass3d_Intersector3d_HeaderFile