melonJS
    Preparing search index...

    Class Line

    a line segment Object

    origin point of the Line

    origin point of the Line

    array of vectors defining the Line

    Hierarchy (View Summary)

    Index
    constructor
    collisionMask? collisionType? edges indices isActive? isTrigger? points pos type
    clone contains getBounds getIndices isConvex recalc rotate scale scaleV setShape setVertices shift to2d toIso transform translate updateBounds

    • 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

    collisionMask?: number
    collisionType?: number

    Optional per-shape collision settings, honoured by Body#addShape and defaulted there. Declared rather than initialized: the body writes them when the shape joins it, so a class field here would emit an undefined own property on every shape ever built. See addShape for the table of defaults and what each one does.

    Body#addShape

    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: number[]

    a list of indices for all vertices composing this polygon, filled in by Polygon#getIndices and invalidated by Polygon#recalc.

    A subclass may repurpose this name for geometry of its own: a Mesh holds a GPU index buffer here, a typed array rather than a plain one. recalc therefore only clears the slot when it owns it — anything else reading it should check what it got.

    isActive?: boolean

    false takes this shape out of collision without removing it

    isTrigger?: boolean

    true reports contacts but skips the position correction

    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: Vector2d

    origin point of the Polygon

    type: string = "Polygon"

    the shape type (used internally)

    • 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

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

    • Returns true if the Line contains the given point

      Parameters

      Returns boolean

      true if contains

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

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

      Returns boolean | null

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

    • 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

    • 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 vertices defining the Polygon

      Returns Line

      this instance for object chaining

    • 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

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

    • Shifts the Polygon to the given position vector.

      Parameters

      Returns void

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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods