Geom2dGcc_Circ2d2TanRad Class Reference

This class implements the algorithms used to
create 2d circles tangent to one curve and a
point/line/circle/curv and with a given radius.
For each construction methods arguments are:
More...

#include <Geom2dGcc_Circ2d2TanRad.hxx>

Public Member Functions
	Geom2dGcc_Circ2d2TanRad (const Geom2dGcc_QualifiedCurve &Qualified1, const Geom2dGcc_QualifiedCurve &Qualified2, const Standard_Real Radius, const Standard_Real Tolerance)
	Geom2dGcc_Circ2d2TanRad (const Geom2dGcc_QualifiedCurve &Qualified1, const Handle< Geom2d_Point > &Point, const Standard_Real Radius, const Standard_Real Tolerance)
	Geom2dGcc_Circ2d2TanRad (const Handle< Geom2d_Point > &Point1, const Handle< Geom2d_Point > &Point2, const Standard_Real Radius, const Standard_Real Tolerance)
	These constructors create one or more 2D circles of radius Radius either More...
void	Results (const GccAna_Circ2d2TanRad &Circ)
void	Results (const Geom2dGcc_MyCirc2d2TanRad &Circ)
Standard_Boolean	IsDone () const
	This method returns True if the algorithm succeeded. <br> Note: IsDone protects against a failure arising from a more internal intersection algorithm, which has reached its numeric limits. More...
Standard_Integer	NbSolutions () const
	This method returns the number of solutions. <br> NotDone is raised if the algorithm failed. <br> Exceptions StdFail_NotDone if the construction fails. More...
gp_Circ2d	ThisSolution (const Standard_Integer Index) const
	Returns the solution number Index and raises OutOfRange <br> exception if Index is greater than the number of solutions. Be carefull: the Index is only a way to get all the solutions, but is not associated to theses outside the context of the algorithm-object. Warning This indexing simply provides a means of consulting the solutions. The index values are not associated with these solutions outside the context of the algorithm object. Exceptions Standard_OutOfRange if Index is less than zero or greater than the number of solutions computed by this algorithm. StdFail_NotDone if the construction fails. More...
void	WhichQualifier (const Standard_Integer Index, GccEnt_Position &Qualif1, GccEnt_Position &Qualif2) const
	Returns the qualifiers Qualif1 and Qualif2 of the <br> tangency arguments for the solution of index Index computed by this algorithm. The returned qualifiers are: More...
void	Tangency1 (const Standard_Integer Index, Standard_Real &ParSol, Standard_Real &ParArg, gp_Pnt2d &PntSol) const
	Returns informations about the tangency point between the <br> result number Index and the first argument. ParSol is the intrinsic parameter of the point PntSol on the solution curv. ParArg is the intrinsic parameter of the point PntSol on the argument curv. OutOfRange is raised if Index is greater than the number of solutions. notDone is raised if the construction algorithm did not succeed. More...
void	Tangency2 (const Standard_Integer Index, Standard_Real &ParSol, Standard_Real &ParArg, gp_Pnt2d &PntSol) const
	Returns informations about the tangency point between the <br> result number Index and the second argument. ParSol is the intrinsic parameter of the point PntSol on the solution curv. ParArg is the intrinsic parameter of the point PntSol on the argument curv. OutOfRange is raised if Index is greater than the number of solutions. notDone is raised if the construction algorithm did not succeed. More...
Standard_Boolean	IsTheSame1 (const Standard_Integer Index) const
	Returns true if the solution of index Index and, <br> respectively, the first or second argument of this algorithm are the same (i.e. there are 2 identical circles). If Rarg is the radius of the first or second argument, Rsol is the radius of the solution and dist is the distance between the two centers, we consider the two circles to be identical if |Rarg - Rsol| and dist are less than or equal to the tolerance criterion given at the time of construction of this algorithm. OutOfRange is raised if Index is greater than the number of solutions. notDone is raised if the construction algorithm did not succeed. More...
