Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions
Geom2dGcc_Lin2dTanObl Class Reference

This class implements the algorithms used to
create 2d line tangent to a curve QualifiedCurv and
doing an angle Angle with a line TheLin.
The angle must be in Radian.
Describes functions for building a 2D line making a given
angle with a line and tangential to a curve.
A Lin2dTanObl object provides a framework for:
More...

#include <Geom2dGcc_Lin2dTanObl.hxx>

Public Member Functions

 Geom2dGcc_Lin2dTanObl (const Geom2dGcc_QualifiedCurve &Qualified1, const gp_Lin2d &TheLin, const Standard_Real TolAng, const Standard_Real Angle)
 This class implements the algorithm used to
create 2d line tangent to a curve and doing an
angle Angle with the line TheLin.
Angle must be in Radian.
Tolang is the angular tolerance.
More...
 
 Geom2dGcc_Lin2dTanObl (const Geom2dGcc_QualifiedCurve &Qualified1, const gp_Lin2d &TheLin, const Standard_Real TolAng, const Standard_Real Param1, const Standard_Real Angle)
 
 This class implements the algorithm used to <br>
     create 2d line tangent to a curve and doing an <br>
     angle Angle with the line TheLin. <br>
     Angle must be in Radian. <br>
     Param2 is the initial guess on the curve QualifiedCurv. <br>
     Tolang is the angular tolerance. <br>

Warning
An iterative algorithm is used if Qualified1 is more
complex than a line or a circle. In such cases, the
algorithm constructs only one solution.
Exceptions
GccEnt_BadQualifier if a qualifier is inconsistent with
the argument it qualifies (for example, enclosed for a circle).
More...

 
Standard_Boolean IsDone () const
 
 Returns true if the construction algorithm does not fail <br>

(even if it finds no solution).
Note: IsDone protects against a failure arising from a
more internal intersection algorithm, which has reached its numeric limits.
More...

 
Standard_Integer NbSolutions () const
 
 Returns the number of lines, representing solutions computed by this algorithm. <br>

Exceptions
StdFail_NotDone if the construction fails.
More...

 
gp_Lin2d ThisSolution (const Standard_Integer Index) const
 
 Returns a line, representing the solution of index Index <br>

computed by this algorithm.
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) const
 
 Returns the qualifier Qualif1 of the tangency argument <br>

for the solution of index Index computed by this algorithm.
The returned qualifier is:
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
result 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.
More...
 
void Intersection2 (const Standard_Integer Index, Standard_Real &ParSol, Standard_Real &ParArg, gp_Pnt2d &PntSol) const
 
 Returns the point of intersection PntSol between the <br>

solution of index Index and the second argument (the line) of this algorithm.
ParSol is the parameter of the point PntSol on the
solution. ParArg is the parameter of the point PntSol on the second argument (the line).
Exceptions
StdFail_NotDone if the construction fails.
GccIter_IsParallel if the solution and the second
argument (the line) are parallel.
Standard_OutOfRange if Index is less than zero or
greater than the number of solutions computed by this algorithm.
More...

 
Standard_Boolean IsParallel2 () const
 
 Returns true if the line and the solution are parallel. This <br>

is the case when the angle given at the time of
construction is equal to 0 or Pi.
Exceptions StdFail_NotDone if the construction fails.
More...

 

Detailed Description

This class implements the algorithms used to
create 2d line tangent to a curve QualifiedCurv and
doing an angle Angle with a line TheLin.
The angle must be in Radian.
Describes functions for building a 2D line making a given
angle with a line and tangential to a curve.
A Lin2dTanObl object provides a framework for:

Constructor & Destructor Documentation

Geom2dGcc_Lin2dTanObl::Geom2dGcc_Lin2dTanObl ( const Geom2dGcc_QualifiedCurve Qualified1,
const gp_Lin2d TheLin,
const Standard_Real  TolAng,
const Standard_Real  Angle 
)

This class implements the algorithm used to
create 2d line tangent to a curve and doing an
angle Angle with the line TheLin.
Angle must be in Radian.
Tolang is the angular tolerance.

Geom2dGcc_Lin2dTanObl::Geom2dGcc_Lin2dTanObl ( const Geom2dGcc_QualifiedCurve Qualified1,
const gp_Lin2d TheLin,
const Standard_Real  TolAng,
const Standard_Real  Param1,
const Standard_Real  Angle 
)

 This class implements the algorithm used to <br>
     create 2d line tangent to a curve and doing an <br>
     angle Angle with the line TheLin. <br>
     Angle must be in Radian. <br>
     Param2 is the initial guess on the curve QualifiedCurv. <br>
     Tolang is the angular tolerance. <br>

Warning
An iterative algorithm is used if Qualified1 is more
complex than a line or a circle. In such cases, the
algorithm constructs only one solution.
Exceptions
GccEnt_BadQualifier if a qualifier is inconsistent with
the argument it qualifies (for example, enclosed for a circle).

Member Function Documentation

void Geom2dGcc_Lin2dTanObl::Intersection2 ( const Standard_Integer  Index,
Standard_Real ParSol,
Standard_Real ParArg,
gp_Pnt2d PntSol 
) const

 Returns the point of intersection PntSol between the <br>

solution of index Index and the second argument (the line) of this algorithm.
ParSol is the parameter of the point PntSol on the
solution. ParArg is the parameter of the point PntSol on the second argument (the line).
Exceptions
StdFail_NotDone if the construction fails.
GccIter_IsParallel if the solution and the second
argument (the line) are parallel.
Standard_OutOfRange if Index is less than zero or
greater than the number of solutions computed by this algorithm.

Standard_Boolean Geom2dGcc_Lin2dTanObl::IsDone ( ) const

 Returns true if the construction algorithm does not fail <br>

(even if it finds no solution).
Note: IsDone protects against a failure arising from a
more internal intersection algorithm, which has reached its numeric limits.

Standard_Boolean Geom2dGcc_Lin2dTanObl::IsParallel2 ( ) const

 Returns true if the line and the solution are parallel. This <br>

is the case when the angle given at the time of
construction is equal to 0 or Pi.
Exceptions StdFail_NotDone if the construction fails.

Standard_Integer Geom2dGcc_Lin2dTanObl::NbSolutions ( ) const

 Returns the number of lines, representing solutions computed by this algorithm. <br>

Exceptions
StdFail_NotDone if the construction fails.

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

Returns informations about the tangency point between the
result 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.

gp_Lin2d Geom2dGcc_Lin2dTanObl::ThisSolution ( const Standard_Integer  Index) const

 Returns a line, representing the solution of index Index <br>

computed by this algorithm.
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_Lin2dTanObl::WhichQualifier ( const Standard_Integer  Index,
GccEnt_Position Qualif1 
) const

 Returns the qualifier Qualif1 of the tangency argument <br>

for the solution of index Index computed by this algorithm.
The returned qualifier is:

  • that specified at the start of construction when the
    solutions are defined as enclosing or outside with
    respect to the argument, or
  • that computed during construction (i.e. enclosing or
    outside) when the solutions are defined as unqualified
    with respect to the argument, or
  • GccEnt_noqualifier if the tangency argument is a point.
    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: