Class CircleBy3PointsAbstract

A CircleBy3Points is a Shape that represents a circle defined by three points on its circumference in the 2D space.

The CircleBy3Points is defined by:

A `CircleBy3Points` cannot be instantiated directly. Instead, it must be created using the createCircleBy3Points factory method.

Hierarchy (view full)

Constructors

constructor

Accessors

bounds center coordinateType firstPoint focusPoint radius reference secondPoint thirdPoint type

Methods

contains2D contains2DCoordinates contains2DPoint copy equals move2DToCoordinates move2DToPoint moveFirstPoint2DToCoordinates moveFirstPoint2DToPoint moveSecondPoint2DToCoordinates moveSecondPoint2DToPoint moveThirdPoint2DToCoordinates moveThirdPoint2DToPoint toString translate2D translateFirstPoint2D translateSecondPoint2D translateThirdPoint2D

Constructors

constructor

Accessors

Abstract bounds

  • 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

Abstract center

Abstract coordinateType

  • 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

Abstract firstPoint

Abstract focusPoint

  • 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

Abstract radius

  • get radius(): number

  • The radius of this circle, in meters.

    Returns number

  • set radius(value): void

  • Parameters

    • value: number

    Returns void

reference

  • 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

Abstract secondPoint

Abstract thirdPoint

type

Methods

contains2D

  • contains2D(x, y?): boolean

  • 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

    • Optional y: number

    Returns boolean

    true when the given point is contained in this shape

    Throws

    Point with another spatial reference

    Deprecated

    Please use contains2DPoint instead.

Abstract contains2DCoordinates

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

    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

    Throws

    Point with another spatial reference

contains2DPoint

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

    Parameters

    • point: Point

      The point for which containment must be checked.

    Returns boolean

    true when the given point is contained in this shape

    Throws

    Point with another spatial reference

Abstract copy

equals

  • equals(aCircle): boolean

  • Indicates whether this shape is equal to another.

    Parameters

    • aCircle: Shape

      the other shape this shape is compared with.

    Returns boolean

    true if both shapes are equal, false otherwise.

move2DToCoordinates

  • move2DToCoordinates(x, y): void

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

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    Returns void

move2DToPoint

  • move2DToPoint(point): void

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

    Parameters

    • point: Point

      The location to move too.

    Returns void

    Throws

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

Abstract moveFirstPoint2DToCoordinates

  • moveFirstPoint2DToCoordinates(x, y): void

  • Moves the first point of this circle to the given coordinates

    Parameters

    • x: number

      The new x coordinate of the start point

    • y: number

      The new y coordinate of the start point

    Returns void

moveFirstPoint2DToPoint

  • moveFirstPoint2DToPoint(point): void

  • Moves the first point of this circle to the given point *

    Parameters

    • point: Point

      The new coordinate of the start point

    Returns void

Abstract moveSecondPoint2DToCoordinates

  • moveSecondPoint2DToCoordinates(x, y): void

  • Moves the second point of this circle to the given coordinates

    Parameters

    • x: number

      The new x coordinate of the first intermediate point on this circle

    • y: number

      The new y coordinate of the first intermediate point on this circle

    Returns void

moveSecondPoint2DToPoint

  • moveSecondPoint2DToPoint(point): void

  • Moves the second point of this circle to the given point.

    Parameters

    • point: Point

      The new coordinate of the first intermediate point on this circle

    Returns void

Abstract moveThirdPoint2DToCoordinates

  • moveThirdPoint2DToCoordinates(x, y): void

  • Moves the second intermediate point of this circle to the given coordinates.

    Parameters

    • x: number

      The new x coordinate of the second intermediate point on this circle

    • y: number

      The new y coordinate of the second intermediate point on this circle

    Returns void

moveThirdPoint2DToPoint

  • moveThirdPoint2DToPoint(point): void

  • Moves the third point of this circle to the given point.

    Parameters

    • point: Point

      The new x coordinate of the second intermediate point on this circle

    Returns void

toString

  • toString(): string

  • 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

Abstract translate2D

  • translate2D(x, y): void

  • 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

Abstract translateFirstPoint2D

  • translateFirstPoint2D(x, y): void

  • Translates the first point of this circle from its current position over the given translation vector to another location.

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    Returns void

Abstract translateSecondPoint2D

  • translateSecondPoint2D(x, y): void

  • Translates the second point of this circle from its current position over the given translation vector to another location.

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    Returns void

Abstract translateThirdPoint2D

  • translateThirdPoint2D(x, y): void

  • Translates the third point of this circle from its current position over the given translation vector to another location.

    Parameters

    • x: number

      x coordinate value

    • y: number

      y coordinate value

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorboundscentercoordinateTypefirstPointfocusPointradiusreferencesecondPointthirdPointtypecontains2Dcontains2DCoordinatescontains2DPointcopyequalsmove2DToCoordinatesmove2DToPointmoveFirstPoint2DToCoordinatesmoveFirstPoint2DToPointmoveSecondPoint2DToCoordinatesmoveSecondPoint2DToPointmoveThirdPoint2DToCoordinatesmoveThirdPoint2DToPointtoStringtranslate2DtranslateFirstPoint2DtranslateSecondPoint2DtranslateThirdPoint2D