Class Curve

constructor

• new Curve(type: string): Curves.Curve

  Parameters

  • type: string

    The curve type.

  Returns Curves.Curve

active

arcLengthDivisions

cacheArcLengths

defaultDivisions

needsUpdate

type

draw

• draw<G extends GameObjects.Graphics>(graphics: G, pointsTotal?: number): G

  Draws this curve on the given Graphics object.

  The curve is drawn using Graphics.strokePoints so will be drawn at whatever the present Graphics stroke color is. The Graphics object is not cleared before the draw, so the curve will appear on-top of anything else already rendered to it.

  Type Parameters

  • G extends GameObjects.Graphics

  Parameters

  • graphics: G

    The Graphics instance onto which this curve will be drawn.
  • OptionalpointsTotal: number

    The resolution of the curve. The higher the value the smoother it will render, at the cost of rendering performance. Default 32.

  Returns G

getBounds

• getBounds(out?: Geom.Rectangle, accuracy?: number): Geom.Rectangle

  Returns a Rectangle where the position and dimensions match the bounds of this Curve.

  You can control the accuracy of the bounds. The value given is used to work out how many points to plot across the curve. Higher values are more accurate at the cost of calculation speed.

  Parameters

  • Optionalout: Geom.Rectangle

    The Rectangle to store the bounds in. If falsey a new object will be created.
  • Optionalaccuracy: number

    The accuracy of the bounds calculations. Default 16.

  Returns Geom.Rectangle

getDistancePoints

• getDistancePoints(distance: number): Math.Vector2[]

  Returns an array of points, spaced out X distance pixels apart. The smaller the distance, the larger the array will be.

  Parameters

  • distance: number

    The distance, in pixels, between each point along the curve.

  Returns Math.Vector2[]

getEndPoint

• getEndPoint(out?: Math.Vector2): Math.Vector2

  Get a point at the end of the curve.

  Parameters

  • Optionalout: Math.Vector2

    Optional Vector object to store the result in.

  Returns Math.Vector2

getLength

• getLength(): number

  Get total curve arc length

  Returns number

getLengths

• getLengths(divisions?: number): number[]

  Get a list of cumulative segment lengths.

  These lengths are

  • [0] 0
  • [1] The first segment
  • [2] The first and second segment
  • ...
  • [divisions] All segments

  Parameters

  • Optionaldivisions: number

    The number of divisions or segments.

  Returns number[]

getPointAt

• getPointAt<O extends Math.Vector2>(u: number, out?: O): O

  Get a point at a relative position on the curve, by arc length.

  Type Parameters

  • O extends Math.Vector2

  Parameters

  • u: number

    The relative position, [0..1].
  • Optionalout: O

    A point to store the result in.

  Returns O

getPoints

• getPoints<O extends Math.Vector2[]>(
      divisions?: number,
      stepRate?: number,
      out?: O,
  ): O

  Get a sequence of evenly spaced points from the curve.

  You can pass divisions, stepRate, or neither.

  The number of divisions will be

  1. divisions, if divisions > 0; or
  2. this.getLength / stepRate, if stepRate > 0; or
  3. this.defaultDivisions

  1 + divisions points will be returned.

  Type Parameters

  • O extends Math.Vector2[]

  Parameters

  • Optionaldivisions: number

    The number of divisions to make.
  • OptionalstepRate: number

    The curve distance between points, implying divisions.
  • Optionalout: O

    An optional array to store the points in.

  Returns O

getRandomPoint

• getRandomPoint<O extends Math.Vector2>(out?: O): O

  Get a random point from the curve.

  Type Parameters

  • O extends Math.Vector2

  Parameters

  • Optionalout: O

    A point object to store the result in.

  Returns O

getSpacedPoints

• getSpacedPoints(
      divisions?: number,
      stepRate?: number,
      out?: Math.Vector2[],
  ): Math.Vector2[]

  Get a sequence of equally spaced points (by arc distance) from the curve.

  1 + divisions points will be returned.

  Parameters

  • Optionaldivisions: number

    The number of divisions to make. Default this.defaultDivisions.
  • OptionalstepRate: number

    Step between points. Used to calculate the number of points to return when divisions is falsy. Ignored if divisions is positive.
  • Optionalout: Math.Vector2[]

    An optional array to store the points in.

  Returns Math.Vector2[]

getStartPoint

• getStartPoint<O extends Math.Vector2>(out?: O): O

  Get a point at the start of the curve.

  Type Parameters

  • O extends Math.Vector2

  Parameters

  • Optionalout: O

    A point to store the result in.

  Returns O

getTangent

• getTangent<O extends Math.Vector2>(t: number, out?: O): O

  Get a unit vector tangent at a relative position on the curve. In case any sub curve does not implement its tangent derivation, 2 points a small delta apart will be used to find its gradient which seems to give a reasonable approximation

  Type Parameters

  • O extends Math.Vector2

  Parameters

  • t: number

    The relative position on the curve, [0..1].
  • Optionalout: O

    A vector to store the result in.

  Returns O

getTangentAt

• getTangentAt<O extends Math.Vector2>(u: number, out?: O): O

  Get a unit vector tangent at a relative position on the curve, by arc length.

  Type Parameters

  • O extends Math.Vector2

  Parameters

  • u: number

    The relative position on the curve, [0..1].
  • Optionalout: O

    A vector to store the result in.

  Returns O

getTFromDistance

• getTFromDistance(distance: number, divisions?: number): number

  Given a distance in pixels, get a t to find p.

  Parameters

  • distance: number

    The distance, in pixels.
  • Optionaldivisions: number

    Optional amount of divisions.

  Returns number

getUtoTmapping

• getUtoTmapping(u: number, distance: number, divisions?: number): number

  Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equidistant.

  Parameters

  • u: number

    A float between 0 and 1.
  • distance: number

    The distance, in pixels.
  • Optionaldivisions: number

    Optional amount of divisions.

  Returns number

updateArcLengths

• updateArcLengths(): void

  Calculate and cache the arc lengths.

  Returns void