LuciadRIA (2026.0.03)
    Preparing search index...

    A CircularArcByBulge is a Shape that represents a circular arc defined by two points and a bulge factor in 2D space.

    A bulge factor of 1 indicates that the arc forms a half-circle. As the bulge factor approaches 0, the arc flattens, meaning the radius of the arc's circle increases. The sign of the bulge determines whether the bulge is on the left or right side of the vector from the start point to the end point.

    More specifically, consider the chord between the start point (S) and the end point (E) with a point (C) in the middle of it. The midpoint (M) of the arc is located on a line that extends from C and is oriented along the normal. The bulge factor is the ratio of the distances MC and SC. The sign of the bulge indicates whether the midpoint is on the left side (positive) or right side (negative) of the vector from the start point to the end point.

    The CircularArcByBulge is defined by:

    • The point (read-only).
    • The start point startPoint. (read-only).
    • The end point endPoint. (read-only).
    • The bulge factor bulge. (read-write).
    A `CircularArcByBulge` cannot be instantiated directly. Instead, it must be created using the createCircularArcByBulge factory method.

    Hierarchy (View Summary)

    Constructors

    Accessors

    • get bounds(): Bounds

      The bounds of this shape. This property is to be treated in a read only manner. An error will be thrown when trying to assign to this property. Note that the bounds property is not immutable. Modifying properties of the bounds property may corrupt your data.

      Returns Bounds

    • get bulge(): number

      The bulge factor of the arc. This field is mutable.

      The bulge factor is the ratio of (1) the distance between the arc midpoint and the center of the arc's chord, and (2) half the length of the arc's chord. The sign of the bulge indicates whether the midpoint is on the left side (positive) or right side (negative) of the vector from start to end point. So a bulge factor with an absolute value of 1 means a half-circle, smaller than 1 means a less bulging arc and larger than 1 means an arc that bulges out in the start and end point.

      Returns number

    • set bulge(value: number): void

      Parameters

      • value: number

      Returns void

    • get center(): Point

      The center point of the circle defining the circular arc. This field is read-only.

      Please use move2DToCoordinates or move2DToPoint to move the center point to a new position.

      Returns Point

    • get coordinateType(): CoordinateType

      The coordinate type this shape. This property is read only. An Error will be thrown when trying to assign to this property.

      Returns CoordinateType

    • get endPoint(): Point

      The end point of this circular arc.

      Returns Point

    • get focusPoint(): Point

      The focus point of this shape. This property is read only. An error will be thrown when trying to assign to this property. This property contains an object but should be treated with value semantics: changes to the shape will not be reflected in the focusPoint that was retrieved from this Polygon before the modification.

      Returns Point

    • get radius(): number

      The radius of the circle defining the circular arc.

      Returns number

    • get reference(): CoordinateReference | null

      The spatial reference of this shape. This property is read only. An Error will be thrown when trying to assign to this property.

      Returns CoordinateReference | null

    • get startAzimuth(): number

      The start angle. It is defined as an azimuth: in degrees, positive clockwise, starting up/north.

      Returns number

    • get startPoint(): Point

      The start point of this circular arc.

      Returns Point

    • get sweepAngle(): number

      The angle over which the arc extends. It is defined in degrees, positive clockwise.

      Returns number

    Methods

    • Determines whether a given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

      Parameters

      • x: number | Point | Bounds

        The point for which containment must be checked. If a 3D point is passed to this function, it will be treated as a 2D point: the z coordinate (height) will be ignored. The reference of this point must be the same reference as this Shape

      • Optionaly: number

      Returns boolean

      true when the given point is contained in this shape

      Please use contains2DPoint instead.

    • Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

      Parameters

      • x: number

        The x coordinate of the point for which containment must be checked

      • y: number

        The y coordinate of the point for which containment must be checked

      Returns boolean

      true when the given point is contained in this shape

    • Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

      Parameters

      • point: Point

        The point for which containment must be checked.

      Returns boolean

      true when the given point is contained in this shape

      InvalidReferenceError when a point has another spatial reference

    • Indicates whether this shape is equal to another.

      Parameters

      Returns boolean

      true if both shapes are equal, false otherwise.

    • Translates this shape so that its center point ends up at the specified position.

      Parameters

      • x: number

        x coordinate value

      • y: number

        y coordinate value

      Returns void

    • Translates this shape so that its center point ends up at the specified position.

      Parameters

      Returns void

      InvalidReferenceError when the reference of the Point parameter does not correspond with the reference of this shape.

    • Moves the end point of this circular arc to the given coordinates

      Parameters

      • x: number

        The new x coordinate of the end point on this circular arc

      • y: number

        The new y coordinate of the end point on this circular arc

      Returns void

    • Moves the end point of this circular arc to the given point

      Parameters

      Returns void

    • Moves the start point of this circular arc to the given coordinates

      Parameters

      • x: number

        The new x coordinate of the start point on this circular arc

      • y: number

        The new y coordinate of the start point on this circular arc

      Returns void

    • Moves the start point of this circular arc to the given point

      Parameters

      Returns void

    • Converts the shape to a string. This functionality is for debugging purposes only. Results of toString cannot be used to uniquely identify a shape instance.

      Returns string

    • Translates the shape over the given vector in 2D space.

      Parameters

      • aDeltaX: number
      • aDeltaY: number

      Returns void

    • Translates the end point of this circular arc from its current position over the given translation vector to another location.

      Parameters

      • aDeltaX: number

        vector x coordinate value

      • aDeltaY: number

        vector y coordinate value

      Returns void

    • Translates the start point of this circular arc from its current position over the given translation vector to another location.

      Parameters

      • aDeltaX: number

        vector x coordinate value

      • aDeltaY: number

        vector y coordinate value

      Returns void