Class BezierCurveAbstract

Represents a Bézier curve. A Bézier curve is defined by ordered control points:

  • Three control points for a quadratic curve
  • Four control points for a cubic curve

The API allows modifying the position of these points.

Concrete instances of Bézier curves should be created using the factory functions createQuadraticBezierCurve and createCubicBezierCurve.

Since

2024.1

Hierarchy (view full)

Constructors

constructor

Accessors

bounds coordinateType focusPoint reference type

Methods

contains2D contains2DCoordinates contains2DPoint copy equals getControlPoint getControlPointCount getEndPoint getStartPoint interpolate invalidate moveControlPoint toString translate2D

Constructors

constructor

Accessors

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

AbstractcoordinateType

  • 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

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

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

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

    • Optionaly: number

    Returns boolean

    true when the given point is contained in this shape

    Throws

    InvalidReferenceError

    Deprecated

    Please use contains2DPoint instead.

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

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

    InvalidReferenceError when a point has another spatial reference

Abstractcopy

  • copy(): Shape

  • Makes a deep clone of this shape.

    Returns Shape

    a copy of this shape

equals

  • equals(otherShape): boolean

  • Indicates whether this shape is equal to another.

    Parameters

    • otherShape: Shape

      the other shape this shape is compared with.

    Returns boolean

    true if both shapes are equal, false otherwise.

getControlPoint

  • getControlPoint(index): Point

  • Returns the control point at the specified index within the list of the control points.

    • There are three control points for a quadratic curve.
    • There are four control points for a cubic curve.

    Parameters

    • index: number

      The zero-based index of the control point.

    Returns Point

    Throws

    ProgrammingError If the index is out of range of the control points array.

getControlPointCount

  • getControlPointCount(): number

  • Returns the count of control points defining the Bézier curve. For a quadratic curve, it returns 3. For a cubic curve, it returns 4.

    Returns number

getEndPoint

  • getEndPoint(): Point

  • Returns the end point (last control point) of the Bézier curve.

    Returns Point

getStartPoint

  • getStartPoint(): Point

  • Returns the start point (first control point) of the Bézier curve.

    Returns Point

interpolate

  • interpolate(param): Point

  • Computes and returns a point on the curve corresponding to the provided parameter value. The parameter should range from 0 to 1 inclusive, where:

    • A parameter of 0 corresponds to the start point of the curve.
    • A parameter of 1 corresponds to the end point of the curve.
    • For parameter values between 0 and 1, a point along the curve between the start and end points is returned.

    Parameters

    • param: number

      the parameter value, within [0,1], to compute the point location for.

    Returns Point

    the computed point on the curve.

invalidate

  • invalidate(): void

  • Returns void

moveControlPoint

  • moveControlPoint(index, newLocation): void

  • Moves the control point at the specified index to a new 2D location.

    Parameters

    • index: number

      The zero-based index of the control points.

    • newLocation: Point

      The new location to which the control point should be moved.

    Returns void

    Throws

    ProgrammingError If the index is out of range of the control points array.

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

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

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods