[occt.git] / src / Extrema / Extrema_LocateExtCC2d.hxx

// Created on: 1994-07-06
// Created by: Laurent PAINNOT
// Copyright (c) 1994-1999 Matra Datavision
// Copyright (c) 1999-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 _Extrema_LocateExtCC2d_HeaderFile
#define _Extrema_LocateExtCC2d_HeaderFile

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

#include <Standard_Boolean.hxx>
#include <Standard_Real.hxx>
#include <Extrema_POnCurv2d.hxx>
class Standard_DomainError;
class StdFail_NotDone;
class Adaptor2d_Curve2d;
class Extrema_POnCurv2d;


//! It calculates the distance between two curves with
//! a close point; these distances can be maximum or
//! minimum.
class Extrema_LocateExtCC2d 
{
public:

  DEFINE_STANDARD_ALLOC

  
  //! Calculates the distance with a close point. The
  //! close point is defined by a parameter value on each
  //! curve.
  //! The function F(u,v)=distance(C1(u),C2(v)) has an
  //! extremun when gradient(f)=0. The algorithm searchs
  //! the zero near the close point.
  Standard_EXPORT Extrema_LocateExtCC2d(const Adaptor2d_Curve2d& C1, const Adaptor2d_Curve2d& C2, const Standard_Real U0, const Standard_Real V0);
  
  //! Returns True if the distance is found.
  Standard_EXPORT Standard_Boolean IsDone() const;
  
  //! Returns the value of the extremum square distance.
  Standard_EXPORT Standard_Real SquareDistance() const;
  
  //! Returns the points of the extremum distance.
  //! P1 is on the first curve, P2 on the second one.
  Standard_EXPORT void Point (Extrema_POnCurv2d& P1, Extrema_POnCurv2d& P2) const;


protected:


private:


  Standard_Boolean myDone;
  Standard_Real mySqDist;
  Extrema_POnCurv2d myPoint1;
  Extrema_POnCurv2d myPoint2;


};


#endif // _Extrema_LocateExtCC2d_HeaderFile
Commit	Line	Data
42cf5bc1	1	// Created on: 1994-07-06
	2	// Created by: Laurent PAINNOT
	3	// Copyright (c) 1994-1999 Matra Datavision
	4	// Copyright (c) 1999-2014 OPEN CASCADE SAS
	5	//
	6	// This file is part of Open CASCADE Technology software library.
	7	//
	8	// This library is free software; you can redistribute it and/or modify it under
	9	// the terms of the GNU Lesser General Public License version 2.1 as published
	10	// by the Free Software Foundation, with special exception defined in the file
	11	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	12	// distribution for complete text of the license and disclaimer of any warranty.
	13	//
	14	// Alternatively, this file may be used under the terms of Open CASCADE
	15	// commercial license or contractual agreement.
	16
	17	#ifndef _Extrema_LocateExtCC2d_HeaderFile
	18	#define _Extrema_LocateExtCC2d_HeaderFile
	19
	20	#include <Standard.hxx>
	21	#include <Standard_DefineAlloc.hxx>
	22	#include <Standard_Handle.hxx>
	23
	24	#include <Standard_Boolean.hxx>
	25	#include <Standard_Real.hxx>
	26	#include <Extrema_POnCurv2d.hxx>
	27	class Standard_DomainError;
	28	class StdFail_NotDone;
	29	class Adaptor2d_Curve2d;
	30	class Extrema_POnCurv2d;
	31
	32
	33	//! It calculates the distance between two curves with
	34	//! a close point; these distances can be maximum or
	35	//! minimum.
	36	class Extrema_LocateExtCC2d
	37	{
	38	public:
	39
	40	DEFINE_STANDARD_ALLOC
	41
	42
	43	//! Calculates the distance with a close point. The
	44	//! close point is defined by a parameter value on each
	45	//! curve.
	46	//! The function F(u,v)=distance(C1(u),C2(v)) has an
	47	//! extremun when gradient(f)=0. The algorithm searchs
	48	//! the zero near the close point.
	49	Standard_EXPORT Extrema_LocateExtCC2d(const Adaptor2d_Curve2d& C1, const Adaptor2d_Curve2d& C2, const Standard_Real U0, const Standard_Real V0);
	50
	51	//! Returns True if the distance is found.
	52	Standard_EXPORT Standard_Boolean IsDone() const;
	53
	54	//! Returns the value of the extremum square distance.
	55	Standard_EXPORT Standard_Real SquareDistance() const;
	56
	57	//! Returns the points of the extremum distance.
	58	//! P1 is on the first curve, P2 on the second one.
	59	Standard_EXPORT void Point (Extrema_POnCurv2d& P1, Extrema_POnCurv2d& P2) const;
	60
	61
	62
	63
	64	protected:
65
66
67
68
69
70	private:
71
72
73
74	Standard_Boolean myDone;
75	Standard_Real mySqDist;
76	Extrema_POnCurv2d myPoint1;
77	Extrema_POnCurv2d myPoint2;
78
79
80	};
81
82
83
84
85
86
87
88	#endif // _Extrema_LocateExtCC2d_HeaderFile