libcascade
API ReferenceModelingAlgorithmsTKGeomAlgo

Geom2dGcc

OCCT package Geom2dGcc: Geom2dGcc, Geom2dGcc_Circ2d2TanOn, Geom2dGcc_Circ2d2TanOnGeo, Geom2dGcc_Circ2d2TanOnIter, and 24 more bound classes.

Geom2dGcc

The Geom2dGcc package describes qualified 2D curves used in the construction of constrained geometric objects by an algorithm provided by the Geom2dGcc package. A qualified 2D curve is a curve with a qualifier which specifies whether the solution of a construction algorithm using the qualified curve (as an argument):

  • encloses the curve, or
  • is enclosed by the curve, or
  • is built so that both the curve and this solution are external to one another, or
  • is undefined (all solutions apply). These package methods provide simpler functions to construct a qualified curve. Note: the interior of a curve is defined as the left-hand side of the curve in relation to its orientation.

Constructors(1)

Static methods(4)

  • Unqualified(Obj: Geom2dAdaptor_Curve): Geom2dGcc_QualifiedCurve

    Constructs such a qualified curve that the relative position of the solution computed by a construction algorithm using the qualified curve to the circle or line is not qualified, i.e. all solutions apply. Warning Obj is an adapted curve, i.e. an object which is an interface between:

    • the services provided by a 2D curve from the package Geom2d,
    • and those required on the curve by a computation algorithm. The adapted curve is created in the following way: occ::handle<Geom2d_Curve> mycurve = ... ; Geom2dAdaptor_Curve Obj ( mycurve ) ; The qualified curve is then constructed with this object: Geom2dGcc_QualifiedCurve myQCurve = Geom2dGcc::Unqualified(Obj);
    Parameters (1)
    • Obj
  • Enclosing(Obj: Geom2dAdaptor_Curve): Geom2dGcc_QualifiedCurve

    Constructs such a qualified curve that the solution computed by a construction algorithm using the qualified curve encloses the curve. Warning Obj is an adapted curve, i.e. an object which is an interface between:

    • the services provided by a 2D curve from the package Geom2d,
    • and those required on the curve by a computation algorithm. The adapted curve is created in the following way: occ::handle<Geom2d_Curve> mycurve = ... ; Geom2dAdaptor_Curve Obj ( mycurve ) ; The qualified curve is then constructed with this object: Geom2dGcc_QualifiedCurve myQCurve = Geom2dGcc::Enclosing(Obj);
    Parameters (1)
    • Obj
  • Enclosed(Obj: Geom2dAdaptor_Curve): Geom2dGcc_QualifiedCurve

    Constructs such a qualified curve that the solution computed by a construction algorithm using the qualified curve is enclosed by the curve. Warning Obj is an adapted curve, i.e. an object which is an interface between:

    • the services provided by a 2D curve from the package Geom2d,
    • and those required on the curve by a computation algorithm. The adapted curve is created in the following way: occ::handle<Geom2d_Curve> mycurve = ... ; Geom2dAdaptor_Curve Obj ( mycurve ) ; The qualified curve is then constructed with this object: Geom2dGcc_QualifiedCurve myQCurve = Geom2dGcc::Enclosed(Obj);
    Parameters (1)
    • Obj
  • Outside(Obj: Geom2dAdaptor_Curve): Geom2dGcc_QualifiedCurve

    Constructs such a qualified curve that the solution computed by a construction algorithm using the qualified curve and the curve are external to one another. Warning Obj is an adapted curve, i.e. an object which is an interface between:

    • the services provided by a 2D curve from the package Geom2d,
    • and those required on the curve by a computation algorithm. The adapted curve is created in the following way: occ::handle<Geom2d_Curve> mycurve = ... ; Geom2dAdaptor_Curve Obj ( mycurve ) ; The qualified curve is then constructed with this object: Geom2dGcc_QualifiedCurve myQCurve = Geom2dGcc::Outside(Obj);
    Parameters (1)
    • Obj

Geom2dGcc_Circ2d2TanOn

This class implements the algorithms used to create 2d circles TANgent to 2 entities and having the center ON a curve. The order of the tangency argument is always QualifiedCirc, QualifiedLin, QualifiedCurv, Pnt2d. the arguments are :

  • The two tangency arguments.
  • The center line.
  • The parameter for each tangency argument which is a curve.
  • The tolerance.

Constructors(3)

  • constructor(Point1: Geom2d_Point, Point2: Geom2d_Point, OnCurve: Geom2dAdaptor_Curve, Tolerance: number): Geom2dGcc_Circ2d2TanOn

    This method implements the algorithms used to create 2d circles TANgent to two points and having the center ON a 2d curve. Tolerance is used for the limit cases.

    Parameters (4)
    • Point1
    • Point2
    • OnCurve
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Point: Geom2d_Point, OnCurve: Geom2dAdaptor_Curve, Tolerance: number, Param1: number, ParamOn: number): Geom2dGcc_Circ2d2TanOn

    This method implements the algorithms used to create 2d circles TANgent to one curve and one point and having the center ON a 2d curve. Param1 is the initial guess on the first curve QualifiedCurv. ParamOn is the initial guess on the center curve OnCurv. Tolerance is used for the limit cases.

    Parameters (6)
    • Qualified1
    • Point
    • OnCurve
    • Tolerance
    • Param1
    • ParamOn
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Qualified2: Geom2dGcc_QualifiedCurve, OnCurve: Geom2dAdaptor_Curve, Tolerance: number, Param1: number, Param2: number, ParamOn: number): Geom2dGcc_Circ2d2TanOn

    This method implements the algorithms used to create 2d circles TANgent to two curves and having the center ON a 2d curve. Param1 is the initial guess on the first curve QualifiedCurv. Param1 is the initial guess on the second curve QualifiedCurv. ParamOn is the initial guess on the center curve OnCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnCurve
    • Tolerance
    • Param1
    • Param2
    • ParamOn

