include/opencascade/TopOpeBRep_VPointInterClassifier.hxx

0001 // Created on: 1993-11-17
0002 // Created by: Jean Yves LEBEY
0003 // Copyright (c) 1993-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 _TopOpeBRep_VPointInterClassifier_HeaderFile
0018 #define _TopOpeBRep_VPointInterClassifier_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <BRepClass_FaceClassifier.hxx>
0024 #include <TopAbs_State.hxx>
0025 #include <TopoDS_Shape.hxx>
0026 #include <Standard_Integer.hxx>
0027 class TopOpeBRep_VPointInter;
0028 class TopOpeBRep_PointClassifier;
0029
0030 class TopOpeBRep_VPointInterClassifier
0031 {
0032 public:
0033   DEFINE_STANDARD_ALLOC
0034
0035   Standard_EXPORT TopOpeBRep_VPointInterClassifier();
0036
0037   //! compute position of VPoint <VP> regarding with face <F>.
0038   //! <ShapeIndex> (= 1,2) indicates which (u,v) point of <VP> is used.
0039   //! when state is ON, set VP.EdgeON() with the edge containing <VP>
0040   //! and associated parameter.
0041   //! returns state of VP on ShapeIndex.
0042   Standard_EXPORT TopAbs_State VPointPosition(const TopoDS_Shape&         F,
0043                                               TopOpeBRep_VPointInter&     VP,
0044                                               const Standard_Integer      ShapeIndex,
0045                                               TopOpeBRep_PointClassifier& PC,
0046                                               const Standard_Boolean      AssumeINON,
0047                                               const Standard_Real         Tol);
0048
0049   //! returns the edge containing the VPoint <VP> used in the
0050   //! last VPointPosition() call. Edge is defined if the state previously
0051   //! computed is ON, else Edge is a null shape.
0052   Standard_EXPORT const TopoDS_Shape& Edge() const;
0053
0054   //! returns the parameter of the VPoint <VP> on Edge()
0055   Standard_EXPORT Standard_Real EdgeParameter() const;
0056
0057 protected:
0058 private:
0059   BRepClass_FaceClassifier mySlowFaceClassifier;
0060   TopAbs_State             myState;
0061   TopoDS_Shape             myNullShape;
0062 };
0063
0064 #endif // _TopOpeBRep_VPointInterClassifier_HeaderFile