libcascade
API ReferenceModelingDataTKGeomBase

GC

OCCT package GC: GC_MakeArcOfCircle, GC_MakeArcOfCircle2d, GC_MakeArcOfEllipse, GC_MakeArcOfEllipse2d, and 29 more bound classes.

GC_MakeArcOfCircle

Implements construction algorithms for an arc of circle in 3D space. The result is a Geom_TrimmedCurve curve. A MakeArcOfCircle object provides a framework for:

  • defining the construction of the arc of circle,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed arc of circle.

Constructors(5)

  • Creates an arc of circle passing through three points.

    Parameters (3)
    • theP1 —
      first point
    • theP2 —
      second point
    • theP3 —
      third point
  • Creates an arc of circle from two points and a tangent at the first point.

    Parameters (3)
    • theP1 —
      start point
    • theV —
      tangent vector at start point
    • theP2 —
      end point
    Remarks

    Note: Construction fails with gce_IntersectionError if the supporting lines used to define circle center do not intersect.

  • constructor(theCirc: gp_Circ, theAlpha1: number, theAlpha2: number, theSense: boolean): GC_MakeArcOfCircle

    Creates an arc of circle from angular bounds.

    Parameters (4)
    • theCirc —
      source circle
    • theAlpha1 —
      first angle (radians)
    • theAlpha2 —
      second angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theCirc: gp_Circ, theP: gp_Pnt, theAlpha: number, theSense: boolean): GC_MakeArcOfCircle

    Creates an arc of circle from a point and an angular bound.

    Parameters (4)
    • theCirc —
      source circle
    • theP —
      point on circle
    • theAlpha —
      target angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theCirc: gp_Circ, theP1: gp_Pnt, theP2: gp_Pnt, theSense: boolean): GC_MakeArcOfCircle

    Creates an arc of circle from two points on the circle.

    Parameters (4)
    • theCirc —
      source circle
    • theP1 —
      first point on circle
    • theP2 —
      second point on circle
    • theSense —
      orientation of resulting arc

Instance methods(1)

  • Returns the constructed arc of circle. Exceptions StdFail_NotDone if no arc of circle is constructed.

    Returns

    resulting arc

GC_MakeArcOfCircle2d

This class implements construction algorithms for arcs of circles in the plane. The result is a Geom2d_TrimmedCurve. A GC_MakeArcOfCircle2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting arc via Value().

Constructors(5)

  • Constructs an arc passing through three points.

    Parameters (3)
    • theP1 —
      first point
    • theP2 —
      intermediate point
    • theP3 —
      last point
  • Constructs an arc from two points and tangent vector at start point.

    Parameters (3)
    • theP1 —
      start point
    • theV —
      tangent vector at start point
    • theP2 —
      end point
  • constructor(theCircle: gp_Circ2d, theAlpha1: number, theAlpha2: number, theSense?: boolean): GC_MakeArcOfCircle2d

    Constructs an arc from angular bounds on a circle.

    Parameters (4)
    • theCircle —
      source circle
    • theAlpha1 —
      first angle (radians)
    • theAlpha2 —
      second angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theCircle: gp_Circ2d, thePoint: gp_Pnt2d, theAlpha: number, theSense?: boolean): GC_MakeArcOfCircle2d

    Constructs an arc from a point and angular bound on a circle.

    Parameters (4)
    • theCircle —
      source circle
    • thePoint —
      point on source circle
    • theAlpha —
      angle value (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theCircle: gp_Circ2d, theP1: gp_Pnt2d, theP2: gp_Pnt2d, theSense?: boolean): GC_MakeArcOfCircle2d

    Constructs an arc between two points on a circle.

    Parameters (4)
    • theCircle —
      source circle
    • theP1 —
      first point on source circle
    • theP2 —
      second point on source circle
    • theSense —
      orientation of resulting arc

Instance methods(1)

  • Returns the constructed arc of circle. Exceptions StdFail_NotDone if no arc of circle is constructed.

    Returns

    resulting trimmed curve

GC_MakeArcOfEllipse

Implements construction algorithms for ellipse arcs in 3D space. The result is a Geom_TrimmedCurve. A MakeArcOfEllipse object provides a framework for:

  • defining the construction of the arc of ellipse,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed arc of ellipse.

Constructors(3)

  • constructor(theElips: gp_Elips, theAlpha1: number, theAlpha2: number, theSense: boolean): GC_MakeArcOfEllipse

    Constructs an arc from angular bounds on an ellipse.

    Parameters (4)
    • theElips —
      source ellipse
    • theAlpha1 —
      first angle (radians)
    • theAlpha2 —
      second angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theElips: gp_Elips, theP: gp_Pnt, theAlpha: number, theSense: boolean): GC_MakeArcOfEllipse

    Constructs an arc from a point and angle on an ellipse.

    Parameters (4)
    • theElips —
      source ellipse
    • theP —
      point on ellipse
    • theAlpha —
      target angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theElips: gp_Elips, theP1: gp_Pnt, theP2: gp_Pnt, theSense: boolean): GC_MakeArcOfEllipse

    Constructs an arc between two points on an ellipse.

    Parameters (4)
    • theElips —
      source ellipse
    • theP1 —
      first point
    • theP2 —
      second point
    • theSense —
      orientation of resulting arc
    Remarks

    Note: IsDone always returns true.

Instance methods(1)

GC_MakeArcOfEllipse2d

This class implements construction algorithms for arcs of ellipses in the plane. The result is a Geom2d_TrimmedCurve. A GC_MakeArcOfEllipse2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting arc via Value().