Standard_Boolean	IsTheSame2 (const Standard_Integer Index) const
	Returns true if the solution of index Index and, <br> respectively, the first or second argument of this algorithm are the same (i.e. there are 2 identical circles). If Rarg is the radius of the first or second argument, Rsol is the radius of the solution and dist is the distance between the two centers, we consider the two circles to be identical if |Rarg - Rsol| and dist are less than or equal to the tolerance criterion given at the time of construction of this algorithm. OutOfRange is raised if Index is greater than the number of solutions. notDone is raised if the construction algorithm did not succeed. More...

Detailed Description

This class implements the algorithms used to
create 2d circles tangent to one curve and a
point/line/circle/curv and with a given radius.
For each construction methods arguments are:

• Two Qualified elements for tangency constrains.
  (for example EnclosedCirc if we want the
  solution inside the argument EnclosedCirc).
  
• Two Reals. One (Radius) for the radius and the
  other (Tolerance) for the tolerance.
  Tolerance is only used for the limit cases.
  For example :
  We want to create a circle inside a circle C1 and
  inside a curve Cu2 with a radius Radius and a
  tolerance Tolerance.
  If we did not used Tolerance it is impossible to
  find a solution in the the following case : Cu2 is
  inside C1 and there is no intersection point
  between the two elements.
  with Tolerance we will give a solution if the
  lowest distance between C1 and Cu2 is lower than or
  equal Tolerance.
  

Constructor & Destructor Documentation

Geom2dGcc_Circ2d2TanRad::Geom2dGcc_Circ2d2TanRad	(	const Geom2dGcc_QualifiedCurve &	Qualified1,
		const Geom2dGcc_QualifiedCurve &	Qualified2,
		const Standard_Real	Radius,
		const Standard_Real	Tolerance
	)

Geom2dGcc_Circ2d2TanRad::Geom2dGcc_Circ2d2TanRad	(	const Geom2dGcc_QualifiedCurve &	Qualified1,
		const Handle< Geom2d_Point > &	Point,
		const Standard_Real	Radius,
		const Standard_Real	Tolerance
	)

Geom2dGcc_Circ2d2TanRad::Geom2dGcc_Circ2d2TanRad	(	const Handle< Geom2d_Point > &	Point1,
		const Handle< Geom2d_Point > &	Point2,
		const Standard_Real	Radius,
		const Standard_Real	Tolerance
	)

These constructors create one or more 2D circles of radius Radius either

• tangential to the 2 curves Qualified1 and Qualified2, or
  
• tangential to the curve Qualified1 and passing through the point Point, or
  
• passing through two points Point1 and Point2.
  Tolerance is a tolerance criterion used by the algorithm
  to find a solution when, mathematically, the problem
  posed does not have a solution, but where there is
  numeric uncertainty attached to the arguments.
  For example, take two circles C1 and C2, such that C2
  is inside C1, and almost tangential to C1. There is, in
  fact, no point of intersection between C1 and C2. You
  now want to find a circle of radius R (smaller than the
  radius of C2), which is tangential to C1 and C2, and
  inside these two circles: a pure mathematical resolution
  will not find a solution. This is where the tolerance
  criterion is used: the algorithm considers that C1 and
  C2 are tangential if the shortest distance between these
  two circles is less than or equal to Tolerance. Thus, a
  solution is found by the algorithm.
  Exceptions
  GccEnt_BadQualifier if a qualifier is inconsistent with
  the argument it qualifies (for example, enclosing for a line).
  Standard_NegativeValue if Radius is negative.
  

Member Function Documentation

Standard_Boolean Geom2dGcc_Circ2d2TanRad::IsDone

(

)

const

 This method returns True if the algorithm succeeded. <br>

Note: IsDone protects against a failure arising from a
more internal intersection algorithm, which has reached its numeric limits.

Standard_Boolean Geom2dGcc_Circ2d2TanRad::IsTheSame1

(

const Standard_Integer

Index

)

const

 Returns true if the solution of index Index and, <br>

respectively, the first or second argument of this
algorithm are the same (i.e. there are 2 identical circles).
If Rarg is the radius of the first or second argument,
Rsol is the radius of the solution and dist is the
distance between the two centers, we consider the two
circles to be identical if |Rarg - Rsol| and dist
are less than or equal to the tolerance criterion given at
the time of construction of this algorithm.
OutOfRange is raised if Index is greater than the number of solutions.
notDone is raised if the construction algorithm did not succeed.