Instance methods(11)

  • Results(Circ: GccAna_Circ2d2TanOn): void
    Parameters (1)
    • Circ
  • Results(Circ: Geom2dGcc_Circ2d2TanOnGeo): void
    Parameters (1)
    • Circ
  • IsDone(): boolean

    Returns true if the construction algorithm does not fail (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.

  • NbSolutions(): number

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

  • ThisSolution(Index: number): gp_Circ2d

    Returns the solution number Index and raises OutOfRange exception if Index is greater than the number of solutions. Be careful: the Index is only a way to get all the solutions, but is not associated to these outside the context of the algorithm-object. Exceptions Standard_OutOfRange if Index is less than or equal to zero or greater than the number of solutions computed by this algorithm. StdFail_NotDone if the construction fails.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position, Qualif2?: GccEnt_Position): { Qualif1: GccEnt_Position; Qualif2: GccEnt_Position }

    It returns the information about the qualifiers of the tangency arguments concerning the solution number Index. It returns the real qualifiers (the qualifiers given to the constructor method in case of enclosed, enclosing and outside and the qualifiers computedin case of unqualified). 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.

    Parameters (3)
    • Index
    • Qualif1
    • Qualif2
    Returns

    A result object with fields:

    • Qualif1: updated value from the call.
    • Qualif2: updated value from the call.
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information 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.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency2(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

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

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • CenterOn3(Index: number, ParArg: number, PntSol: gp_Pnt2d): { ParArg: number }

    Returns the center PntSol of the solution of index Index computed by this algorithm. ParArg is the parameter of the point PntSol on the third argument. 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.

    Parameters (3)
    • Index
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParArg: updated value from the call.
  • IsTheSame1(Index: number): boolean

    Returns true if the solution of index Index and, 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.
    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.

    Parameters (1)
    • Index
  • IsTheSame2(Index: number): boolean

    Returns true if the solution of index Index and, 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.
    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.

    Parameters (1)
    • Index

Geom2dGcc_Circ2d2TanOnGeo

This class implements the algorithms used to create 2d circles TANgent to 2 entities and having the center ON a curve. The order of the tangency argument is always QualifiedCirc, QualifiedLin, QualifiedCurv, Pnt2d. the arguments are :

  • The two tangency arguments (lines, circles or points).
  • The center line (a curve).
  • The parameter for each tangency argument which is a curve.
  • The tolerance.

Constructors(6)

Instance methods(9)

  • IsDone(): boolean

    This method returns True if the construction algorithm succeeded.

  • NbSolutions(): number

    This method returns the number of solutions. It raises NotDone if the construction algorithm didn't succeed.

  • ThisSolution(Index: number): gp_Circ2d

    Returns the solution number Index and raises OutOfRange exception if Index is greater than the number of solutions. Be careful: the Index is only a way to get all the solutions, but is not associated to those outside the context of the algorithm-object. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position, Qualif2?: GccEnt_Position): { Qualif1: GccEnt_Position; Qualif2: GccEnt_Position }

    It returns the information about the qualifiers of the tangency arguments concerning the solution number Index. It returns the real qualifiers (the qualifiers given to the constructor method in case of enclosed, enclosing and outside and the qualifiers computedin case of unqualified).

    Parameters (3)
    • Index
    • Qualif1
    • Qualif2
    Returns

    A result object with fields:

    • Qualif1: updated value from the call.
    • Qualif2: updated value from the call.
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the result number Index and the first argument. ParSol is the intrinsic parameter of the point on the solution curv. ParArg is the intrinsic parameter of the point on the argument curv. PntSol is the tangency point on the solution curv. PntArg is the tangency point on the argument curv. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency2(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the result number Index and the second argument. ParSol is the intrinsic parameter of the point on the solution curv. ParArg is the intrinsic parameter of the point on the argument curv. PntSol is the tangency point on the solution curv. PntArg is the tangency point on the argument curv. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • CenterOn3(Index: number, ParArg: number, PntSol: gp_Pnt2d): { ParArg: number }

    Returns information about the center (on the curv) of the result. ParArg is the intrinsic parameter of the point on the argument curv. PntSol is the center point of the solution curv. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (3)
    • Index
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParArg: updated value from the call.
  • IsTheSame1(Index: number): boolean

    Returns True if the solution number Index is equal to the first argument and False in the other cases. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (1)
    • Index
  • IsTheSame2(Index: number): boolean

    Returns True if the solution number Index is equal to the second argument and False in the other cases. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (1)
    • Index

Geom2dGcc_Circ2d2TanOnIter

This class implements the algorithms used to create 2d circles TANgent to 2 entities and having the center ON a curv. The order of the tangency argument is always QualifiedCirc, QualifiedLin, QualifiedCurv, Pnt2d. the arguments are :

  • The two tangency arguments.
  • The center line.
  • The parameter for each tangency argument which is a curve.
  • The tolerance.

Constructors(12)

  • constructor(Qualified1: Geom2dGcc_QCurve, Point2: gp_Pnt2d, OnLine: gp_Lin2d, Param1: number, Param2: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to a 2d point and a curve and having the center ON a 2d line. Param2 is the initial guess on the curve QualifiedCurv. Tolerance is used for the limit cases.

    Parameters (6)
    • Qualified1
    • Point2
    • OnLine
    • Param1
    • Param2
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QCurve, Point2: gp_Pnt2d, OnCirc: gp_Circ2d, Param1: number, Param2: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to a 2d point and a curve and having the center ON a 2d circle. Param2 is the initial guess on the curve QualifiedCurv. Tolerance is used for the limit cases.

    Parameters (6)
    • Qualified1
    • Point2
    • OnCirc
    • Param1
    • Param2
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QCurve, Point2: gp_Pnt2d, OnCurve: Geom2dAdaptor_Curve, Param1: number, ParamOn: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to a 2d Point and a curve and having the center ON a 2d curve. Param1 is the initial guess on the curve QualifiedCurv. ParamOn is the initial guess on the center curve OnCurv. Tolerance is used for the limit cases.

    Parameters (6)
    • Qualified1
    • Point2
    • OnCurve
    • Param1
    • ParamOn
    • Tolerance
  • constructor(Qualified1: GccEnt_QualifiedCirc, Qualified2: Geom2dGcc_QCurve, OnLine: gp_Lin2d, Param1: number, Param2: number, Param3: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to a 2d circle and a curve and having the center ON a 2d line. Param2 is the initial guess on the curve QualifiedCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnLine
    • Param1
    • Param2
    • Param3
    • Tolerance
  • constructor(Qualified1: GccEnt_QualifiedLin, Qualified2: Geom2dGcc_QCurve, OnLine: gp_Lin2d, Param1: number, Param2: number, Param3: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to a 2d line and a curve and having the center ON a 2d line. Param2 is the initial guess on the curve QualifiedCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnLine
    • Param1
    • Param2
    • Param3
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QCurve, Qualified2: Geom2dGcc_QCurve, OnLine: gp_Lin2d, Param1: number, Param2: number, Param3: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to two curves and having the center ON a 2d line. Param1 is the initial guess on the first QualifiedCurv. Param2 is the initial guess on the first QualifiedCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnLine
    • Param1
    • Param2
    • Param3
    • Tolerance
  • constructor(Qualified1: GccEnt_QualifiedCirc, Qualified2: Geom2dGcc_QCurve, OnCirc: gp_Circ2d, Param1: number, Param2: number, Param3: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to a 2d circle and a curve and having the center ON a 2d circle. Param2 is the initial guess on the curve QualifiedCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnCirc
    • Param1
    • Param2
    • Param3
    • Tolerance
  • constructor(Qualified1: GccEnt_QualifiedLin, Qualified2: Geom2dGcc_QCurve, OnCirc: gp_Circ2d, Param1: number, Param2: number, Param3: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to a 2d line and a curve and having the center ON a 2d circle. Param2 is the initial guess on the curve QualifiedCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnCirc
    • Param1
    • Param2
    • Param3
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QCurve, Qualified2: Geom2dGcc_QCurve, OnCirc: gp_Circ2d, Param1: number, Param2: number, Param3: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to two curves and having the center ON a 2d circle. Param1 is the initial guess on the first QualifiedCurv. Param2 is the initial guess on the first QualifiedCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnCirc
    • Param1
    • Param2
    • Param3
    • Tolerance
  • constructor(Qualified1: GccEnt_QualifiedCirc, Qualified2: Geom2dGcc_QCurve, OnCurv: Geom2dAdaptor_Curve, Param1: number, Param2: number, ParamOn: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to a 2d circle and a curve and having the center ON a 2d curve. Param2 is the initial guess on the curve QualifiedCurv. ParamOn is the initial guess on the center curve OnCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnCurv
    • Param1
    • Param2
    • ParamOn
    • Tolerance
  • constructor(Qualified1: GccEnt_QualifiedLin, Qualified2: Geom2dGcc_QCurve, OnCurve: Geom2dAdaptor_Curve, Param1: number, Param2: number, ParamOn: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to a 2d line and a curve and having the center ON a 2d curve. Param2 is the initial guess on the curve QualifiedCurv. ParamOn is the initial guess on the center curve OnCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnCurve
    • Param1
    • Param2
    • ParamOn
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QCurve, Qualified2: Geom2dGcc_QCurve, OnCurve: Geom2dAdaptor_Curve, Param1: number, Param2: number, ParamOn: number, Tolerance: number): Geom2dGcc_Circ2d2TanOnIter

    This method implements the algorithms used to create 2d circles TANgent to two curves and having the center ON a 2d curve. Param1 is the initial guess on the first curve QualifiedCurv. Param1 is the initial guess on the second curve QualifiedCurv. ParamOn is the initial guess on the center curve OnCurv. Tolerance is used for the limit cases.

    Parameters (7)
    • Qualified1
    • Qualified2
    • OnCurve
    • Param1
    • Param2
    • ParamOn
    • Tolerance

Instance methods(8)

  • IsDone(): boolean

    This method returns True if the construction algorithm succeeded.

  • ThisSolution(): gp_Circ2d

    Returns the solution. It raises NotDone if the construction algorithm didn't succeed.

  • WhichQualifier(Qualif1?: GccEnt_Position, Qualif2?: GccEnt_Position): { Qualif1: GccEnt_Position; Qualif2: GccEnt_Position }
    Parameters (2)
    • Qualif1
    • Qualif2
  • Tangency1(ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information 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. It raises NotDone if the construction algorithm didn't succeed.

    Parameters (3)
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency2(ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the result 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. It raises NotDone if the construction algorithm didn't succeed.

    Parameters (3)
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • CenterOn3(ParArg: number, PntSol: gp_Pnt2d): { ParArg: number }

    Returns information about the center (on the curv) of the result and the third argument. It raises NotDone if the construction algorithm didn't succeed.

    Parameters (2)
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParArg: updated value from the call.
  • IsTheSame1(): boolean

    It raises NotDone if the construction algorithm didn't succeed.

  • IsTheSame2(): boolean

    It raises NotDone if the construction algorithm didn't succeed.

Geom2dGcc_Circ2d2TanRad

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 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.

Constructors(3)

  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Qualified2: Geom2dGcc_QualifiedCurve, Radius: number, Tolerance: number): Geom2dGcc_Circ2d2TanRad
    Parameters (4)
    • Qualified1
    • Qualified2
    • Radius
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Point: Geom2d_Point, Radius: number, Tolerance: number): Geom2dGcc_Circ2d2TanRad
    Parameters (4)
    • Qualified1
    • Point
    • Radius
    • Tolerance
  • constructor(Point1: Geom2d_Point, Point2: Geom2d_Point, Radius: number, Tolerance: number): Geom2dGcc_Circ2d2TanRad

    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.
    Parameters (4)
    • Point1
    • Point2
    • Radius
    • Tolerance

Instance methods(10)

  • Results(Circ: GccAna_Circ2d2TanRad): void
    Parameters (1)
    • Circ
  • Results(Circ: Geom2dGcc_Circ2d2TanRadGeo): void
    Parameters (1)
    • Circ
  • IsDone(): boolean

    This method returns True if the algorithm succeeded. Note: IsDone protects against a failure arising from a more internal intersection algorithm, which has reached its numeric limits.

  • NbSolutions(): number

    This method returns the number of solutions. NotDone is raised if the algorithm failed. Exceptions StdFail_NotDone if the construction fails.

  • ThisSolution(Index: number): gp_Circ2d

    Returns the solution number Index and raises OutOfRange exception if Index is greater than the number of solutions. Be careful: the Index is only a way to get all the solutions, but is not associated to these 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.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position, Qualif2?: GccEnt_Position): { Qualif1: GccEnt_Position; Qualif2: GccEnt_Position }

    Returns the qualifiers Qualif1 and Qualif2 of the 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.
    Parameters (3)
    • Index
    • Qualif1
    • Qualif2
    Returns

    A result object with fields:

    • Qualif1: updated value from the call.
    • Qualif2: updated value from the call.
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

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

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency2(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

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

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • IsTheSame1(Index: number): boolean

    Returns true if the solution of index Index and, 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.

    Parameters (1)
    • Index
  • IsTheSame2(Index: number): boolean

    Returns true if the solution of index Index and, 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.

    Parameters (1)
    • Index

Geom2dGcc_Circ2d2TanRadGeo

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 following case : Cu2 is inside C1 and there is no intersection point between the two elements. With Tolerance we will get a solution if the lowest distance between C1 and Cu2 is lower than or equal Tolerance.

Constructors(4)

  • constructor(Qualified1: GccEnt_QualifiedCirc, Qualified2: Geom2dGcc_QCurve, Radius: number, Tolerance: number): Geom2dGcc_Circ2d2TanRadGeo

    This method implements the algorithms used to create 2d circles TANgent to a 2d circle and a curve with a radius of Radius. It raises NegativeValue if Radius is lower than zero.

    Parameters (4)
    • Qualified1
    • Qualified2
    • Radius
    • Tolerance
  • constructor(Qualified1: GccEnt_QualifiedLin, Qualified2: Geom2dGcc_QCurve, Radius: number, Tolerance: number): Geom2dGcc_Circ2d2TanRadGeo

    This method implements the algorithms used to create 2d circles TANgent to a 2d line and a curve with a radius of Radius. It raises NegativeValue if Radius is lower than zero.

    Parameters (4)
    • Qualified1
    • Qualified2
    • Radius
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QCurve, Qualified2: Geom2dGcc_QCurve, Radius: number, Tolerance: number): Geom2dGcc_Circ2d2TanRadGeo

    This method implements the algorithms used to create 2d circles TANgent to two curves with a radius of Radius. It raises NegativeValue if Radius is lower than zero.

    Parameters (4)
    • Qualified1
    • Qualified2
    • Radius
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QCurve, Point2: gp_Pnt2d, Radius: number, Tolerance: number): Geom2dGcc_Circ2d2TanRadGeo

    This method implements the algorithms used to create 2d circles TANgent to a curve and a point with a radius of Radius. It raises NegativeValue if Radius is lower than zero.

    Parameters (4)
    • Qualified1
    • Point2
    • Radius
    • Tolerance

Instance methods(8)

  • IsDone(): boolean

    This method returns True if the algorithm succeeded.

  • NbSolutions(): number

    This method returns the number of solutions. It raises NotDone if the algorithm failed.

  • ThisSolution(Index: number): gp_Circ2d

    Returns the solution number Index. Be careful: the Index is only a way to get all the solutions, but is not associated to those outside the context of the algorithm-object. It raises OutOfRange exception if Index is greater than the number of solutions. It raises NotDone if the construction algorithm did not succeed.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position, Qualif2?: GccEnt_Position): { Qualif1: GccEnt_Position; Qualif2: GccEnt_Position }

    It returns the information about the qualifiers of the tangency arguments concerning the solution number Index. It returns the real qualifiers (the qualifiers given to the constructor method in case of enclosed, enclosing and outside and the qualifiers computedin case of unqualified).

    Parameters (3)
    • Index
    • Qualif1
    • Qualif2
    Returns

    A result object with fields:

    • Qualif1: updated value from the call.
    • Qualif2: updated value from the call.
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the result number Index and the first argument. ParSol is the intrinsic parameter of the point PntSol on the solution. ParArg is the intrinsic parameter of the point PntSol on the first argument. It raises OutOfRange if Index is greater than the number of solutions. It raises NotDone if the construction algorithm did not succeed.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency2(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the result number Index and the second argument. ParSol is the intrinsic parameter of the point PntSol on the solution. ParArg is the intrinsic parameter of the point PntArg on the second argument. It raises OutOfRange if Index is greater than the number of solutions. It raises NotDone if the construction algorithm did not succeed.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • IsTheSame1(Index: number): boolean

    Returns True if the solution number Index is equal to the first argument. It raises OutOfRange if Index is greater than the number of solutions. It raises NotDone if the construction algorithm did not succeed.

    Parameters (1)
    • Index
  • IsTheSame2(Index: number): boolean

    Returns True if the solution number Index is equal to the second argument. It raises OutOfRange if Index is greater than the number of solutions. It raises NotDone if the construction algorithm did not succeed.

    Parameters (1)
    • Index

Geom2dGcc_Circ2d3Tan

This class implements the algorithms used to create 2d circles tangent to 3 points/lines/circles/ curves with one curve or more. The arguments of all construction methods are :

  • The three qualifiied elements for the tangency constrains (QualifiedCirc, QualifiedLine, Qualifiedcurv, Points).
  • A parameter for each QualifiedCurv. Describes functions for building a 2D circle:
  • tangential to 3 curves, or
  • tangential to 2 curves and passing through a point, or
  • tangential to a curve and passing through 2 points, or
  • passing through 3 points. A Circ2d3Tan object provides a framework for:
  • defining the construction of 2D circles(s),
  • implementing the construction algorithm, and
  • consulting the result(s).

Constructors(4)

  • constructor(Point1: Geom2d_Point, Point2: Geom2d_Point, Point3: Geom2d_Point, Tolerance: number): Geom2dGcc_Circ2d3Tan

    Constructs one or more 2D circles passing through three points Point1, Point2 and Point3. 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; and
    • a circle C3 outside C1.
      You now want to find a circle which is tangential to C1, C2 and C3: 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, the algorithm finds a solution. Warning An iterative algorithm is used if Qualified1, Qualified2 or Qualified3 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, enclosing for a line).
    Parameters (4)
    • Point1
    • Point2
    • Point3
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Point1: Geom2d_Point, Point2: Geom2d_Point, Tolerance: number, Param1: number): Geom2dGcc_Circ2d3Tan

    Constructs one or more 2D circles tangential to the curve Qualified1 and passing through two points Point1 and Point2, where Param1 is used as the initial value of the parameter on Qualified1 of the tangency point between this argument and the solution sought, if the algorithm chooses an iterative method to find the solution (i.e. if Qualified1 is more complex than a line or a circle)

    Parameters (5)
    • Qualified1
    • Point1
    • Point2
    • Tolerance
    • Param1
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Qualified2: Geom2dGcc_QualifiedCurve, Point: Geom2d_Point, Tolerance: number, Param1: number, Param2: number): Geom2dGcc_Circ2d3Tan

    Constructs one or more 2D circles tangential to two curves Qualified1 and Qualified2 and passing through the point Point, where Param1 and Param2 are used, respectively, as the initial values of the parameters on Qualified1 and Qualified2 of the tangency point between this argument and the solution sought, if the algorithm chooses an iterative method to find the solution (i.e. if either Qualified1 or Qualified2 is more complex than a line or a circle).

    Parameters (6)
    • Qualified1
    • Qualified2
    • Point
    • Tolerance
    • Param1
    • Param2
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Qualified2: Geom2dGcc_QualifiedCurve, Qualified3: Geom2dGcc_QualifiedCurve, Tolerance: number, Param1: number, Param2: number, Param3: number): Geom2dGcc_Circ2d3Tan

    Constructs one or more 2D circles tangential to three curves Qualified1, Qualified2 and Qualified3, where Param1, Param2 and Param3 are used, respectively, as the initial values of the parameters on Qualified1, Qualified2 and Qualified3 of the tangency point between these arguments and the solution sought, if the algorithm chooses an iterative method to find the solution (i.e. if either Qualified1, Qualified2 or Qualified3 is more complex than a line or a circle).

    Parameters (7)
    • Qualified1
    • Qualified2
    • Qualified3
    • Tolerance
    • Param1
    • Param2
    • Param3

Instance methods(11)

  • Results(Circ: GccAna_Circ2d3Tan, Rank1: number, Rank2: number, Rank3: number): void
    Parameters (4)
    • Circ
    • Rank1
    • Rank2
    • Rank3
  • IsDone(): boolean

    Returns true if the construction algorithm does not fail (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.

  • NbSolutions(): number

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

  • ThisSolution(Index: number): gp_Circ2d

    Returns the solution number Index and raises OutOfRange exception if Index is greater than the number of solutions. Be careful: the Index is only a way to get all the solutions, but is not associated to these outside the context of the algorithm-object.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position, Qualif2?: GccEnt_Position, Qualif3?: GccEnt_Position): { Qualif1: GccEnt_Position; Qualif2: GccEnt_Position; Qualif3: GccEnt_Position }

    It returns the information about the qualifiers of the tangency arguments concerning the solution number Index. It returns the real qualifiers (the qualifiers given to the constructor method in case of enclosed, enclosing and outside and the qualifiers computedin case of unqualified).

    Parameters (4)
    • Index
    • Qualif1
    • Qualif2
    • Qualif3
    Returns

    A result object with fields:

    • Qualif1: updated value from the call.
    • Qualif2: updated value from the call.
    • Qualif3: updated value from the call.
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information 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.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency2(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

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

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency3(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

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

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • IsTheSame1(Index: number): boolean

    Returns True if the solution is equal to the first argument.

    Parameters (1)
    • Index
  • IsTheSame2(Index: number): boolean

    Returns True if the solution is equal to the second argument.

    Parameters (1)
    • Index
  • IsTheSame3(Index: number): boolean

    Returns True if the solution is equal to the third argument. If Rarg is the radius of the first, second or third 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. 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.

    Parameters (1)
    • Index

Geom2dGcc_Circ2d3TanIter

This class implements the algorithms used to create 2d circles tangent to 3 points/lines/circles/ curves with one curve or more. The arguments of all construction methods are :

  • The three qualifiied elements for the tangency constrains (QualifiedCirc, QualifiedLine, Qualifiedcurv, Points).
  • A parameter for each QualifiedCurv.

Constructors(10)

Instance methods(9)

  • IsDone(): boolean

    This method returns True if the construction algorithm succeeded.

  • ThisSolution(): gp_Circ2d

    Returns the solution. It raises NotDone if the construction algorithm didn't succeed.

  • WhichQualifier(Qualif1?: GccEnt_Position, Qualif2?: GccEnt_Position, Qualif3?: GccEnt_Position): { Qualif1: GccEnt_Position; Qualif2: GccEnt_Position; Qualif3: GccEnt_Position }
    Parameters (3)
    • Qualif1
    • Qualif2
    • Qualif3
  • Tangency1(ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information 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. It raises NotDone if the construction algorithm didn't succeed.

    Parameters (3)
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency2(ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the result 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. It raises NotDone if the construction algorithm didn't succeed.

    Parameters (3)
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency3(ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the result and the third 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. It raises NotDone if the construction algorithm didn't succeed.

    Parameters (3)
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • IsTheSame1(): boolean

    It raises NotDone if the construction algorithm didn't succeed.

  • IsTheSame2(): boolean

    It raises NotDone if the construction algorithm didn't succeed.

  • IsTheSame3(): boolean

    It raises NotDone if the construction algorithm didn't succeed.

Geom2dGcc_Circ2dTanCen

This class implements the algorithms used to create 2d circles tangent to a curve and centered on a point. The arguments of all construction methods are :

  • The qualified element for the tangency constrains (QualifiedCurv). -The center point Pcenter.
  • A real Tolerance. Tolerance is only used in the limits cases. For example : We want to create a circle tangent to an EnclosedCurv C1 with a tolerance Tolerance. If we did not used Tolerance it is impossible to find a solution in the following case : Pcenter is outside C1. With Tolerance we will give a solution if the distance between C1 and Pcenter is lower than or equal Tolerance/2.

Constructors(1)

  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Pcenter: Geom2d_Point, Tolerance: number): Geom2dGcc_Circ2dTanCen

    Constructs one or more 2D circles tangential to the curve Qualified1 and centered on the point Pcenter. 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.
    Tolerance is only used in these algorithms in very specific cases where the center of the solution is very close to the circle to which it is tangential, and where the solution is thus a very small circle. Exceptions GccEnt_BadQualifier if a qualifier is inconsistent with the argument it qualifies (for example, enclosing for a line).

    Parameters (3)
    • Qualified1
    • Pcenter
    • Tolerance

Instance methods(6)

  • IsDone(): boolean

    Returns true if the construction algorithm does not fail (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.

  • NbSolutions(): number

    Returns the number of circles, representing solutions computed by this algorithm. Exceptions StdFail_NotDone if the construction fails.

  • ThisSolution(Index: number): gp_Circ2d

    Returns a circle, representing the solution of index Index computed by this algorithm. 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.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position): { Qualif1: GccEnt_Position }

    Returns the qualifier Qualif1 of the tangency argument 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 enclosed, enclosing or outside with respect to the argument, or
    • that computed during construction (i.e. enclosed, enclosing or outside) when the solutions are defined as unqualified with respect to the argument. 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.
    Parameters (2)
    • Index
    • Qualif1
    Returns

    A result object with fields:

    • Qualif1: updated value from the call.
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

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

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • IsTheSame1(Index: number): boolean

    Returns true if the solution of index Index and the first argument of this algorithm are the same (i.e. there are 2 identical circles). If Rarg is the radius of the first 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. NotDone is raised if the construction algorithm didn't succeed. OutOfRange is raised if Index is greater than the number of solutions.

    Parameters (1)
    • Index

Geom2dGcc_Circ2dTanCenGeo

This class implements the algorithms used to create 2d circles tangent to a curve and centered on a point. The arguments of all construction methods are :

  • The qualified element for the tangency constrains (QualifiedCurv). -The center point Pcenter.
  • A real Tolerance. Tolerance is only used in the limits cases. For example : We want to create a circle tangent to an EnclosedCurv C1 with a tolerance Tolerance. If we did not use Tolerance it is impossible to find a solution in the following case : Pcenter is outside C1. With Tolerance we will give a solution if the distance between C1 and Pcenter is lower than or equal Tolerance/2.

Constructors(1)

Instance methods(5)

  • IsDone(): boolean

    This method returns True if the construction algorithm succeeded.

  • NbSolutions(): number

    Returns the number of solutions and raises NotDone exception if the algorithm didn't succeed. It raises NotDone if the construction algorithm didn't succeed.

  • ThisSolution(Index: number): gp_Circ2d

    Returns the solution number Index and raises OutOfRange exception if Index is greater than the number of solutions. Be careful: the Index is only a way to get all the solutions, but is not associated to these outside the context of the algorithm-object. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions or less than zero.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position): { Qualif1: GccEnt_Position }
    Parameters (2)
    • Index
    • Qualif1
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the 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 PntArg on the argument curv. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions or less than zero.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.

Geom2dGcc_Circ2dTanOnRad

This class implements the algorithms used to create a 2d circle tangent to a 2d entity, centered on a 2d entity and with a given radius. More than one argument must be a curve. The arguments of all construction methods are :

  • The qualified element for the tangency constrains (QualifiedCirc, QualifiedLin, QualifiedCurvPoints).
  • The Center element (circle, line, curve).
  • A real Tolerance. Tolerance is only used in the limits cases. For example : We want to create a circle tangent to an OutsideCurv Cu1 centered on a line OnLine with a radius Radius and with a tolerance Tolerance. If we did not used Tolerance it is impossible to find a solution in the following case : OnLine is outside Cu1. There is no intersection point between Cu1 and OnLine. The distance between the line and the circle is greater than Radius. With Tolerance we will give a solution if the distance between Cu1 and OnLine is lower than or equal Tolerance.

Constructors(2)

  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, OnCurv: Geom2dAdaptor_Curve, Radius: number, Tolerance: number): Geom2dGcc_Circ2dTanOnRad

    Constructs one or more 2D circles of radius Radius, centered on the 2D curve OnCurv and:

    • tangential to the curve Qualified1
    Parameters (4)
    • Qualified1
    • OnCurv
    • Radius
    • Tolerance
  • constructor(Point1: Geom2d_Point, OnCurv: Geom2dAdaptor_Curve, Radius: number, Tolerance: number): Geom2dGcc_Circ2dTanOnRad

    Constructs one or more 2D circles of radius Radius, centered on the 2D curve OnCurv and: passing through the point Point1. OnCurv is an adapted curve, i.e. an object which is an interface between:

    • the services provided by a 2D curve from the package Geom2d,
    • and those required on the curve by the construction algorithm. Similarly, the qualified curve Qualified1 is created from an adapted curve.
      Adapted curves are created in the following way: occ::handle<Geom2d_Curve> myCurveOn = ... ; Geom2dAdaptor_Curve OnCurv ( myCurveOn ) ; The algorithm is then constructed with this object: occ::handle<Geom2d_Curve> myCurve1 = ... ; Geom2dAdaptor_Curve Adapted1 ( myCurve1 ) ; Geom2dGcc_QualifiedCurve Qualified1 = Geom2dGcc::Outside(Adapted1); double Radius = ... , Tolerance = ... ; Geom2dGcc_Circ2dTanOnRad myAlgo ( Qualified1 , OnCurv , Radius , Tolerance ) ; if ( myAlgo.IsDone() ) { int Nbr = myAlgo.NbSolutions() ; gp_Circ2d Circ ; for ( int i = 1 ; i <= nbr ; i++ ) { Circ = myAlgo.ThisSolution (i) ; ... } }
    Parameters (4)
    • Point1
    • OnCurv
    • Radius
    • Tolerance

Instance methods(9)

  • Results(Circ: GccAna_Circ2dTanOnRad): void
    Parameters (1)
    • Circ
  • Results(Circ: Geom2dGcc_Circ2dTanOnRadGeo): void
    Parameters (1)
    • Circ
  • IsDone(): boolean

    Returns true if the construction algorithm does not fail (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.

  • NbSolutions(): number

    Returns the number of circles, representing solutions computed by this algorithm. Exceptions: StdFail_NotDone if the construction fails.

  • ThisSolution(Index: number): gp_Circ2d

    Returns the solution number Index and raises OutOfRange exception if Index is greater than the number of solutions. Be careful: the Index is only a way to get all the solutions, but is not associated to these 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.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position): { Qualif1: GccEnt_Position }

    Returns the qualifier Qualif1 of the tangency argument 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 enclosed, enclosing or outside with respect to the arguments, or
    • that 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. 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.
    Parameters (2)
    • Index
    • Qualif1
    Returns

    A result object with fields:

    • Qualif1: updated value from the call.
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the result number Index and the first argument. ParSol is the intrinsic parameter of the point on the solution curv. ParArg is the intrinsic parameter of the point on the argument curv. PntSol is the tangency point on the solution curv. PntArg is the tangency point on the argument curv. 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.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • CenterOn3(Index: number, ParArg: number, PntSol: gp_Pnt2d): { ParArg: number }

    Returns the center PntSol on the second argument (i.e. line or circle) of the solution of index Index computed by this algorithm. ParArg is the intrinsic parameter of the point on the argument curv. PntSol is the center point of the solution curv. PntArg is the projection of PntSol on the argument curv. 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.

    Parameters (3)
    • Index
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParArg: updated value from the call.
  • IsTheSame1(Index: number): boolean

    Returns true if the solution of index Index and the first argument of this algorithm are the same (i.e. there are 2 identical circles). If Rarg is the radius of the first 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.

    Parameters (1)
    • Index

Geom2dGcc_Circ2dTanOnRadGeo

This class implements the algorithms used to create a 2d circle tangent to a 2d entity, centered on a 2d entity and with a given radius. More than one argument must be a curve. The arguments of all construction methods are :

  • The qualified element for the tangency constrains (QualifiedCirc, QualifiedLin, QualifiedCurvPoints).
  • The Center element (circle, line, curve).
  • A real Tolerance. Tolerance is only used in the limits cases. For example : We want to create a circle tangent to an OutsideCurv Cu1 centered on a line OnLine with a radius Radius and with a tolerance Tolerance. If we did not use Tolerance it is impossible to find a solution in the following case : OnLine is outside Cu1. There is no intersection point between Cu1 and OnLine. The distance between the line and the circle is greater than Radius. With Tolerance we will give a solution if the distance between Cu1 and OnLine is lower than or equal Tolerance.

Constructors(6)

  • constructor(Qualified1: Geom2dGcc_QCurve, OnLine: gp_Lin2d, Radius: number, Tolerance: number): Geom2dGcc_Circ2dTanOnRadGeo

    This methods implements the algorithms used to create 2d Circles tangent to a curve and centered on a 2d Line with a given radius. Tolerance is used to find solution in every limit cases. raises NegativeValue in case of NegativeRadius.

    Parameters (4)
    • Qualified1
    • OnLine
    • Radius
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QCurve, OnCirc: gp_Circ2d, Radius: number, Tolerance: number): Geom2dGcc_Circ2dTanOnRadGeo

    This methods implements the algorithms used to create 2d Circles tangent to a curve and centered on a 2d Circle with a given radius. Tolerance is used to find solution in every limit cases. raises NegativeValue in case of NegativeRadius.

    Parameters (4)
    • Qualified1
    • OnCirc
    • Radius
    • Tolerance
  • constructor(Qualified1: GccEnt_QualifiedCirc, OnCurv: Geom2dAdaptor_Curve, Radius: number, Tolerance: number): Geom2dGcc_Circ2dTanOnRadGeo

    This methods implements the algorithms used to create 2d Circles tangent to a circle and centered on a 2d curve with a given radius. Tolerance is used to find solution in every limit cases. raises NegativeValue in case of NegativeRadius.

    Parameters (4)
    • Qualified1
    • OnCurv
    • Radius
    • Tolerance
  • constructor(Qualified1: GccEnt_QualifiedLin, OnCurv: Geom2dAdaptor_Curve, Radius: number, Tolerance: number): Geom2dGcc_Circ2dTanOnRadGeo

    This methods implements the algorithms used to create 2d Circles tangent to a 2d Line and centered on a 2d curve with a given radius. Tolerance is used to find solution in every limit cases. raises NegativeValue in case of NegativeRadius.

    Parameters (4)
    • Qualified1
    • OnCurv
    • Radius
    • Tolerance
  • constructor(Qualified1: Geom2dGcc_QCurve, OnCurv: Geom2dAdaptor_Curve, Radius: number, Tolerance: number): Geom2dGcc_Circ2dTanOnRadGeo

    This methods implements the algorithms used to create 2d Circles tangent to a 2d curve and centered on a 2d curve with a given radius. Tolerance is used to find solution in every limit cases. raises NegativeValue in case of NegativeRadius.

    Parameters (4)
    • Qualified1
    • OnCurv
    • Radius
    • Tolerance
  • constructor(Point1: gp_Pnt2d, OnCurv: Geom2dAdaptor_Curve, Radius: number, Tolerance: number): Geom2dGcc_Circ2dTanOnRadGeo

    This methods implements the algorithms used to create 2d Circles passing through a 2d point and centered on a 2d curve with a given radius. Tolerance is used to find solution in every limit cases. raises NegativeValue in case of NegativeRadius.

    Parameters (4)
    • Point1
    • OnCurv
    • Radius
    • Tolerance

Instance methods(7)

  • IsDone(): boolean

    This method returns True if the construction algorithm succeeded.

  • NbSolutions(): number

    This method returns the number of solutions. It raises NotDone if the construction algorithm didn't succeed.

  • ThisSolution(Index: number): gp_Circ2d

    Returns the solution number Index and raises OutOfRange exception if Index is greater than the number of solutions. Be careful: the Index is only a way to get all the solutions, but is not associated to these outside the context of the algorithm-object. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position): { Qualif1: GccEnt_Position }
    Parameters (2)
    • Index
    • Qualif1
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information about the tangency point between the result number Index and the first argument. ParSol is the intrinsic parameter of the point on the solution curv. ParArg is the intrinsic parameter of the point on the argument curv. PntSol is the tangency point on the solution curv. PntArg is the tangency point on the argument curv. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • CenterOn3(Index: number, ParArg: number, PntSol: gp_Pnt2d): { ParArg: number }

    Returns information about the center (on the curv) of the result. ParArg is the intrinsic parameter of the point on the argument curv. PntSol is the center point of the solution curv. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (3)
    • Index
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParArg: updated value from the call.
  • IsTheSame1(Index: number): boolean

    Returns True if the solution number Index is equal to the first argument and False in the other cases. It raises NotDone if the construction algorithm didn't succeed. It raises OutOfRange if Index is greater than the number of solutions.

    Parameters (1)
    • Index

Geom2dGcc_CurveTool

Constructors(1)

Static methods(8)

Geom2dGcc_FunctionTanCirCu

math_FunctionWithDerivativemath_Function

This abstract class describes a Function of 1 Variable used to find a line tangent to a curve and a circle.

Constructors(1)

Instance methods(3)

  • Value(X: number, F: number): { returnValue: boolean; F: number }

    Computes the value of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

    Parameters (2)
    • X
    • F
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • F: updated value from the call.
  • Derivative(X: number, D: number): { returnValue: boolean; D: number }

    Computes the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

    Parameters (2)
    • X
    • D
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • D: updated value from the call.
  • Values(X: number, F: number, D: number): { returnValue: boolean; F: number; D: number }

    Computes the value and the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

    Parameters (3)
    • X
    • F
    • D
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • F: updated value from the call.
    • D: updated value from the call.

Geom2dGcc_FunctionTanCuCu

math_FunctionSetWithDerivativesmath_FunctionSet

This abstract class describes a Function of 1 Variable used to find a line tangent to two curves.

Constructors(2)

Instance methods(6)

Geom2dGcc_FunctionTanCuCuOnCu

math_FunctionSetWithDerivativesmath_FunctionSet

This abstract class describes a set on N Functions of M independent variables.

Constructors(12)

Instance methods(6)

Geom2dGcc_FunctionTanCuPnt

math_FunctionWithDerivativemath_Function

This abstract class describes a Function of 1 Variable used to find a line tangent to a curve and passing through a point.

Constructors(1)

Instance methods(3)

  • Value(X: number, F: number): { returnValue: boolean; F: number }

    Computes the value of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

    Parameters (2)
    • X
    • F
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • F: updated value from the call.
  • Derivative(X: number, D: number): { returnValue: boolean; D: number }

    Computes the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

    Parameters (2)
    • X
    • D
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • D: updated value from the call.
  • Values(X: number, F: number, D: number): { returnValue: boolean; F: number; D: number }

    Computes the value and the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

    Parameters (3)
    • X
    • F
    • D
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • F: updated value from the call.
    • D: updated value from the call.

Geom2dGcc_FunctionTanObl

math_FunctionWithDerivativemath_Function

This class describe a function of a single variable.

Constructors(1)

Instance methods(3)

  • Value(X: number, F: number): { returnValue: boolean; F: number }

    Computes the value of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

    Parameters (2)
    • X
    • F
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • F: updated value from the call.
  • Derivative(X: number, D: number): { returnValue: boolean; D: number }

    Computes the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

    Parameters (2)
    • X
    • D
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • D: updated value from the call.
  • Values(X: number, F: number, D: number): { returnValue: boolean; F: number; D: number }

    Computes the value and the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

    Parameters (3)
    • X
    • F
    • D
    Returns

    A result object with fields:

    • returnValue: the C++ return value
    • F: updated value from the call.
    • D: updated value from the call.

Geom2dGcc_Lin2d2Tan

This class implements the algorithms used to create 2d lines tangent to 2 other elements which can be circles, curves or points. More than one argument must be a curve. Describes functions for building a 2D line:

  • tangential to 2 curves, or
  • tangential to a curve and passing through a point. A Lin2d2Tan object provides a framework for:
  • defining the construction of 2D line(s),
  • implementing the construction algorithm, and
  • consulting the result(s).
    Note: Some constructors may check the type of the qualified argument and raise BadQualifier Error in case of incorrect couple (qualifier, curv).

Constructors(4)

  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Qualified2: Geom2dGcc_QualifiedCurve, Tolang: number): Geom2dGcc_Lin2d2Tan

    This class implements the algorithms used to create 2d line tangent to two curves. Tolang is used to determine the tolerance for the tangency points.

    Parameters (3)
    • Qualified1
    • Qualified2
    • Tolang
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, ThePoint: gp_Pnt2d, Tolang: number): Geom2dGcc_Lin2d2Tan

    This class implements the algorithms used to create 2d lines passing through a point and tangent to a curve. Tolang is used to determine the tolerance for the tangency points.

    Parameters (3)
    • Qualified1
    • ThePoint
    • Tolang
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, ThePoint: gp_Pnt2d, Tolang: number, Param1: number): Geom2dGcc_Lin2d2Tan

    This class implements the algorithms used to create 2d lines passing through a point and tangent to a curve. Tolang is used to determine the tolerance for the tangency points. Param2 is used for the initial guess on the curve.

    Parameters (4)
    • Qualified1
    • ThePoint
    • Tolang
    • Param1
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, Qualified2: Geom2dGcc_QualifiedCurve, Tolang: number, Param1: number, Param2: number): Geom2dGcc_Lin2d2Tan

    This class implements the algorithms used to create 2d line tangent to two curves. Tolang is used to determine the tolerance for the tangency points. Param1 is used for the initial guess on the first curve. Param2 is used for the initial guess on the second curve.

    Parameters (5)
    • Qualified1
    • Qualified2
    • Tolang
    • Param1
    • Param2

