Class: Line

World.Line(points, maxLinePointDist, color, copied)

Class describing an individual line. This is done as a series of points along a defined path. There is a minimum distance between points that needs to be adhered to in order for the line following to work correctly. This distance is defined by World.maxInterLinePointDist. This class ensures that this limit is obeyed and adds extra points using linear interpolation if necessary. The points only need to be defined at corners for straight line objects. For curves the points should be defined frequently enough to show the shape of the curve to the desired resolution. The class will add more to ensure the max inter line point distance threshold is obeyed. The line point data is scaled to the grid size.

Constructor

new Line(points, maxLinePointDist, color, copied)

The constructor for the World.Line class.
Parameters:
Name Type Default Description
points Array.<p5.Vector> An array of points with x/y values between zero and one to indicate the edges of a tile.
maxLinePointDist number The maximum spacing between adjacent points. Default World.maxInterLinePointDist
color String #000000 Hex string for rgb color eg "#AABBCC"
copied Boolean false Flag to show if the data is from World.Line.copy(). This prevents the data from being rescaled to the grid size.
Source:
See:

Methods

checkInterLinePointDistance()

Checks the inter point distance and adds a point between them if they are further apart than the maximum inter point distance. This continues until no pair of adjacent points are further apart than the inter point distance threshold.
Source:

copy()

Copies the line object. All points are copied and a new World.Line object is instantiated with the copy argument set to true. This prevents the object from rescaling to World.gridSize.
Source:

flipDiagonal() → {World.Line}

Flips all of the line points in the diagonal direction. i.e a reflection along the line y=x.
Source:
Returns:
- Returns this so that calls can be chained.
Type
World.Line

flipHorizontal() → {World.Line}

Flips all of the line points in the horizontal direction. i.e a reflection in the vertical axis.
Source:
Returns:
- Returns this so that calls can be chained.
Type
World.Line

flipVertical() → {World.Line}

Flips all of the line points in the vertical direction. i.e a reflection in the horizontal axis.
Source:
Returns:
- Returns this so that calls can be chained.
Type
World.Line

scaleLinePointsToGridSize()

Scales the 0-1 normalized points to grid size. This is done by multiplying all points by World.gridSize.
Source:

setPoints(points)

Copies the original points into an internal array of points.
Parameters:
Name Type Description
points p5.Vector The list of points to copy.
Source:

Documentation generated by JSDoc 4.0.2 on Fri Aug 30 2024 16:12:55 GMT-0600 (Mountain Daylight Time)