OCCT

// Created on: 2001-12-13
// Created by: Peter KURNEV
// Copyright (c) 2001-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _IntTools_PntOnFace_HeaderFile
#define _IntTools_PntOnFace_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <Standard_Boolean.hxx>
#include <gp_Pnt.hxx>
#include <TopoDS_Face.hxx>

//! Contains a Face, a 3d point, corresponded UV parameters and a flag
class IntTools_PntOnFace
{
public:
  DEFINE_STANDARD_ALLOC

  //! Empty constructor
  Standard_EXPORT IntTools_PntOnFace();

  //! Initializes me by aFace, a 3d point
  //! and it's UV parameters on face
  Standard_EXPORT void Init(const TopoDS_Face& aF,
                            const gp_Pnt&      aP,
                            const double       U,
                            const double       V);

  //! Modifier
  Standard_EXPORT void SetFace(const TopoDS_Face& aF);

  //! Modifier
  Standard_EXPORT void SetPnt(const gp_Pnt& aP);

  //! Modifier
  Standard_EXPORT void SetParameters(const double U, const double V);

  //! Modifier
  Standard_EXPORT void SetValid(const bool bF);

  //! Selector
  Standard_EXPORT bool Valid() const;

  //! Selector
  Standard_EXPORT const TopoDS_Face& Face() const;

  //! Selector
  Standard_EXPORT const gp_Pnt& Pnt() const;

  //! Selector
  Standard_EXPORT void Parameters(double& U, double& V) const;

  //! Selector
  Standard_EXPORT bool IsValid() const;

private:
  bool        myIsValid;
  gp_Pnt      myPnt;
  double      myU;
  double      myV;
  TopoDS_Face myFace;
};

#endif // _IntTools_PntOnFace_HeaderFile