Constructors(3)

  • constructor(theEllipse: gp_Elips2d, theAlpha1: number, theAlpha2: number, theSense?: boolean): GC_MakeArcOfEllipse2d

    Constructs an arc from angular bounds on an ellipse.

    Parameters (4)
    • theEllipse —
      source ellipse
    • theAlpha1 —
      first angle (radians)
    • theAlpha2 —
      second angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theEllipse: gp_Elips2d, thePoint: gp_Pnt2d, theAlpha: number, theSense?: boolean): GC_MakeArcOfEllipse2d

    Constructs an arc from a point and angular bound on an ellipse.

    Parameters (4)
    • theEllipse —
      source ellipse
    • thePoint —
      point on source ellipse
    • theAlpha —
      angle value (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theEllipse: gp_Elips2d, theP1: gp_Pnt2d, theP2: gp_Pnt2d, theSense?: boolean): GC_MakeArcOfEllipse2d

    Constructs an arc between two points on an ellipse.

    Parameters (4)
    • theEllipse —
      source ellipse
    • theP1 —
      first point on source ellipse
    • theP2 —
      second point on source ellipse
    • theSense —
      orientation of resulting arc
    Remarks

    Note: IsDone always returns true.

Instance methods(1)

GC_MakeArcOfHyperbola

Implements construction algorithms for hyperbola arcs in 3D space. The result is a Geom_TrimmedCurve. A MakeArcOfHyperbola object provides a framework for:

  • defining the construction of the arc of hyperbola,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed arc of hyperbola.

Constructors(3)

  • constructor(theHypr: gp_Hypr, theAlpha1: number, theAlpha2: number, theSense: boolean): GC_MakeArcOfHyperbola

    Constructs an arc from angular bounds on a hyperbola.

    Parameters (4)
    • theHypr —
      source hyperbola
    • theAlpha1 —
      first angle (radians)
    • theAlpha2 —
      second angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theHypr: gp_Hypr, theP: gp_Pnt, theAlpha: number, theSense: boolean): GC_MakeArcOfHyperbola

    Constructs an arc from a point and angle on a hyperbola.

    Parameters (4)
    • theHypr —
      source hyperbola
    • theP —
      point on hyperbola
    • theAlpha —
      target angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theHypr: gp_Hypr, theP1: gp_Pnt, theP2: gp_Pnt, theSense: boolean): GC_MakeArcOfHyperbola

    Constructs an arc between two points on a hyperbola.

    Parameters (4)
    • theHypr —
      source hyperbola
    • theP1 —
      first point
    • theP2 —
      second point
    • theSense —
      orientation of resulting arc
    Remarks

    Note: The orientation of the arc of hyperbola is:the orientation of hyperbola if theSense is true, orthe opposite orientation if theSense is false.

Instance methods(1)

GC_MakeArcOfHyperbola2d

This class implements construction algorithms for arcs of hyperbolas in the plane. The result is a Geom2d_TrimmedCurve. A GC_MakeArcOfHyperbola2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting arc via Value().

Constructors(3)

  • constructor(theHyperbola: gp_Hypr2d, theAlpha1: number, theAlpha2: number, theSense?: boolean): GC_MakeArcOfHyperbola2d

    Constructs an arc from angular bounds on a hyperbola.

    Parameters (4)
    • theHyperbola —
      source hyperbola
    • theAlpha1 —
      first angle (radians)
    • theAlpha2 —
      second angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theHyperbola: gp_Hypr2d, thePoint: gp_Pnt2d, theAlpha: number, theSense?: boolean): GC_MakeArcOfHyperbola2d

    Constructs an arc from a point and angular bound on a hyperbola.

    Parameters (4)
    • theHyperbola —
      source hyperbola
    • thePoint —
      point on source hyperbola
    • theAlpha —
      angle value (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theHyperbola: gp_Hypr2d, theP1: gp_Pnt2d, theP2: gp_Pnt2d, theSense?: boolean): GC_MakeArcOfHyperbola2d

    Constructs an arc between two points on a hyperbola.

    Parameters (4)
    • theHyperbola —
      source hyperbola
    • theP1 —
      first point on source hyperbola
    • theP2 —
      second point on source hyperbola
    • theSense —
      orientation of resulting arc
    Remarks

    Note: IsDone always returns true.

Instance methods(1)

GC_MakeArcOfParabola

Implements construction algorithms for parabola arcs in 3D space. The result is a Geom_TrimmedCurve. A MakeArcOfParabola object provides a framework for:

  • defining the construction of the arc of parabola,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed arc of parabola.

Constructors(3)

  • constructor(theParab: gp_Parab, theAlpha1: number, theAlpha2: number, theSense: boolean): GC_MakeArcOfParabola

    Constructs an arc from angular bounds on a parabola.

    Parameters (4)
    • theParab —
      source parabola
    • theAlpha1 —
      first angle (radians)
    • theAlpha2 —
      second angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theParab: gp_Parab, theP: gp_Pnt, theAlpha: number, theSense: boolean): GC_MakeArcOfParabola

    Constructs an arc from a point and angle on a parabola.

    Parameters (4)
    • theParab —
      source parabola
    • theP —
      point on parabola
    • theAlpha —
      target angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theParab: gp_Parab, theP1: gp_Pnt, theP2: gp_Pnt, theSense: boolean): GC_MakeArcOfParabola

    Constructs an arc between two points on a parabola.

    Parameters (4)
    • theParab —
      source parabola
    • theP1 —
      first point
    • theP2 —
      second point
    • theSense —
      orientation of resulting arc

Instance methods(1)

GC_MakeArcOfParabola2d

This class implements construction algorithms for arcs of parabolas in the plane. The result is a Geom2d_TrimmedCurve. A GC_MakeArcOfParabola2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting arc via Value().

Constructors(3)

  • constructor(theParabola: gp_Parab2d, theAlpha1: number, theAlpha2: number, theSense?: boolean): GC_MakeArcOfParabola2d

    Constructs an arc from angular bounds on a parabola.

    Parameters (4)
    • theParabola —
      source parabola
    • theAlpha1 —
      first angle (radians)
    • theAlpha2 —
      second angle (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theParabola: gp_Parab2d, thePoint: gp_Pnt2d, theAlpha: number, theSense?: boolean): GC_MakeArcOfParabola2d

    Constructs an arc from a point and angular bound on a parabola.

    Parameters (4)
    • theParabola —
      source parabola
    • thePoint —
      point on source parabola
    • theAlpha —
      angle value (radians)
    • theSense —
      orientation of resulting arc
  • constructor(theParabola: gp_Parab2d, theP1: gp_Pnt2d, theP2: gp_Pnt2d, theSense?: boolean): GC_MakeArcOfParabola2d

    Constructs an arc between two points on a parabola.

    Parameters (4)
    • theParabola —
      source parabola
    • theP1 —
      first point on source parabola
    • theP2 —
      second point on source parabola
    • theSense —
      orientation of resulting arc
    Remarks

    Note: IsDone always returns true.

