Options
All
  • Public
  • Public/Protected
  • All
Menu

Circular-arc-by-bulge interface. A circular-arc-by-bulge is a Shape that represents a circular arc defined by two points and a bulge factor in the 2D space. A bulge factor of 1 means that the arc defines half a circle. As the bulge factor goes towards 0 the arc becomes flatter (i.e. the radius of the arc's circle increases). The sign of the bulge indicates whether the bulge is on the left side or right side of the vector from start to end point.

More specifically, consider the chord between start point S and end point E with a point C in the middle of it. The midpoint M of the arc is located on a line that starts from C and is oriented along the normal. The bulge factor is the ratio of the distance of 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 start to end point.

The circular-arc-by-bulge 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 circular-arc-by-bulge cannot be instantiated directly. It must be instantiated using createCircularArcByBulge.

Hierarchy

Implements

Overview

Accessors

bounds

bulge

  • get bulge(): number
  • set bulge(value: number): void
  • 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

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

    Parameters

    • value: number

    Returns any

center

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

endPoint

focusPoint

  • get focusPoint(): Point

radius

  • get radius(): number
  • The radius of the circle defining the circular arc.

    Returns number

reference

  • 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

startAzimuth

  • get startAzimuth(): number
  • The start angle. It is defined as an azimuth: in degrees, positive clockwise, starting up/north.

    Returns number

startPoint

  • get startPoint(): Point

sweepAngle

  • get sweepAngle(): number
  • The angle over which the arc extends. It is defined in degrees, positive clockwise.

    Returns number

type

Methods

contains2D

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

    throws

    InvalidReferenceError when passing a Point with another spatial reference

    deprecated

    Please use contains2DPoint instead.

    Parameters

    • x: Point | number | 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

    • Optional y: number

    Returns boolean

    true when the given point is contained in this shape

Abstract contains2DCoordinates

  • (x: number, y: number): boolean
  • 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).

    throws

    InvalidReferenceError when passing a Point with another spatial reference

    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

contains2DPoint

  • (point: Point): boolean
  • 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).

    throws

    InvalidReferenceError when passing a Point with another spatial reference

    Parameters

    • point: Point

      The point for which containment must be checked.

    Returns boolean

    true when the given point is contained in this shape

Abstract copy

equals

move2DToCoordinates

  • (x: number, y: number): void
  • 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

move2DToPoint

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

    throws

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

    Parameters

    Returns void

Abstract moveEndPoint2DToCoordinates

  • (x: number, y: number): void
  • 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

moveEndPoint2DToPoint

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

    Parameters

    Returns void

Abstract moveStartPoint2DToCoordinates

  • (x: number, y: number): 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

moveStartPoint2DToPoint

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

    Parameters

    Returns void

toString

  • (): string

translate2D

  • (aDeltaX: number, aDeltaY: number): void
  • Parameters

    • aDeltaX: number
    • aDeltaY: number

    Returns void

Abstract translateEndPoint2D

  • (aDeltaX: number, aDeltaY: number): 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

Abstract translateStartPoint2D

  • (aDeltaX: number, aDeltaY: number): 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

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method