Class CircularArcByCenterPointAbstract

A CircularArcByCenterPoint is a Shape that represents a general circular arc defined by a center point, radius, and two angles in the 2D space.

The CircularArcByCenterPaint is defined by:

  • The point (read-only).
  • The length of its radius (read-write).
  • The start azimuth of the circular arc. An azimuth is defined in degrees, clockwise, starting up/north (read-write).
  • The sweep angle over which the circular arc extends in degrees, clockwise (read-write).
A `CircularArcByCenterPoint` cannot be instantiated directly. Instead, it must be created using the createCircularArcByCenterPoint factory method.

Hierarchy (View Summary)

Constructors

constructor

Accessors

bounds center coordinateType endPoint focusPoint radius reference startAzimuth startPoint sweepAngle type

Methods

contains2D contains2DCoordinates contains2DPoint copy equals move2DToCoordinates move2DToPoint toString translate2D

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 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 the circular arc. This is the point that is defined by the radius of the arc and the arc's angle.

    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

  • set radius(value: number): void

    Parameters

    • value: number

    Returns void

  • get reference(): null | CoordinateReference

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

    Returns null | CoordinateReference

  • get startAzimuth(): number

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

    Returns number

  • set startAzimuth(value: number): void

    Parameters

    • value: number

    Returns void

  • get startPoint(): Point

    The start point of the circular arc. This is the point that is defined by the radius of the arc and the start angle of the arc.

    Returns Point

  • get sweepAngle(): number

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

    Returns number

  • set sweepAngle(v: number): void

    Parameters

    • v: number

    Returns void

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

    InvalidReferenceError

    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.

  • 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

    • x: number

      The x coordinate of the translation vector

    • y: number

      The y coordinate of the translation vector

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods