Point.md

LibCanvas.Point

LibCanvas.Point - один из базисов в библиотеке LibCanvas. На нем строятся многие вычисления, простые фигуры, отрисовка результата.

Global

После вызова LibCanvas.extract() можно использовать короткий алиас "Point"

Создание экземпляра LibCanvas.Point

Создать экземпляр класса LibCanvas.Point можно одним из следующих способов:

var xCoord = 15, yCoord = 20;

// передав в конструктор координаты
var point = new LibCanvas.Point( xCoord, yCoord );

// массив координат
var point = new LibCanvas.Point([xCoord, yCoord]);

// объект координат
var point = new LibCanvas.Point({ x : xCoord, y : yCoord });

// Другой объект LibCanvas.Point
var point = new LibCanvas.Point(anotherPoint);

// что равнозначно с
var point = anotherPoint.clone();

// после использования LibCanvas.extract():
var point = new Point( xCoord, yCoord );

Метод equals

boolean equals(LibCanvas.Point to, int accuracy)

Метод сравнивает две точки не по ссылкам

аргумент accuracy

Если указан, то означает количество знаков, с точностью которых будут сравниватся точки (для неточного сравнения)

Пример

var bar = new LibCanvas.Point(15, 15);
var foo = new LibCanvas.Point(15, 15);

trace(bar == foo);      // false
trace(bar.equals(foo)); // true

Пример с accuracy

var bar = new LibCanvas.Point(12.88888324, 15.1111127);
var foo = new LibCanvas.Point(12.88888115, 15.1111093);

console.log(bar == foo);         // false
console.log(bar.equals(foo));    // false
console.log(bar.equals(foo, 8)); // false
console.log(bar.equals(foo, 4)); // true

Метод clone

LibCanvas.Point clone()

Возвращает точку с такими же координатами

Пример

var point = new LibCanvas.Point(15, 15);
var clone = point.clone();
console.log(point == clone); // false
console.log(point.equals(clone)); // true

Метод move

LibCanvas.Point move(LibCanvas.Point distance, boolean reverse = false)

Пример

var point    = new LibCanvas.Point(10, 10);
var distance = new LibCanvas.Point(5, -3);

point.move(distance, false); // Point(15, 7)
point.move(distance, true ); // Point(5, 13)

Возвращает this

Метод moveTo

LibCanvas.Point moveTo(LibCanvas.Point point)

Пример

var start  = new LibCanvas.Point(100, 100);
var finish = new LibCanvas.Point(800, 800);
// просто перемещаем точку в конец
start.moveTo(finish);

Возвращает this

Метод angleTo

int angleTo(LibCanvas.Point point)

Пример

var pO = new LibCanvas.Point(10, 10);
var pA = new LibCanvas.Point(15, 15);

var angle = pA.angleTo(pO); // 0.785 (в радианах)
angle.getDegree() == 45; // в градусах

Метод distanceTo

int distanceTo(LibCanvas.Point point)

Пример

var pO = new LibCanvas.Point(10, 10);
var pA = new LibCanvas.Point(15, 15);

pA.distanceTo(pO); // 7.071

Метод diff

LibCanvas.Point diff(LibCanvas.Point point)

Этот метод означает примерно следующее : на сколько надо сдвинуться точке, чтобы она оказалась на месте той, которая передана первым аргументом

Пример

var pO = new LibCanvas.Point(10, 10);
var pA = new LibCanvas.Point(15, 18);

pA.diff(pO); // Point(-5, -8)

Метод rotate

LibCanvas.Point rotate(int angle, LibCanvas.Point pivot = {x:0, y:0})

Развенуть точку на angle градусов вокруг оси pivot

Пример

var pO = new LibCanvas.Point(10, 10);
var pA = new LibCanvas.Point(20, 10);

pA.rotate((90).degree(), pO); // Point(10, 20)

Возвращает this

Метод scale

LibCanvas.Point scale(int power, LibCanvas.Point pivot = Point(0, 0))

Увеличивает расстояние от точки pivot в power раз

Пример

var pO = new LibCanvas.Point(10, 10);
var pA = new LibCanvas.Point(20, 15);
pA.scale(2, pO); // Point(30, 20)

Возвращает this

Метод getNeighbour

LibCanvas.Point scale(string direction)

Возвращает соседнюю с текущей точку.

аргумент direction

может принимать одно из следующих значений:

t - возвращает точку сверху

r - возвращает точку справа

b - возвращает точку снизу

l - возвращает точку слева

tl - возвращает точку сверху-слева

tr - возвращает точку сверху-справа

bl - возвращает точку снизу-слева

br - возвращает точку снизу-справа

Пример

var pA = new LibCanvas.Point(15, 15);
pA.getNeighbour('t');   // Point(15, 14)
pA.getNeighbour('bl');  // Point(14, 16)

Метод toObject

Object toObject()

Возвращает хеш с координатами точки

Пример

var bar = new LibCanvas.Point(12, 15);
var foo = bar.toObject();
// аналогично foo = { x : 12, y : 15 }

Метод checkDistanceTo

boolean checkDistanceTo(Point point, number distance, boolean equals = false)

Проверяет, что расстояние до точки меньше distance или равно, если equals = true. Метод является более быстрым аналогом проверки через distanceTo:

Пример

// Расстояние равно 5
var foo = new LibCanvas.Point(12, 15);
var bar = new LibCanvas.Point(16, 18);

// Строгая проверка
foo.checkDistanceTo( bar, 5 ); // false
// аналог:
foo.distanceTo( bar ) < 5 // false

// Нестрогая проверка
foo.checkDistanceTo( bar, 5, true ); // false
// аналог:
foo.distanceTo( bar ) <= 5 // true