OpenCascade.js
API ReferenceModelingAlgorithmsTKGeomAlgo

Geom2dGcc

OCCT package Geom2dGcc: Geom2dGcc, Geom2dGcc_CurveTool, Geom2dGcc_FunctionTanCirCu, Geom2dGcc_FunctionTanCuCu, and 9 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)

  • 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
  • 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
  • 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
  • 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_CurveTool

Constructors(1)

Static methods(8)

Geom2dGcc_FunctionTanCirCu

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

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

Constructors(2)

Instance methods(6)

  • InitDerivative(X: math_Vector, Point1: gp_Pnt2d, Point2: gp_Pnt2d, Tan1: gp_Vec2d, Tan2: gp_Vec2d, D21: gp_Vec2d, D22: gp_Vec2d): void
    Parameters (7)
    • X
    • Point1
    • Point2
    • Tan1
    • Tan2
    • D21
    • D22
  • NbVariables(): number

    returns the number of variables of the function.

  • NbEquations(): number

    returns the number of equations of the function.

  • Value(X: math_Vector, F: math_Vector): boolean

    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
  • Derivatives(X: math_Vector, D: math_Matrix): boolean

    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
  • Values(X: math_Vector, F: math_Vector, D: math_Matrix): boolean

    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

Geom2dGcc_FunctionTanCuCuOnCu

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

Constructors(12)

Instance methods(6)

  • InitDerivative(X: math_Vector, Point1: gp_Pnt2d, Point2: gp_Pnt2d, Point3: gp_Pnt2d, Tan1: gp_Vec2d, Tan2: gp_Vec2d, Tan3: gp_Vec2d, D21: gp_Vec2d, D22: gp_Vec2d, D23: gp_Vec2d): void
    Parameters (10)
    • X
    • Point1
    • Point2
    • Point3
    • Tan1
    • Tan2
    • Tan3
    • D21
    • D22
    • D23
  • NbVariables(): number

    Returns the number of variables of the function.

  • NbEquations(): number

    Returns the number of equations of the function.

  • Value(X: math_Vector, F: math_Vector): boolean

    Computes the values of the Functions for the variable <X>.

    Parameters (2)
    • X
    • F
  • Derivatives(X: math_Vector, D: math_Matrix): boolean

    Returns the values of the derivatives for the variable <X>.

    Parameters (2)
    • X
    • D
  • Values(X: math_Vector, F: math_Vector, D: math_Matrix): boolean

    Returns the values of the functions and the derivatives for the variable <X>.

    Parameters (3)
    • X
    • F
    • D

Geom2dGcc_FunctionTanCuPnt

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

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_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)

  • 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)

  • 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();
  • 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)