Class Line

constructor

• new Line(x?, y?, vertices): Line

• Parameters

  • Optionalx: number = 0

    origin point of the Polygon

  • Optionaly: number = 0

    origin point of the Polygon

  • vertices: PolygonVertices | LineVertices

    array of vector defining the Polygon

  Returns Line

edges

indices

points

pos

type

clone

• clone(): Line

• clone this line segment

  Returns Line

  new Line

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
  }
  Copy

• 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

  • vector: Vector2d

  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
  }
  Copy

getBounds

• getBounds(): Bounds

• returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.

  Returns Bounds

  this shape bounding box Rectangle object

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(): 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

• 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

• rotate(angle, v?): Line

• Rotate this Polygon (counter-clockwise) by the specified angle (in radians).

  Parameters

  • angle: number

    The angle to rotate (in radians)

  • Optionalv: XYPoint | Vector2d

    an optional point to rotate around

  Returns Line

  Reference to this object for method chaining

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

• scaleV(v): Line

• Scales the polygon by the given vector.

  Parameters

  • v: Vector2d

    A vector containing the scaling factors for the x and y axes.

  Returns Line

  Reference to this object for method chaining

setShape

• setShape(x, y, points): Line

• set new value to the Polygon

  Parameters

  • x: number

    position of the Polygon

  • y: number

    position of the Polygon

  • points: PolygonVertices | LineVertices

    array of vector or vertice defining the Polygon

  Returns Line

  this instance for objecf chaining

setVertices

• setVertices(vertices): Line

• set the vertices defining this Polygon

  Parameters

  • vertices: PolygonVertices | LineVertices

    array of vector or vertice defining the Polygon

  Returns Line

  this instance for objecf chaining

shift

• shift(x, y?): void

• Shifts the Polygon to the given position vector.

  Parameters

  • x: number

    The x coordinate or a vector point to shift to.

  • Optionaly: number

    The y coordinate. This parameter is required if the first parameter is a number.

  Returns void

  Example

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

• shift(vector): void

• Parameters

  • vector: Vector2d

  Returns void

to2d

• to2d(): Line

• apply a 2d projection to this shapen

  Returns Line

  Reference to this object for method chaining

toIso

• toIso(): Line

• apply an isometric projection to this shape

  Returns Line

  Reference to this object for method chaining

transform

• transform(m): Line

• apply the given transformation matrix to this Polygon

  Parameters

  • m: Matrix2d

    the transformation matrix

  Returns Line

  Reference to this object for method chaining

translate

• translate(x, y?): Polygon

• Translates the Polygon by the specified offset.

  Parameters

  • x: number

    The x offset or a vector point to translate by.

  • Optionaly: number

    The y offset. This parameter is required if the first parameter is a number.

  Returns Polygon

  Reference to this object for method chaining

  Example

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

• translate(vector): Polygon

• Parameters

  • vector: Vector2d

  Returns Polygon

updateBounds

• updateBounds(): Bounds

• update the bounding box for this shape.

  Returns Bounds

  this shape bounding box Rectangle object