Instance methods(1)

GC_MakeCircle

Implements construction algorithms for circles in 3D space.

  • Create a circle parallel to another and passing through a point.
  • Create a Circle parallel to another at the distance Dist.
  • Create a Circle passing through 3 points.
  • Create a Circle with its center and the normal of its plane and its radius.
  • Create a Circle with its axis and radius. The circle parameter is the angle in radians. The parametrization range is [0,2*PI]. The circle is a closed and periodic curve. The center of the circle is the Location point of its axis placement. The XDirection of the axis placement defines the origin of the parametrization.

Constructors(8)

  • Creates a circle from a gp_Circ.

    Parameters (1)
    • theC —
      source circle
  • constructor(theA2: gp_Ax2, theRadius: number): GC_MakeCircle

    Creates a circle from axis placement and radius.

    Parameters (2)
    • theA2 —
      local coordinate system of the circle
    • theRadius —
      circle radius
    Remarks

    Note: The status is gce_NegativeRadius if theRadius < 0.0.

  • constructor(theCirc: gp_Circ, theDist: number): GC_MakeCircle

    Creates a circle concentric to the input circle with an offset radius.

    Parameters (2)
    • theCirc —
      reference circle
    • theDist —
      radius offset
  • constructor(theCirc: gp_Circ, thePoint: gp_Pnt): GC_MakeCircle

    Creates a circle concentric to the input circle and passing through the input point.

    Parameters (2)
    • theCirc —
      source circle
    • thePoint —
      point on resulting circle
  • constructor(theAxis: gp_Ax1, theRadius: number): GC_MakeCircle

    Creates a circle from axis and radius.

    Parameters (2)
    • theAxis —
      circle axis
    • theRadius —
      circle radius
  • constructor(theP1: gp_Pnt, theP2: gp_Pnt, theP3: gp_Pnt): GC_MakeCircle

    Creates a circle passing through three points.

    Parameters (3)
    • theP1 —
      first point
    • theP2 —
      second point
    • theP3 —
      third point
  • constructor(theCenter: gp_Pnt, theNorm: gp_Dir, theRadius: number): GC_MakeCircle

    Creates a circle from center point, normal and radius.

    Parameters (3)
    • theCenter —
      circle center
    • theNorm —
      normal direction of circle plane
    • theRadius —
      circle radius
  • constructor(theCenter: gp_Pnt, thePtAxis: gp_Pnt, theRadius: number): GC_MakeCircle

    Creates a circle from center point, axis point and radius.

    Parameters (3)
    • theCenter —
      circle center
    • thePtAxis —
      point defining normal direction
    • theRadius —
      circle radius
    Remarks

    Note: The direction is defined by vector (theCenter,thePtAxis).

Instance methods(1)

  • Returns the constructed circle. Exceptions StdFail_NotDone if no circle is constructed.

    Returns

    resulting circle

GC_MakeCircle2d

This class implements construction algorithms for circles in the plane. The result is a Geom2d_Circle. A GC_MakeCircle2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting circle via Value().

Constructors(8)

  • Creates a circle from a non-persistent one from package gp.

    Parameters (1)
    • theCircle —
      source circle
  • constructor(theAxis: gp_Ax22d, theRadius: number): GC_MakeCircle2d

    Creates a circle from a local coordinate system and radius.

    Parameters (2)
    • theAxis —
      local coordinate system
    • theRadius —
      radius value
    Remarks

    Note: Construction fails with gce_NegativeRadius if theRadius is negative.

  • constructor(theCircle: gp_Circ2d, theDist: number): GC_MakeCircle2d

    Creates a circle parallel to another one at signed distance.

    Parameters (2)
    • theCircle —
      source circle
    • theDist —
      signed distance
    Remarks

    Note: Error status is provided by the underlying gce_MakeCirc2d.

  • Creates a circle parallel to another one and passing through a point.

    Parameters (2)
    • theCircle —
      source circle
    • thePoint —
      point on resulting circle
    Remarks

    Note: Error status is provided by the underlying gce_MakeCirc2d.

  • constructor(theAxis: gp_Ax2d, theRadius: number, theSense?: boolean): GC_MakeCircle2d

    Creates a circle from an axis placement and radius.

    Parameters (3)
    • theAxis —
      axis placement
    • theRadius —
      radius value
    • theSense —
      orientation flag
    Remarks

    Note: Construction fails with gce_NegativeRadius if theRadius is negative.

  • Creates a circle passing through three points.

    Parameters (3)
    • theP1 —
      first point
    • theP2 —
      second point
    • theP3 —
      third point
    Remarks

    Note: Error status is provided by the underlying gce_MakeCirc2d.

  • constructor(theCenter: gp_Pnt2d, theRadius: number, theSense?: boolean): GC_MakeCircle2d

    Creates a circle from center point and radius.

    Parameters (3)
    • theCenter —
      center point
    • theRadius —
      radius value
    • theSense —
      orientation flag
    Remarks

    Note: Error status is provided by the underlying gce_MakeCirc2d.

  • constructor(theCenter: gp_Pnt2d, thePoint: gp_Pnt2d, theSense?: boolean): GC_MakeCircle2d

    Creates a circle from center point and one point on the circle.

    Parameters (3)
    • theCenter —
      center point
    • thePoint —
      point on resulting circle
    • theSense —
      orientation flag
    Remarks

    Note: Error status is provided by the underlying gce_MakeCirc2d.

