The Phaser Line constructor

In this post I will be writing about the phaser Line Constructor. This constructor may prove to be somewhat useful when doing anything involving line segments.

If new to Phaser

If you are new to phaser you might want to check out my post on getting started with phaser, I also assume that you have at least some knowlage of html, css, and javaScript as I do not have any posts on how to get up to speed with that at this time. This is my standard hexo tag for all phaser posts where I want to inform readers that this is not a post for beginers.

Quick Phaser Line Hello World.

To create a line segment I just need to pass the four arguments for the x, and y positions of the two points that make up the Line. To draw the line I can use Phasers Graphics display objects to get that done.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
var game = new Phaser.Game(320, 240, Phaser.AUTO, 'gamearea',
{
// create method
create : function () {
// making a graphics display object
var gra = game.add.graphics(0, 0),
// making an instance of Phaser.Line
line = new Phaser.Line(50, 190, 270, 190);
// draw the line
gra.lineStyle(3, 0xff0000);
gra.moveTo(line.start.x, line.start.y);
gra.lineTo(line.end.x, line.end.y);
}
}
);

Each line has a start point, and an end point and that is where the line.start, and that is of course where the line.start, and line.end objects come into play. Now that I have the basics done, it would be nice to know about some of the methods that are available for Lines.

Get the midpoint of a Line

This method will return a Point that is the midPoint of the line that I call the method on.

1
2
var line = new Phaser.Line(0,0,100,0);
console.log(line.midPoint().x); // 50

start and end

Every Line has a start and end point getting this is a simple as just cheking out these objects in the instance of Line.

1
2
3
4
var line = new Phaser.Line(10, 35, 320, 80);
console.log(line.start); // {x: 10, y: 35}
console.log(line.end); // {x: 320, y : 80}

In addition to being helpful just because they are objects that have the properties I often need, both of these Objects are instances of Phaser.Point, and as such have all the properties, and method of that constructor as well.

top, bottom, left, and right

As the names imply these properties simply just give the boundaries of the line.

1
2
3
4
5
6
var line = new Phaser.Line(10, 35, 320, 80);
console.log(line.top); // 35
console.log(line.bottom); //80
console.log(line.left); // 10
console.log(line.right); // 320

Get the length of a line

If I have an instance of Line there is no need to use the distance formula to get it’s length, there is all ready a property for that.

1
2
3
var line = new Phaser.Line(10, 10, 90, 10);
console.log(line.length);

Find the angle that the line is heading

Another great thing about an instance of Line is that I can use it to find the angle a line is heading from it’s start point to end point by just checking the angle property

1
2
var line = new Phaser.Line(50, 50, 100, 100);
console.log(line.angle * Phaser.Math.RAD_TO_DEG); // 45

Find if two lines intersect, and if so where

There are some methods attached to the constructor function that are not part of an instance one of theme is the interest methods which comes in handy for collision detection, or to just find a certain point at which two lines meet.

1
2
3
4
5
6
7
8
9
var line1 = new Phaser.Line(0, 0, 100, 100),
line2 = new Phaser.Line(0, 100, 100, 0),
// get the center point between the lines
cp = Phaser.Line.intersects(line1, line2);
if(cp){
console.log(cp.x + ',' + cp.y); // 50,50
}

This method will return null if an intersection is not found.

center a line on a given point with centerOn()

1
2
3
4
5
var line = new Phaser.Line(-100, 0, 0, 0);
line.centerOn(100,120);
console.log(line.start.x); // 50

Conclusion

The Line constructor Is very helpful when working with lines, just about all the methods I can think of are there. It’s two bad I ran into some problems with a few of the methods, when it comes to finding if a point is on a line or not, but disappointments with phaser are rare so far as I explore Phaser.