Class Line

a line segment Object

Param: x

origin point of the Line

Param: y

origin point of the Line

Param: points

array of vectors defining the Line

Hierarchy (view full)

Constructors

constructor

Properties

_bounds points pos type

Methods

clone contains getBounds getIndices isConvex recalc rotate scale scaleV setShape setVertices shift to2d toIso transform translate updateBounds

Constructors

constructor

Properties

_bounds

_bounds: undefined | object

points

points: Vector2d[]

Array of points defining the Polygon
Note: If you manually change points, you must call recalcafterwards so that the changes get applied correctly.

pos

pos: Vector2d

origin point of the Polygon

type

type: string

the shape type (used internally)

Default

"Polygon"

Methods

clone

contains

  • contains(...args): boolean

  • Returns true if the Line contains the given point

    Parameters

    • Rest...args: any

    Returns boolean

    true if contains

    Example

    if (line.contains(10, 10)) {
      // do something
    }
    // or
    if (line.contains(myVector2d)) {
      // do something
    }

getBounds

getIndices

  • getIndices(): number[]

  • returns a list of indices for all triangles defined in this polygon

    Returns number[]

    an array of vertex indices for all triangles forming this polygon.

isConvex

  • isConvex(): boolean

  • Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).

    Returns boolean

    true if the vertices are convex, false if not, null if not computable

recalc

  • recalc(): Line

  • Computes the calculated collision edges and normals. This must be called if the points array, angle, or offset is modified manually.

    Returns Line

    this instance for objecf chaining

rotate

scale

scaleV

setShape

  • setShape(x, y, points): Polygon

  • set new value to the Polygon

    Parameters

    • x: number

      position of the Polygon

    • y: number

      position of the Polygon

    • points: number[] | Vector2d[]

      array of vector or vertice defining the Polygon

    Returns Polygon

    this instance for objecf chaining

setVertices

shift

  • shift(...args): void

  • Shifts the Polygon to the given position vector.

    Parameters

    • Rest...args: any

    Returns void

    Example

    polygon.shift(10, 10);
    // or
    polygon.shift(myVector2d);

to2d

toIso

transform

translate

  • translate(...args): Polygon

  • translate the Polygon by the specified offset

    Parameters

    • Rest...args: any

    Returns Polygon

    Reference to this object for method chaining

    Example

    polygon.translate(10, 10);
    // or
    polygon.translate(myVector2d);

updateBounds

Settings

Member Visibility

On This Page

constructor_boundspointspostypeclonecontainsgetBoundsgetIndicesisConvexrecalcrotatescalescaleVsetShapesetVerticesshiftto2dtoIsotransformtranslateupdateBounds