Instance methods(6)

  • IsDone(): boolean

    Returns true if the construction algorithm does not fail (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.

  • NbSolutions(): number

    Returns the number of lines, representing solutions computed by this algorithm. Exceptions StdFail_NotDone if the construction fails.R.

  • ThisSolution(Index: number): gp_Lin2d

    Returns a line, representing the solution of index Index computed by this algorithm. 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.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position, Qualif2?: GccEnt_Position): { Qualif1: GccEnt_Position; Qualif2: GccEnt_Position }

    Returns the qualifiers Qualif1 and Qualif2 of the 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 enclosing or outside with respect to the arguments, or
    • those computed during construction (i.e. 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. 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.
    Parameters (3)
    • Index
    • Qualif1
    • Qualif2
    Returns

    A result object with fields:

    • Qualif1: updated value from the call.
    • Qualif2: updated value from the call.
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information 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. 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.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency2(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information 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. 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.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.

Geom2dGcc_Lin2d2TanIter

This class implements the algorithms used to create 2d lines tangent to 2 other elements which can be circles, curves or points. More than one argument must be a curve.
Note: Some constructors may check the type of the qualified argument and raise BadQualifier Error in case of incorrect couple (qualifier, curv). For example: "EnclosedCirc".

Constructors(3)

  • constructor(Qualified1: Geom2dGcc_QCurve, ThePoint: gp_Pnt2d, Param1: number, Tolang: number): Geom2dGcc_Lin2d2TanIter

    This class implements the algorithms used to create 2d lines passing through a point and tangent to a curve. Tolang is used to determine the tolerance for the tangency points. Param2 is used for the initial guess on the curve.

    Parameters (4)
    • Qualified1
    • ThePoint
    • Param1
    • Tolang
  • constructor(Qualified1: GccEnt_QualifiedCirc, Qualified2: Geom2dGcc_QCurve, Param2: number, Tolang: number): Geom2dGcc_Lin2d2TanIter

    This class implements the algorithms used to create 2d line tangent to a circle and to a curve. Tolang is used to determine the tolerance for the tangency points. Param2 is used for the initial guess on the curve. Exception BadQualifier is raised in the case of EnclosedCirc.

    Parameters (4)
    • Qualified1
    • Qualified2
    • Param2
    • Tolang
  • constructor(Qualified1: Geom2dGcc_QCurve, Qualified2: Geom2dGcc_QCurve, Param1: number, Param2: number, Tolang: number): Geom2dGcc_Lin2d2TanIter

    This class implements the algorithms used to create 2d line tangent to two curves. Tolang is used to determine the tolerance for the tangency points. Param1 is used for the initial guess on the first curve. Param2 is used for the initial guess on the second curve.

    Parameters (5)
    • Qualified1
    • Qualified2
    • Param1
    • Param2
    • Tolang

Instance methods(5)

  • IsDone(): boolean

    This methode returns true when there is a solution and false in the other cases.

  • ThisSolution(): gp_Lin2d

    Returns the solution.

  • WhichQualifier(Qualif1?: GccEnt_Position, Qualif2?: GccEnt_Position): { Qualif1: GccEnt_Position; Qualif2: GccEnt_Position }
    Parameters (2)
    • Qualif1
    • Qualif2
  • Tangency1(ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information 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.

    Parameters (3)
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Tangency2(ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }
    Parameters (3)
    • ParSol
    • ParArg
    • PntSol

Geom2dGcc_Lin2dTanObl

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:

  • defining the construction of 2D line(s),
  • implementing the construction algorithm, and
  • consulting the result(s).

Constructors(2)

  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, TheLin: gp_Lin2d, TolAng: number, Angle: number): Geom2dGcc_Lin2dTanObl

    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.

    Parameters (4)
    • Qualified1
    • TheLin
    • TolAng
    • Angle
  • constructor(Qualified1: Geom2dGcc_QualifiedCurve, TheLin: gp_Lin2d, TolAng: number, Param1: number, Angle: number): Geom2dGcc_Lin2dTanObl

    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. Param2 is the initial guess on the curve QualifiedCurv. Tolang is the angular tolerance. 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).

    Parameters (5)
    • Qualified1
    • TheLin
    • TolAng
    • Param1
    • Angle

Instance methods(6)

  • IsDone(): boolean

    Returns true if the construction algorithm does not fail (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.

  • NbSolutions(): number

    Returns the number of lines, representing solutions computed by this algorithm. Exceptions StdFail_NotDone if the construction fails.

  • ThisSolution(Index: number): gp_Lin2d

    Returns a line, representing the solution of index Index 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.

    Parameters (1)
    • Index
  • WhichQualifier(Index: number, Qualif1?: GccEnt_Position): { Qualif1: GccEnt_Position }

    Returns the qualifier Qualif1 of the tangency argument 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.
    Parameters (2)
    • Index
    • Qualif1
    Returns

    A result object with fields:

    • Qualif1: updated value from the call.
  • Tangency1(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns information 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.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.
  • Intersection2(Index: number, ParSol: number, ParArg: number, PntSol: gp_Pnt2d): { ParSol: number; ParArg: number }

    Returns the point of intersection PntSol between the 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. Geom2dGcc_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.

    Parameters (4)
    • Index
    • ParSol
    • ParArg
    • PntSol —
      Mutated in place; read the updated value from this argument after the call.
    Returns

    A result object with fields:

    • ParSol: updated value from the call.
    • ParArg: updated value from the call.

Geom2dGcc_Lin2dTanOblIter

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.

Constructors(1)

  • constructor(Qualified1: Geom2dGcc_QCurve, TheLin: gp_Lin2d, Param1: number, TolAng: number, Angle?: number): Geom2dGcc_Lin2dTanOblIter

    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. Param2 is the initial guess on the curve QualifiedCurv. Tolang is the angular tolerance.

    Parameters (5)
    • Qualified1
    • TheLin
    • Param1
    • TolAng
    • Angle

Instance methods(6)

Geom2dGcc_QCurve

Creates a qualified 2d line.

Constructors(1)

Instance methods(6)

Geom2dGcc_QualifiedCurve

Describes functions for building a qualified 2D curve. A qualified 2D curve is a curve with a qualifier which specifies whether the solution of a construction algorithm using the qualified curve (as an argument):

  • encloses the curve, or
  • is enclosed by the curve, or
  • is built so that both the curve and it are external to one another, or
  • is undefined (all solutions apply).

Constructors(1)

  • constructor(Curve: Geom2dAdaptor_Curve, Qualifier: GccEnt_Position): Geom2dGcc_QualifiedCurve

    Constructs a qualified curve by assigning the qualifier Qualifier to the curve Curve. Qualifier may be:

    • GccEnt_enclosing if the solution of a construction algorithm using the qualified curve encloses the curve, or
    • GccEnt_enclosed if the solution is enclosed by the curve, or
    • GccEnt_outside if both the solution and the curve are external to one another, or
    • GccEnt_unqualified if all solutions apply. Note: The interior of a curve is defined as the left-hand side of the curve in relation to its orientation. Warning Curve is an adapted curve, i.e. an object which is an interface between:
    • the services provided by a 2D curve from the package Geom2d,
    • and those required on the curve by a computation algorithm. The adapted curve is created in the following way: occ::handle<Geom2d_Curve> mycurve = ... ; Geom2dAdaptor_Curve Curve ( mycurve ) ; The qualified curve is then constructed with this object: GccEnt_Position myQualif = GccEnt_outside ; Geom2dGcc_QualifiedCurve myQCurve ( Curve, myQualif ); is private;
    Parameters (2)
    • Curve
    • Qualifier

Instance methods(6)

  • Qualified(): Geom2dAdaptor_Curve

    Returns a 2D curve to which the qualifier is assigned. Warning The returned curve is an adapted curve, i.e. an object which is an interface between:

    • the services provided by a 2D curve from the package Geom2d,
    • and those required on the curve by a computation algorithm. The Geom2d curve on which the adapted curve is based can be obtained in the following way: myQualifiedCurve = ... ; Geom2dAdaptor_Curve myAdaptedCurve = myQualifiedCurve.Qualified(); occ::handle<Geom2d_Curve> = myAdaptedCurve.Curve();
  • Qualifier(): GccEnt_Position

    Returns.

    • the qualifier of this qualified curve if it is enclosing, enclosed or outside, or
    • GccEnt_noqualifier if it is unqualified.
  • IsUnqualified(): boolean

    Returns true if the solution is unqualified and false in the other cases.

  • IsEnclosing(): boolean

    It returns true if the solution is Enclosing the Curv and false in the other cases.

  • IsEnclosed(): boolean

    It returns true if the solution is Enclosed in the Curv and false in the other cases.

  • IsOutside(): boolean

    It returns true if the solution is Outside the Curv and false in the other cases.

Geom2dGcc_Type2

Properties(12)

Geom2dAPI

OCCT package Geom2dAPI: Geom2dAPI_ExtremaCurveCurve, Geom2dAPI_InterCurveCurve, Geom2dAPI_Interpolate, Geom2dAPI_PointsToBSpline, and 1 more bound classes.

Geom2dHatch

OCCT package Geom2dHatch: Geom2dHatch_Classifier, Geom2dHatch_Element, Geom2dHatch_FClass2dOfClassifier, Geom2dHatch_Hatcher, and 2 more bound classes.