Standard_Boolean Geom2dGcc_Circ2d2TanRad::IsTheSame2

(

const Standard_Integer

Index

)

const

 Returns true if the solution of index Index and, <br>

respectively, the first or second argument of this
algorithm are the same (i.e. there are 2 identical circles).
If Rarg is the radius of the first or second argument,
Rsol is the radius of the solution and dist is the
distance between the two centers, we consider the two
circles to be identical if |Rarg - Rsol| and dist
are less than or equal to the tolerance criterion given at
the time of construction of this algorithm.
OutOfRange is raised if Index is greater than the number of solutions.
notDone is raised if the construction algorithm did not succeed.

Standard_Integer Geom2dGcc_Circ2d2TanRad::NbSolutions

(

)

const

 This method returns the number of solutions. <br>
     NotDone is raised if the algorithm failed. <br>

Exceptions
StdFail_NotDone if the construction fails.

void Geom2dGcc_Circ2d2TanRad::Results

(

const GccAna_Circ2d2TanRad &

Circ

)

void Geom2dGcc_Circ2d2TanRad::Results

(

const Geom2dGcc_MyCirc2d2TanRad &

Circ

)

void Geom2dGcc_Circ2d2TanRad::Tangency1	(	const Standard_Integer	Index,
		Standard_Real &	ParSol,
		Standard_Real &	ParArg,
		gp_Pnt2d &	PntSol
	)		const

 Returns informations about the tangency point between the <br>

result number Index and the first argument.
ParSol is the intrinsic parameter of the point PntSol on the solution curv.
ParArg is the intrinsic parameter of the point PntSol on the argument curv.
OutOfRange is raised if Index is greater than the number of solutions.
notDone is raised if the construction algorithm did not succeed.

void Geom2dGcc_Circ2d2TanRad::Tangency2	(	const Standard_Integer	Index,
		Standard_Real &	ParSol,
		Standard_Real &	ParArg,
		gp_Pnt2d &	PntSol
	)		const

 Returns informations about the tangency point between the <br>

result number Index and the second argument.
ParSol is the intrinsic parameter of the point PntSol on the solution curv.
ParArg is the intrinsic parameter of the point PntSol on the argument curv.
OutOfRange is raised if Index is greater than the number of solutions.
notDone is raised if the construction algorithm did not succeed.

gp_Circ2d Geom2dGcc_Circ2d2TanRad::ThisSolution

(

const Standard_Integer

Index

)

const

 Returns the solution number Index and raises OutOfRange <br>

exception if Index is greater than the number of solutions.
Be carefull: the Index is only a way to get all the
solutions, but is not associated to theses outside the context of the algorithm-object.
Warning
This indexing simply provides a means of consulting the
solutions. The index values are not associated with
these solutions outside the context of the algorithm object.
Exceptions
Standard_OutOfRange if Index is less than zero or
greater than the number of solutions computed by this algorithm.
StdFail_NotDone if the construction fails.

void Geom2dGcc_Circ2d2TanRad::WhichQualifier	(	const Standard_Integer	Index,
		GccEnt_Position &	Qualif1,
		GccEnt_Position &	Qualif2
	)		const

 Returns the qualifiers Qualif1 and Qualif2 of the <br>

tangency arguments for the solution of index Index
computed by this algorithm.
The returned qualifiers are:

• those specified at the start of construction when the
  solutions are defined as enclosed, enclosing or
  outside with respect to the arguments, or
  
• those computed during construction (i.e. enclosed,
  enclosing or outside) when the solutions are defined
  as unqualified with respect to the arguments, or
  
• GccEnt_noqualifier if the tangency argument is a point, or
  
• GccEnt_unqualified in certain limit cases where it
  is impossible to qualify the solution as enclosed, enclosing or outside.
  Exceptions
  Standard_OutOfRange if Index is less than zero or
  greater than the number of solutions computed by this algorithm.
  StdFail_NotDone if the construction fails.
  

---

The documentation for this class was generated from the following file:

• Geom2dGcc_Circ2d2TanRad.hxx