[occt.git] / src / GeomLib / GeomLib_Tool.hxx

// Created on: 2003-03-18
// Created by: Oleg FEDYAEV
// Copyright (c) 2003-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 _GeomLib_Tool_HeaderFile
#define _GeomLib_Tool_HeaderFile

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

#include <Standard_Boolean.hxx>
#include <Standard_Real.hxx>
class Geom_Curve;
class gp_Pnt;
class Geom_Surface;
class Geom2d_Curve;
class gp_Pnt2d;


//! Provides various methods with Geom2d and Geom curves and surfaces.
//! The methods of this class compute the parameter(s) of a given point on a
//! curve or a surface. To get the valid result the point must be located rather close 
//! to the curve (surface) or at least to allow getting unambiguous result
//! (do not put point at center of circle...),
//! but choice of "trust" distance between curve/surface and point is 
//! responcibility of user (parameter MaxDist).
//! Return FALSE if the point is beyond the MaxDist
//! limit or if computation fails.
class GeomLib_Tool 
{
public:

  DEFINE_STANDARD_ALLOC

  
  //! Extracts the parameter of a 3D point lying on a 3D curve
  //! or at a distance less than the MaxDist value.
  Standard_EXPORT static Standard_Boolean Parameter (const Handle(Geom_Curve)& Curve, const gp_Pnt& Point, const Standard_Real MaxDist, Standard_Real& U);
  
  //! Extracts the parameter of a 3D point lying on a surface
  //! or at a distance less than the MaxDist value.
  Standard_EXPORT static Standard_Boolean Parameters (const Handle(Geom_Surface)& Surface, const gp_Pnt& Point, const Standard_Real MaxDist, Standard_Real& U, Standard_Real& V);
  
  //! Extracts the parameter of a 2D point lying on a 2D curve
  //! or at a distance less than the MaxDist value.
  Standard_EXPORT static Standard_Boolean Parameter (const Handle(Geom2d_Curve)& Curve, const gp_Pnt2d& Point, const Standard_Real MaxDist, Standard_Real& U);


protected:


private:


};


#endif // _GeomLib_Tool_HeaderFile
Commit	Line	Data
42cf5bc1	1	// Created on: 2003-03-18
	2	// Created by: Oleg FEDYAEV
	3	// Copyright (c) 2003-2014 OPEN CASCADE SAS
	4	//
	5	// This file is part of Open CASCADE Technology software library.
	6	//
	7	// This library is free software; you can redistribute it and/or modify it under
	8	// the terms of the GNU Lesser General Public License version 2.1 as published
	9	// by the Free Software Foundation, with special exception defined in the file
	10	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	11	// distribution for complete text of the license and disclaimer of any warranty.
	12	//
	13	// Alternatively, this file may be used under the terms of Open CASCADE
	14	// commercial license or contractual agreement.
	15
	16	#ifndef _GeomLib_Tool_HeaderFile
	17	#define _GeomLib_Tool_HeaderFile
	18
	19	#include <Standard.hxx>
	20	#include <Standard_DefineAlloc.hxx>
	21	#include <Standard_Handle.hxx>
	22
	23	#include <Standard_Boolean.hxx>
	24	#include <Standard_Real.hxx>
	25	class Geom_Curve;
	26	class gp_Pnt;
	27	class Geom_Surface;
	28	class Geom2d_Curve;
	29	class gp_Pnt2d;
	30
	31
	32	//! Provides various methods with Geom2d and Geom curves and surfaces.
	33	//! The methods of this class compute the parameter(s) of a given point on a
e2ca538a	34	//! curve or a surface. To get the valid result the point must be located rather close
	35	//! to the curve (surface) or at least to allow getting unambiguous result
	36	//! (do not put point at center of circle...),
	37	//! but choice of "trust" distance between curve/surface and point is
	38	//! responcibility of user (parameter MaxDist).
	39	//! Return FALSE if the point is beyond the MaxDist
42cf5bc1	40	//! limit or if computation fails.
42cf5bc1	41	class GeomLib_Tool
	42	{
	43	public:
	44
	45	DEFINE_STANDARD_ALLOC
	46
	47
	48
	49	//! Extracts the parameter of a 3D point lying on a 3D curve
e2ca538a	50	//! or at a distance less than the MaxDist value.
e2ca538a	51	Standard_EXPORT static Standard_Boolean Parameter (const Handle(Geom_Curve)& Curve, const gp_Pnt& Point, const Standard_Real MaxDist, Standard_Real& U);
42cf5bc1	52
42cf5bc1	53	//! Extracts the parameter of a 3D point lying on a surface
e2ca538a	54	//! or at a distance less than the MaxDist value.
e2ca538a	55	Standard_EXPORT static Standard_Boolean Parameters (const Handle(Geom_Surface)& Surface, const gp_Pnt& Point, const Standard_Real MaxDist, Standard_Real& U, Standard_Real& V);
42cf5bc1	56
42cf5bc1	57	//! Extracts the parameter of a 2D point lying on a 2D curve
e2ca538a	58	//! or at a distance less than the MaxDist value.
e2ca538a	59	Standard_EXPORT static Standard_Boolean Parameter (const Handle(Geom2d_Curve)& Curve, const gp_Pnt2d& Point, const Standard_Real MaxDist, Standard_Real& U);
42cf5bc1	60
	61
	62
	63
	64	protected:
	65
	66
	67
	68
	69
	70	private:
	71
	72
	73
	74
	75
	76	};
	77
	78
	79
	80
	81
	82
	83
	84	#endif // _GeomLib_Tool_HeaderFile