Class AcGeEllipseArc3d

Class representing a 3d ellipse arc defined by center, normal, majorAxis, majorAxisRadius, minorAxisRadius, startAngle, and endAngle.

  • The majorAxis vector represents half the major axis of the ellipse (that is, from the center point to the start point of the ellipse) and is the zero angle for startAngle and endAngle.
  • Positive angles are counter-clockwise when looking down the normal vector (that is, right-hand rule). A startAngle of 0 and endAngle of 2pi will produce a closed Ellipse.
  • If startAngle is equal to 0 and endAngle is equal to 2 * Math.PI, it represents a full 3d ellipse.

Hierarchy

  • AcGeCurve3d
    • AcGeEllipseArc3d

Constructors

constructor

Properties

_boundingBoxNeedsUpdate

Accessors

boundingBoxNeedUpdate box center clockwise closed deltaAngle endAngle endPoint isCircular isLargeArc length majorAxis majorAxisRadius minorAxis minorAxisRadius normal plane startAngle startPoint

Methods

calculateBoundingBox clone contains copy getPointAtAngle getPoints transform translate

Constructors

constructor

  • new AcGeEllipseArc3d(
        center: AcGeVectorLike,
        normal: AcGeVector3dLike,
        majorAxis: AcGeVector3dLike,
        majorAxisRadius: number,
        minorAxisRadius: number,
        startAngle?: number,
        endAngle?: number,
    ): AcGeEllipseArc3d

  • Construct an instance of the ellipse arc.

    Parameters

    • center: AcGeVectorLike

      Center point of the ellipse.

    • normal: AcGeVector3dLike

      Normal vector defining the plane of the ellipse

    • majorAxis: AcGeVector3dLike

      Major axis vector (in WCS coordinates) of the ellipse.

    • majorAxisRadius: number

      Major axis radius of the ellipse.

    • minorAxisRadius: number

      Minor axis radius of the ellipse.

    • OptionalstartAngle: number

      Start angle of the ellipse arc in radians.

    • OptionalendAngle: number

      End angle of the ellipse arc in radians.

    Returns AcGeEllipseArc3d

Properties

Protected_boundingBoxNeedsUpdate

_boundingBoxNeedsUpdate: boolean

Accessors

boundingBoxNeedUpdate

  • get boundingBoxNeedUpdate(): boolean

  • When this is set, it calculates the bounding box of this shape and resets this property to false. Default is false.

    Returns boolean

box

  • get box(): AcGeBox3d

  • The bounding box of this shape. Because it is a time-consuming operation to calculate the bounding box of one shape, the bounding box value is cached. It will be calculated again lazily once there are any changes to properties of this shape.

    Returns AcGeBox3d

center

  • get center(): AcGePoint3d

  • Center of the ellipse in 3d space

    Returns AcGePoint3d

  • set center(value: AcGeVectorLike): void

  • Parameters

    Returns void

clockwise

  • get clockwise(): boolean

  • Return true if the arc is clockwise from startAngle to endAngle

    Returns boolean

closed

  • get closed(): boolean

  • Return true if its start point is identical to its end point. Otherwise, return false.

    Returns boolean

deltaAngle

  • get deltaAngle(): number

  • Return angle between endAngle and startAngle in range 0 to 2*PI

    Returns number

endAngle

  • get endAngle(): number

  • End angle of the ellipse arc in radians in the range -pi to pi.

    Returns number

  • set endAngle(value: number): void

  • Parameters

    • value: number

    Returns void

endPoint

  • get endPoint(): AcGePoint3d

  • Compute the end point of the ellipse arc.

    Returns AcGePoint3d

    Return the end point of the ellipse arc.

isCircular

  • get isCircular(): boolean

  • Check if this ellipse arc is actually a circular arc (major and minor radii are equal)

    Returns boolean

    True if the ellipse arc is circular

isLargeArc

  • get isLargeArc(): 0 | 1

  • Return true if the arc is a large arc whose delta angle value is greater than PI.

    Returns 0 | 1

length

  • get length(): number

  • Length of this curve.

    Returns number

majorAxis

  • get majorAxis(): AcGeVector3d

  • Unit major axis vector (in WCS coordinates) of the ellipse. The major axis vector is the vector from the ellipse's center point to its start point.

    Returns AcGeVector3d

  • set majorAxis(value: AcGeVector3dLike): void

  • Parameters

    Returns void

majorAxisRadius

  • get majorAxisRadius(): number

  • Major axis radius of the ellipse

    Returns number

  • set majorAxisRadius(value: number): void

  • Parameters

    • value: number

    Returns void

minorAxis

  • get minorAxis(): AcGeVector3d

  • Unit minor axis vector (in WCS coordinates) of the ellipse.

    Returns AcGeVector3d

minorAxisRadius

  • get minorAxisRadius(): number

  • Minor axis radius of the ellipse

    Returns number

  • set minorAxisRadius(value: number): void

  • Parameters

    • value: number

    Returns void

normal

  • get normal(): AcGeVector3d

  • Unit normal vector defining the plane of the ellipse

    Returns AcGeVector3d

  • set normal(value: AcGeVector3dLike): void

  • Parameters

    Returns void

plane

  • get plane(): AcGePlane

  • Return the plane in which the ellipse arc lies.

    Returns AcGePlane

startAngle

  • get startAngle(): number

  • Start angle of the ellipse arc in radians in the range -pi to pi.

    Returns number

  • set startAngle(value: number): void

  • Parameters

    • value: number

    Returns void

startPoint

  • get startPoint(): AcGePoint3d

  • Compute the start point of the ellipse arc.

    Returns AcGePoint3d

    Return the start point of the ellipse arc.

Methods

calculateBoundingBox

  • calculateBoundingBox(): AcGeBox3d

  • Compute the bounding box of the 3D ellipse arc. The bounding box is defined by its minimum and maximum x, y, and z coordinates.

    Returns AcGeBox3d

    Return bounding box containing the min and max coordinates

clone

contains

  • contains(point: AcGePoint3d): boolean

  • Determines whether a given point is inside the ellipse.

    Parameters

    Returns boolean

    • True if the point is inside the ellipse, false otherwise.

copy

getPointAtAngle

  • getPointAtAngle(angle: number): AcGePoint3d

  • Calculate a point on the ellipse at a given angle.

    Parameters

    • angle: number

      Input the angle in radians where the point is to be calculated.

    Returns AcGePoint3d

    Return the 3d coordinates of the point on the ellipse.

getPoints

  • getPoints(numPoints?: number): AcGePoint3d[]

  • Parameters

    • OptionalnumPoints: number

    Returns AcGePoint3d[]

transform

  • transform(_matrix: AcGeMatrix3d): this

  • Parameters

    Returns this

    Inherit Doc

translate

  • translate(v: AcGeVector3dLike): AcGeShape3d

  • Return new shape translated by given vector. Translation vector may be also defined by a pair of numbers.

    Parameters

    Returns AcGeShape3d

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods