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

edges indices points pos type

Methods

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

Constructors

constructor

Properties

edges

edges: Vector2d[]

The edges here are the direction of the nth edge of the polygon, relative to the nth point. If you want to draw a given edge from the edge value, you must first translate to the position of the starting point.

indices

indices: number[]

a list of indices for all vertices composing this polygon

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 = "Polygon"

the shape type (used internally)

Methods

clone

contains

  • contains(x, y?): boolean

  • Returns true if the Line contains the given point

    Parameters

    • x: number

      x coordinate or a vector point to check

    • Optionaly: number

      y coordinate

    Returns boolean

    true if contains

    Example

    if (line.contains(10, 10)) {
      // do something
    }
    // or
    if (line.contains(myVector2d)) {
      // do something
    }
  • contains(vector): boolean

  • Returns true if the polygon contains the given point.
    (Note: it is highly recommended to first do a hit test on the corresponding
    bounding rect, as the function can be highly consuming with complex shapes)

    Parameters

    Returns boolean

    True if the polygon contain the point, otherwise false

    Example

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

getBounds

getIndices

isConvex

  • isConvex(): null | boolean

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

    Returns null | boolean

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

recalc

rotate

scale

  • scale(x, y?): Line

  • Scales the polygon by the given factors along the x and y axes.

    Parameters

    • x: number

      The factor by which to scale the polygon along the x-axis.

    • Optionaly: number = x

      The factor by which to scale the polygon along the y-axis. Defaults to the value of x.

    Returns Line

    Reference to this object for method chaining

scaleV

setShape

setVertices

shift

to2d

toIso

transform

translate

updateBounds

Settings

Member Visibility

On This Page

Constructors
Properties
Methods