include/opencascade/IntTools_PntOnFace.hxx

0001 // Created on: 2001-12-13
0002 // Created by: Peter KURNEV
0003 // Copyright (c) 2001-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _IntTools_PntOnFace_HeaderFile
0017 #define _IntTools_PntOnFace_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_DefineAlloc.hxx>
0021 #include <Standard_Handle.hxx>
0022
0023 #include <Standard_Boolean.hxx>
0024 #include <gp_Pnt.hxx>
0025 #include <TopoDS_Face.hxx>
0026
0027 //! Contains a Face, a 3d point, corresponded UV parameters and a flag
0028 class IntTools_PntOnFace
0029 {
0030 public:
0031   DEFINE_STANDARD_ALLOC
0032
0033   //! Empty constructor
0034   Standard_EXPORT IntTools_PntOnFace();
0035
0036   //! Initializes me by aFace, a 3d point
0037   //! and it's UV parameters on face
0038   Standard_EXPORT void Init(const TopoDS_Face& aF,
0039                             const gp_Pnt&      aP,
0040                             const double       U,
0041                             const double       V);
0042
0043   //! Modifier
0044   Standard_EXPORT void SetFace(const TopoDS_Face& aF);
0045
0046   //! Modifier
0047   Standard_EXPORT void SetPnt(const gp_Pnt& aP);
0048
0049   //! Modifier
0050   Standard_EXPORT void SetParameters(const double U, const double V);
0051
0052   //! Modifier
0053   Standard_EXPORT void SetValid(const bool bF);
0054
0055   //! Selector
0056   Standard_EXPORT bool Valid() const;
0057
0058   //! Selector
0059   Standard_EXPORT const TopoDS_Face& Face() const;
0060
0061   //! Selector
0062   Standard_EXPORT const gp_Pnt& Pnt() const;
0063
0064   //! Selector
0065   Standard_EXPORT void Parameters(double& U, double& V) const;
0066
0067   //! Selector
0068   Standard_EXPORT bool IsValid() const;
0069
0070 private:
0071   bool        myIsValid;
0072   gp_Pnt      myPnt;
0073   double      myU;
0074   double      myV;
0075   TopoDS_Face myFace;
0076 };
0077
0078 #endif // _IntTools_PntOnFace_HeaderFile