Instance methods(1)

  • Returns the constructed circle. Exceptions StdFail_NotDone if no circle is constructed.

    Returns

    resulting circle

GC_MakeConicalSurface

Implements construction algorithms for conical surfaces. Supported constructions include:

  • a conical surface from axis placement and angle/radius;
  • conversion from gp_Cone;
  • a conical surface through four points;
  • a conical surface from two points and two radii. The local coordinate system of the ConicalSurface is defined with an axis placement (see class ElementarySurface).
    The "ZAxis" is the symmetry axis of the ConicalSurface, it gives the direction of increasing parametric value V. The apex of the surface is on the negative side of this axis.
    The parametrization range is: U [0, 2*PI], V ]-infinite, + infinite[
    The "XAxis" and the "YAxis" define the placement plane of the surface (Z = 0, and parametric value V = 0) perpendicular to the symmetry axis. The "XAxis" defines the origin of the parameter U = 0. The trigonometric sense gives the positive orientation for the parameter U.
    When you create a ConicalSurface the U and V directions of parametrization are such that at each point of the surface the normal is oriented towards the "outside region".

Constructors(4)

  • Creates a conical surface from a gp_Cone.

    Parameters (1)
    • theC —
      source cone
  • constructor(theA2: gp_Ax2, theAng: number, theRadius: number): GC_MakeConicalSurface

    Creates a conical surface from local frame, semi-angle and radius.

    Parameters (3)
    • theA2 —
      local coordinate system
    • theAng —
      semi-angle
    • theRadius —
      reference radius in placement plane
    Remarks

    Note: Status is gce_NegativeRadius if theRadius < 0.0, or gce_BadAngle if theAng is outside valid range.

  • constructor(theP1: gp_Pnt, theP2: gp_Pnt, theP3: gp_Pnt, theP4: gp_Pnt): GC_MakeConicalSurface

    Creates a conical surface from four points.

    Parameters (4)
    • theP1 —
      first point defining axis
    • theP2 —
      second point defining axis
    • theP3 —
      point defining first section radius
    • theP4 —
      point defining second section radius
    Remarks

    Note: Construction fails if points theP1, theP2, theP3 and theP4 are collinear, or if vector (theP3,theP4) is perpendicular/collinear to vector (theP1,theP2).

  • constructor(theP1: gp_Pnt, theP2: gp_Pnt, theR1: number, theR2: number): GC_MakeConicalSurface

    Creates a conical surface with two points and two radii.

    Parameters (4)
    • theP1 —
      first axis point
    • theP2 —
      second axis point
    • theR1 —
      radius at P1
    • theR2 —
      radius at P2
    Remarks

    Note: theR1 and theR2 are radii of sections passing through theP1 and theP2.

Instance methods(1)

  • Returns the constructed cone. Exceptions StdFail_NotDone if no cone is constructed.

    Returns

    resulting conical surface

GC_MakeCylindricalSurface

Implements construction algorithms for cylindrical surfaces. Supported constructions include:

  • a cylindrical surface from axis placement and radius;
  • conversion from gp_Cylinder;
  • an offset/parallel cylindrical surface;
  • a cylindrical surface through three points;
  • a cylindrical surface from axis and radius;
  • a cylindrical surface from circular base. The local coordinate system of the CylindricalSurface is defined with an axis placement (see class ElementarySurface).
    The "ZAxis" is the symmetry axis of the CylindricalSurface, it gives the direction of increasing parametric value V.
    The parametrization range is : U [0, 2*PI], V ]- infinite, + infinite[
    The "XAxis" and the "YAxis" define the placement plane of the surface (Z = 0, and parametric value V = 0) perpendicular to the symmetry axis. The "XAxis" defines the origin of the parameter U = 0. The trigonometric sense gives the positive orientation for the parameter U.

Constructors(7)

  • Creates a cylindrical surface from a gp_Cylinder.

    Parameters (1)
    • theC —
      source cylinder
  • Creates a cylindrical surface from its circular base.

    Parameters (1)
    • theCirc —
      base circle
  • constructor(theA2: gp_Ax2, theRadius: number): GC_MakeCylindricalSurface

    Creates a cylindrical surface from axis placement and radius.

    Parameters (2)
    • theA2 —
      local coordinate system
    • theRadius —
      cylinder radius
    Remarks

    Note: Status is gce_NegativeRadius if theRadius < 0.0.

  • Creates a cylindrical surface parallel to the input cylinder and passing through the input point.

    Parameters (2)
    • theCyl —
      source cylinder
    • thePoint —
      point on resulting surface
  • Creates a cylindrical surface parallel to the input cylinder at signed distance.

    Parameters (2)
    • theCyl —
      source cylinder
    • theDist —
      signed offset distance
    Remarks

    Note: The result radius is the absolute value of (source radius + signed distance).

  • constructor(theAxis: gp_Ax1, theRadius: number): GC_MakeCylindricalSurface

    Creates a cylindrical surface from axis and radius.

    Parameters (2)
    • theAxis —
      cylinder axis
    • theRadius —
      cylinder radius
  • Creates a cylindrical surface passing through three points.

    Parameters (3)
    • theP1 —
      first axis point
    • theP2 —
      second axis point
    • theP3 —
      point defining radius
    Remarks

    Note: The axis is defined by points theP1 and theP2, and radius is the distance between point theP3 and that axis.

Instance methods(1)

  • Returns the constructed cylinder. Exceptions StdFail_NotDone if no cylinder is constructed.

    Returns

    resulting cylindrical surface

GC_MakeEllipse

Implements construction algorithms for ellipses in 3D space. The result is a Geom_Ellipse. A MakeEllipse object provides a framework for:

  • defining the construction of the ellipse,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed ellipse.

Constructors(3)

  • Creates an ellipse from a gp_Elips.

    Parameters (1)
    • theE —
      source ellipse
  • constructor(theA2: gp_Ax2, theMajorRadius: number, theMinorRadius: number): GC_MakeEllipse

    Constructs an ellipse with major and minor radii MajorRadius and MinorRadius, and located in the plane defined by the "X Axis" and "Y Axis" of the coordinate system A2, where:

    • its center is the origin of A2, and
    • its major axis is the "X Axis" of A2;
    Parameters (3)
    • theA2 —
      ellipse local coordinate system
    • theMajorRadius —
      major radius
    • theMinorRadius —
      minor radius
    Remarks

    Note: Construction fails with gce_InvertAxis if theMajorRadius < theMinorRadius.

  • constructor(theS1: gp_Pnt, theS2: gp_Pnt, theCenter: gp_Pnt): GC_MakeEllipse

    Constructs an ellipse centered on the point Center, where.

    • the plane of the ellipse is defined by Center, S1 and S2,
    • its major axis is defined by Center and S1,
    • its major radius is the distance between Center and S1, and
    • its minor radius is the distance between S2 and the major axis.
    Parameters (3)
    • theS1 —
      point defining the major axis
    • theS2 —
      point defining the minor radius
    • theCenter —
      ellipse center

Instance methods(1)

  • Returns the constructed ellipse. Exceptions StdFail_NotDone if no ellipse is constructed.

    Returns

    resulting ellipse

GC_MakeEllipse2d

This class implements construction algorithms for ellipses in the plane. The result is a Geom2d_Ellipse. A GC_MakeEllipse2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting ellipse via Value().

Constructors(4)

  • Creates an ellipse from a non-persistent one from package gp.

    Parameters (1)
    • theEllipse —
      source ellipse
  • constructor(theAxis: gp_Ax22d, theMajorRadius: number, theMinorRadius: number): GC_MakeEllipse2d

    Creates an ellipse from a local coordinate system and radii.

    Parameters (3)
    • theAxis —
      local coordinate system
    • theMajorRadius —
      major radius value
    • theMinorRadius —
      minor radius value
    Remarks

    Note: Error status is provided by the underlying gce_MakeElips2d (for example gce_InvertRadius or gce_NegativeRadius).

  • Creates an ellipse from two apex points and center point.

    Parameters (3)
    • theS1 —
      first apex point
    • theS2 —
      second point defining minor radius
    • theCenter —
      center point
    Remarks

    Note: Error status is provided by the underlying gce_MakeElips2d.

  • constructor(theMajorAxis: gp_Ax2d, theMajorRadius: number, theMinorRadius: number, theSense?: boolean): GC_MakeEllipse2d

    Creates an ellipse from major axis placement and radii.

    Parameters (4)
    • theMajorAxis —
      major axis placement
    • theMajorRadius —
      major radius value
    • theMinorRadius —
      minor radius value
    • theSense —
      orientation flag
    Remarks

    Note: Error status is provided by the underlying gce_MakeElips2d (for example gce_InvertRadius or gce_NegativeRadius).

Instance methods(1)

  • Returns the constructed ellipse. Exceptions StdFail_NotDone if no ellipse is constructed.

    Returns

    resulting ellipse

GC_MakeHyperbola

Implements construction algorithms for hyperbolas in 3D space. The result is a Geom_Hyperbola. A MakeHyperbola object provides a framework for:

  • defining the construction of the hyperbola,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed hyperbola. To define the main branch of a hyperbola. The parameterization range is ]-infinite,+infinite[ It is possible to get the other branch and the two conjugate branches of the main branch.
    ^YAxis | FirstConjugateBranch | Other | Main -------------------- C ----------------------------->XAxis Branch | Branch | SecondConjugateBranch |
    The major radius is the distance between the Location point of the hyperbola C and the apex of the Main Branch (or the Other branch). The major axis is the XAxis. The minor radius is the distance between the Location point of the hyperbola C and the apex of the First (or Second) Conjugate branch. The minor axis is the YAxis. The major radius can be lower than the minor radius.

Constructors(3)

  • Creates a hyperbola from a gp_Hypr.

    Parameters (1)
    • theH —
      source hyperbola
  • constructor(theA2: gp_Ax2, theMajorRadius: number, theMinorRadius: number): GC_MakeHyperbola

    Constructs a hyperbola centered on the origin of the coordinate system A2, with major and minor radii MajorRadius and MinorRadius, where: the plane of the hyperbola is defined by the "X Axis" and "Y Axis" of A2,.

    • its major axis is the "X Axis" of A2.
    Parameters (3)
    • theA2 —
      hyperbola local coordinate system
    • theMajorRadius —
      major radius
    • theMinorRadius —
      minor radius
  • constructor(theS1: gp_Pnt, theS2: gp_Pnt, theCenter: gp_Pnt): GC_MakeHyperbola

    Constructs a hyperbola centered on the point Center, where.

    • the plane of the hyperbola is defined by Center, S1 and S2,
    • its major axis is defined by Center and S1,
    • its major radius is the distance between Center and S1, and
    • its minor radius is the distance between S2 and the major axis;
    Parameters (3)
    • theS1 —
      point defining the major axis
    • theS2 —
      point defining the minor radius
    • theCenter —
      hyperbola center

Instance methods(1)

  • Returns the constructed hyperbola. Exceptions StdFail_NotDone if no hyperbola is constructed.

    Returns

    resulting hyperbola

GC_MakeHyperbola2d

This class implements construction algorithms for hyperbolas in the plane. The result is a Geom2d_Hyperbola (main branch). A GC_MakeHyperbola2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting hyperbola via Value().

Constructors(4)

  • Creates a hyperbola from a non-persistent one from package gp.

    Parameters (1)
    • theHyperbola —
      source hyperbola
  • constructor(theAxis: gp_Ax22d, theMajorRadius: number, theMinorRadius: number): GC_MakeHyperbola2d

    Creates a hyperbola from local coordinate system and radii.

    Parameters (3)
    • theAxis —
      local coordinate system
    • theMajorRadius —
      major radius value
    • theMinorRadius —
      minor radius value
    Remarks

    Note: Error status is provided by the underlying gce_MakeHypr2d (for example gce_NegativeRadius).

  • Creates a hyperbola from two apex points and center point.

    Parameters (3)
    • theS1 —
      first apex point
    • theS2 —
      second point defining conjugate radius
    • theCenter —
      center point
    Remarks

    Note: Error status is provided by the underlying gce_MakeHypr2d (for example gce_ConfusedPoints or gce_ColinearPoints).

  • constructor(theMajorAxis: gp_Ax2d, theMajorRadius: number, theMinorRadius: number, theSense: boolean): GC_MakeHyperbola2d

    Creates a hyperbola from major axis placement and radii.

    Parameters (4)
    • theMajorAxis —
      major axis placement
    • theMajorRadius —
      major radius value
    • theMinorRadius —
      minor radius value
    • theSense —
      orientation flag
    Remarks

    Note: Error status is provided by the underlying gce_MakeHypr2d (for example gce_NegativeRadius).

Instance methods(1)

  • Returns the constructed hyperbola. Exceptions: StdFail_NotDone if no hyperbola is constructed.

    Returns

    resulting hyperbola

GC_MakeLine

This class implements the following algorithms used to create a Line from Geom.

  • Create a Line parallel to another and passing through a point.
  • Create a Line passing through 2 points. A MakeLine object provides a framework for:
  • defining the construction of the line,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed line.

Constructors(5)

  • Creates a line located in 3D space with the axis placement A1.

    Parameters (1)
    • theA1 —
      line axis placement
    Remarks

    Note: The location of theA1 is the origin of the line.

  • Creates a line from a non-persistent line from package gp.

    Parameters (1)
    • theL —
      source line
  • Creates a line from point and direction.

    Parameters (2)
    • theP —
      line origin
    • theV —
      line direction
  • constructor(theLin: gp_Lin, thePoint: gp_Pnt): GC_MakeLine

    Creates a line parallel to the input line and passing through the input point.

    Parameters (2)
    • theLin —
      source line
    • thePoint —
      point on resulting line
  • Creates a line passing through two points.

    Parameters (2)
    • theP1 —
      first point
    • theP2 —
      second point
    Remarks

    Note: Construction fails with gce_ConfusedPoints if the two points are coincident.

Instance methods(1)

  • Returns the constructed line. Exceptions StdFail_NotDone if no line is constructed.

    Returns

    resulting line

GC_MakeLine2d

This class implements construction algorithms for lines in the plane. The result is a Geom2d_Line. A GC_MakeLine2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting line via Value(). Supported constructions include:
  • line from axis placement;
  • line from existing gp_Lin2d;
  • line from point and direction;
  • line parallel to input line through a point;
  • line parallel to input line at signed distance;
  • line through two points.

Constructors(6)

  • Creates a line from an axis placement.

    Parameters (1)
    • theAxis —
      axis placement
    Remarks

    Note: The location of theAxis is the line origin.

  • Creates a line from a non-persistent line from package gp.

    Parameters (1)
    • theLine —
      source line
  • Constructs a line from origin and direction.

    Parameters (2)
    • thePoint —
      point on line
    • theDir —
      direction
  • Constructs a line parallel to input line and passing through a point.

    Parameters (2)
    • theLine —
      source line
    • thePoint —
      point on resulting line
  • constructor(theLine: gp_Lin2d, theDist: number): GC_MakeLine2d

    Constructs a line parallel to input line at signed distance.

    Parameters (2)
    • theLine —
      source line
    • theDist —
      signed distance
  • Constructs a line passing through two points.

    Parameters (2)
    • theP1 —
      first point
    • theP2 —
      second point
    Remarks

    Note: Status is gce_ConfusedPoints if points are coincident.

Instance methods(1)

  • Returns the constructed line. Exceptions StdFail_NotDone if no line is constructed.

    Returns

    resulting line

GC_MakeMirror

This class implements elementary construction algorithms for a symmetrical transformation in 3D space about a point, axis or plane. The result is a Geom_Transformation transformation. A MakeMirror object provides a framework for:

  • defining the construction of the transformation,
  • implementing the construction algorithm, and
  • consulting the result.

Constructors(6)

Instance methods(1)

GC_MakeMirror2d

This class implements elementary construction algorithms for symmetric transformations in 2D space about a point, axis, or line. The result is a Geom2d_Transformation. A GC_MakeMirror2d object provides a framework for:

  • defining the transformation parameters;
  • running the construction algorithm;
  • querying the resulting transformation via Value().

Constructors(4)

Instance methods(1)

GC_MakeParabola2d

This class implements construction algorithms for parabolas in the plane. The result is a Geom2d_Parabola. A GC_MakeParabola2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting parabola via Value().

Constructors(5)

  • Creates a parabola from a non-persistent one from package gp.

    Parameters (1)
    • theParabola —
      source parabola
  • constructor(theAxis: gp_Ax22d, theFocal: number): GC_MakeParabola2d

    Creates a parabola from a local coordinate system and focal length.

    Parameters (2)
    • theAxis —
      local coordinate system
    • theFocal —
      focal length
    Remarks

    Note: Construction fails with gce_NullFocusLength if theFocal is negative.

  • Creates a parabola from focus and vertex points.

    Parameters (2)
    • theFocus —
      focus point
    • theVertex —
      vertex point
    Remarks

    Note: Error status is provided by the underlying gce_MakeParab2d (for example gce_NullAxis).

  • constructor(theMirrorAxis: gp_Ax2d, theFocal: number, theSense: boolean): GC_MakeParabola2d

    Creates a parabola from symmetry axis and focal length.

    Parameters (3)
    • theMirrorAxis —
      symmetry axis placement
    • theFocal —
      focal length
    • theSense —
      orientation flag
    Remarks

    Note: Construction fails with gce_NullFocusLength if theFocal is negative.

  • constructor(theDirectrix: gp_Ax2d, theFocus: gp_Pnt2d, theSense?: boolean): GC_MakeParabola2d

    Creates a parabola from directrix and focus point.

    Parameters (3)
    • theDirectrix —
      directrix axis
    • theFocus —
      focus point
    • theSense —
      orientation flag

Instance methods(1)

  • Returns the constructed parabola. Exceptions StdFail_NotDone if no parabola is constructed.

    Returns

    resulting parabola

GC_MakePlane

Implements construction algorithms for planes in 3D space. Supported constructions include:

  • a plane parallel to another plane and passing through a point;
  • a plane passing through three points;
  • a plane defined by a point and normal direction. A MakePlane object provides a framework for:
  • defining the construction of the plane,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed plane.

Constructors(7)

  • Creates a plane from a non-persistent plane from package gp.

    Parameters (1)
    • thePl —
      source plane
  • Creates a plane through axis location and normal to axis direction.

    Parameters (1)
    • theAxis —
      axis defining location and normal
  • Creates a plane from point and normal direction.

    Parameters (2)
    • theP —
      location point of the plane
    • theV —
      normal direction
  • constructor(thePln: gp_Pln, thePoint: gp_Pnt): GC_MakePlane

    Creates a plane parallel to the input plane and passing through the input point.

    Parameters (2)
    • thePln —
      source plane
    • thePoint —
      point on resulting plane
  • constructor(thePln: gp_Pln, theDist: number): GC_MakePlane

    Creates a plane parallel to the input plane at signed distance.

    Parameters (2)
    • thePln —
      source plane
    • theDist —
      signed distance
    Remarks

    Note: Positive distance follows the normal of the input plane.

  • constructor(theP1: gp_Pnt, theP2: gp_Pnt, theP3: gp_Pnt): GC_MakePlane

    Creates a plane passing through three points.

    Parameters (3)
    • theP1 —
      first point
    • theP2 —
      second point
    • theP3 —
      third point
    Remarks

    Note: Construction fails when points are confused/collinear.

  • constructor(theA: number, theB: number, theC: number, theD: number): GC_MakePlane

    Creates a plane from its cartesian equation: A * x + B * y + C * z + D = 0.0.

    Parameters (4)
    • theA —
      equation coefficient A
    • theB —
      equation coefficient B
    • theC —
      equation coefficient C
    • theD —
      equation coefficient D
    Remarks

    Note: Status is gce_BadEquation if sqrt(theA*theA + theB*theB + theC*theC) is below gp resolution.

Instance methods(1)

  • Returns the constructed plane. Exceptions StdFail_NotDone if no plane is constructed.

    Returns

    resulting plane

GC_MakeRotation

This class implements elementary construction algorithms for a rotation in 3D space. The result is a Geom_Transformation transformation. A MakeRotation object provides a framework for:

  • defining the construction of the transformation,
  • implementing the construction algorithm, and
  • consulting the result.

Constructors(3)

  • constructor(theLine: gp_Lin, theAngle: number): GC_MakeRotation

    Constructs a rotation around the axis defined by a line.

    Parameters (2)
    • theLine —
      rotation axis
    • theAngle —
      rotation angle in radians
  • constructor(theAxis: gp_Ax1, theAngle: number): GC_MakeRotation

    Constructs a rotation around an axis.

    Parameters (2)
    • theAxis —
      rotation axis
    • theAngle —
      rotation angle in radians
  • constructor(thePoint: gp_Pnt, theDirec: gp_Dir, theAngle: number): GC_MakeRotation

    Constructs a rotation around an axis defined by point and direction.

    Parameters (3)
    • thePoint —
      point on the axis
    • theDirec —
      axis direction
    • theAngle —
      rotation angle in radians

Instance methods(1)

GC_MakeRotation2d

This class implements elementary construction algorithms for rotations in 2D space. The result is a Geom2d_Transformation. A GC_MakeRotation2d object provides a framework for:

  • defining the transformation parameters;
  • running the construction algorithm;
  • querying the resulting transformation via Value().

Constructors(1)

  • constructor(thePoint: gp_Pnt2d, theAngle: number): GC_MakeRotation2d

    Constructs a rotation through angle Angle about the center Point.

    Parameters (2)
    • thePoint —
      rotation center
    • theAngle —
      rotation angle in radians

Instance methods(1)

GC_MakeScale

Implements construction of a scaling transformation in 3D space. The result is a Geom_Transformation centered at Point with scale factor Scale. A MakeScale object provides a framework for:

  • defining the construction of the transformation,
  • implementing the construction algorithm, and
  • consulting the result.

Constructors(1)

  • constructor(thePoint: gp_Pnt, theScale: number): GC_MakeScale

    Constructs a scaling transformation.

    Parameters (2)
    • thePoint —
      center point of scaling
    • theScale —
      scale factor

Instance methods(1)

GC_MakeScale2d

This class implements elementary construction algorithms for scaling transformations in 2D space. The result is a Geom2d_Transformation. A GC_MakeScale2d object provides a framework for:

  • defining the transformation parameters;
  • running the construction algorithm;
  • querying the resulting transformation via Value().

Constructors(1)

  • constructor(thePoint: gp_Pnt2d, theScale: number): GC_MakeScale2d

    Constructs a scaling transformation.

    Parameters (2)
    • thePoint —
      center point
    • theScale —
      scale factor

Instance methods(1)

GC_MakeSegment

Implements construction algorithms for line segments in 3D space. The result is a Geom_TrimmedCurve. A GC_MakeSegment object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and resulting segment via Value().

Constructors(4)

  • Creates a segment of a line from two points.

    Parameters (2)
    • theP1 —
      first point
    • theP2 —
      second point
    Remarks

    Note: Construction fails if the two points are coincident.

  • constructor(theLine: gp_Lin, theU1: number, theU2: number): GC_MakeSegment

    Creates a segment of the input line between two parameters.

    Parameters (3)
    • theLine —
      source line
    • theU1 —
      first parameter
    • theU2 —
      second parameter
    Remarks

    Note: Construction fails when both parameters are equal.

  • constructor(theLine: gp_Lin, thePoint: gp_Pnt, theUlast: number): GC_MakeSegment

    Creates a segment of the input line between a point and a parameter.

    Parameters (3)
    • theLine —
      source line
    • thePoint —
      start point on line
    • theUlast —
      end parameter
    Remarks

    Note: Construction fails if trimming parameters are equal.

  • constructor(theLine: gp_Lin, theP1: gp_Pnt, theP2: gp_Pnt): GC_MakeSegment

    Creates a segment of the input line between two points.

    Parameters (3)
    • theLine —
      source line
    • theP1 —
      first point
    • theP2 —
      second point
    Remarks

    Note: Construction fails if trimming parameters are equal.

Instance methods(1)

GC_MakeSegment2d

This class implements construction algorithms for line segments in the plane. The result is a Geom2d_TrimmedCurve. A GC_MakeSegment2d object provides a framework for:

  • defining the construction parameters;
  • running the construction algorithm;
  • querying the construction status and the resulting segment via Value().

Constructors(5)

  • Creates a segment between two points.

    Parameters (2)
    • theP1 —
      first point
    • theP2 —
      second point
    Remarks

    Note: Construction fails with gce_ConfusedPoints if points are coincident.

  • Creates a segment on a line defined by point and direction. The segment starts at theP1 and ends at the orthogonal projection of theP2 onto that line.

    Parameters (3)
    • theP1 —
      first point
    • theV —
      direction vector
    • theP2 —
      second point
    Remarks

    Note: Construction fails with gce_ConfusedPoints if the projected endpoint is coincident with theP1 within resolution.

  • constructor(theLine: gp_Lin2d, theU1: number, theU2: number): GC_MakeSegment2d

    Creates a segment on a line between two parameter values.

    Parameters (3)
    • theLine —
      source line
    • theU1 —
      first parameter
    • theU2 —
      second parameter
  • constructor(theLine: gp_Lin2d, thePoint: gp_Pnt2d, theUlast: number): GC_MakeSegment2d

    Creates a segment on a line between point parameter and target parameter.

    Parameters (3)
    • theLine —
      source line
    • thePoint —
      first point on segment support line
    • theUlast —
      last parameter
  • Creates a segment on a line between projections of two points.

    Parameters (3)
    • theLine —
      source line
    • theP1 —
      first point
    • theP2 —
      second point

Instance methods(1)

  • Returns the constructed line segment. Exceptions StdFail_NotDone if no line segment is constructed.

    Returns

    resulting trimmed curve

GC_MakeTranslation

This class implements elementary construction algorithms for a translation in 3D space. The result is a Geom_Transformation transformation. A MakeTranslation object provides a framework for:

  • defining the construction of the transformation,
  • implementing the construction algorithm, and
  • consulting the result.

Constructors(2)

Instance methods(1)

GC_MakeTranslation2d

This class implements elementary construction algorithms for translations in 2D space. The result is a Geom2d_Transformation. A GC_MakeTranslation2d object provides a framework for:

  • defining the transformation parameters;
  • running the construction algorithm;
  • querying the resulting transformation via Value().

Constructors(2)

Instance methods(1)

GC_MakeTrimmedCone

Implements construction algorithms for trimmed cones. The result is a Geom_RectangularTrimmedSurface. A MakeTrimmedCone provides a framework for:

  • defining the construction of the trimmed cone,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed trimmed cone.

Constructors(2)

  • constructor(theP1: gp_Pnt, theP2: gp_Pnt, theP3: gp_Pnt, theP4: gp_Pnt): GC_MakeTrimmedCone

    Creates a rectangular trimmed conical surface from four points.

    Parameters (4)
    • theP1 —
      first axis point
    • theP2 —
      second axis point
    • theP3 —
      point defining first trimming section
    • theP4 —
      point defining second trimming section
    Remarks

    Note: Construction fails if points P1, P2, P3 and P4 are collinear, or if vector P3P4 is perpendicular/collinear to vector P1P2.

  • constructor(theP1: gp_Pnt, theP2: gp_Pnt, theR1: number, theR2: number): GC_MakeTrimmedCone

    Creates a rectangular trimmed conical surface from two points and two radii.

    Parameters (4)
    • theP1 —
      first axis point
    • theP2 —
      second axis point
    • theR1 —
      radius at P1
    • theR2 —
      radius at P2
    Remarks

    Note: On failure, status is propagated from GC_MakeConicalSurface(theP1, theP2, theR1, theR2).

Instance methods(1)

GC_MakeTrimmedCylinder

Implements construction algorithms for trimmed cylinders. The result is a Geom_RectangularTrimmedSurface. A MakeTrimmedCylinder provides a framework for:

  • defining the construction of the trimmed cylinder,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed trimmed cylinder.

Constructors(3)

  • constructor(theCirc: gp_Circ, theHeight: number): GC_MakeTrimmedCylinder

    Creates a trimmed cylindrical surface from a base circle and height.

    Parameters (2)
    • theCirc —
      base circle
    • theHeight —
      trimming height
    Remarks

    Note: If theHeight is negative, it has the opposite orientation.

  • Creates a trimmed cylindrical surface from three points.

    Parameters (3)
    • theP1 —
      first axis point
    • theP2 —
      second axis point
    • theP3 —
      point defining radius
    Remarks

    Note: The height is the distance between theP1 and theP2.

  • constructor(theA1: gp_Ax1, theRadius: number, theHeight: number): GC_MakeTrimmedCylinder

    Creates a trimmed cylindrical surface from axis, radius and height.

    Parameters (3)
    • theA1 —
      cylinder axis
    • theRadius —
      cylinder radius
    • theHeight —
      trimming height
    Remarks

    Note: If theHeight is negative, it has the opposite orientation.

Instance methods(1)

  • Returns the constructed trimmed cylinder. Exceptions StdFail_NotDone if no trimmed cylinder is constructed.

    Returns

    resulting trimmed cylindrical surface

GC_Root

Provides common status services for GC builders reporting construction errors.

Constructors(1)

Instance methods(3)

  • IsDone(): boolean

    Returns true if the construction is successful.

  • IsError(): boolean

    Returns true if the construction has failed.

  • Returns the status of the construction:

    • gce_Done, if the construction is successful, or
    • another value of the gce_ErrorType enumeration indicating why the construction failed.