Класс: Phaser.Point

Конструктор

new Point(x, y)

Параметры

Исходный код: geom/Point.js (Строка 18)

Свойства

[только для чтения] type : число

Постоянный тип этого объекта.

Исходный код: geom/Point.js (Строка 37)

x : число

Значение x точки.

Исходный код: geom/Point.js (Строка 26)

y : число

Значение y точки.

Исходный код: geom/Point.js (Строка 31)

Методы

<static> add(a, b, out) → {Phaser.Point}

Добавляет координаты двух точек, чтобы создать новую точку.

Parameters

Name	Type	Argument	Description
a	Phaser.Point		Первый объект Point.
b	Phaser.Point		Второй объект Point.
out	Phaser.Point	<optional>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Returns

Phaser.Point -

Новый объект Point.

Source code: geom/Point.js (Line 491)

<static> angle(a, b) → {number}

Возвращает угол между двумя объектами Point.

Parameters

Name	Type	Description
a	Phaser.Point	Первый объект Point.
b	Phaser.Point	Второй объект Point.

Returns

number -

Угол между двумя точками.

Source code: geom/Point.js (Line 585)

<static> centroid(points, out) → {Phaser.Point}

Вычисляет центр масс (или середину) из массива точек. Если задана только одна точка, возвращается эта точка.

Parameters

Name	Type	Argument	Description
points	Array.<Phaser.Point>		Массив одной или нескольких точек.
out	Phaser.Point	<optional>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Returns

Phaser.Point -

Новый объект Point.

Source code: geom/Point.js (Line 832)

<static> distance(a, b, round) → {number}

Возвращает евклидово расстояние от этого объекта Point до заданного объекта (может быть объектом Circle, Point или чем-либо с x/y свойствами).

Parameters

Name	Type	Argument	Default	Description
a	object			Объект назначения. Должен иметь видимые свойства x и y, которые представляют центр объекта.
b	object			Объект назначения. Должен иметь видимые свойства x и y, которые представляют центр объекта.
round	boolean	<optional>	false	Округлить расстояние до ближайшего целого числа.

Returns

number -

Расстояние между этим объектом Point и целевым объектом Point.

Source code: geom/Point.js (Line 684)

<static> divide(a, b, out) → {Phaser.Point}

Делит координаты двух точек, чтобы создать новую точку.

Parameters

Name	Type	Argument	Description
a	Phaser.Point		Первый объект Point.
b	Phaser.Point		Второй объект Point.
out	Phaser.Point	<optional>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Returns

Phaser.Point -

Новый объект Point.

Source code: geom/Point.js (Line 551)

<static> equals(a, b) → {boolean}

Определяет, равны ли два заданных объекта Point. Они считаются равными, если имеют одинаковые значения x и y.

Parameters

Name	Type	Description
a	Phaser.Point	Первый объект Point.
b	Phaser.Point	Второй объект Point.

Returns

boolean -

Значение true, если точки равны, в противном случае false.

Source code: geom/Point.js (Line 571)

<static> interpolate(a, b, f, out) → {Phaser.Point}

Интерполирует две заданные точки на основе значения f (между 0 и 1) и возвращает новую точку.

Parameters

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Первый объект Point.
b	Phaser.Point		Второй объект Point.
f	число		Уровень интерполяции между двумя точками. Указывает, где будет расположена новая точка на прямой между pt1 и pt2. Если f=1, возвращается pt1; если f=0, возвращается pt2.
out	Phaser.Point	<необязательно>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 634)

<статический> multiply(a, b, out) → {Phaser.Point}

Умножает координаты двух точек для создания новой точки.

Параметры

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Первый объект Point.
b	Phaser.Point		Второй объект Point.
out	Phaser.Point	<необязательно>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 531)

<статический> multiplyAdd(a, b, s, out) → {Phaser.Point}

Складывает две 2D точки и умножает результат на заданный скаляр.

Параметры

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Первый объект Point.
b	Phaser.Point		Второй объект Point.
s	число		Значение масштабирования.
out	Phaser.Point	<необязательно>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 616)

<статический> negative(a, out) → {Phaser.Point}

Создаёт точку с отрицательными координатами.

Параметры

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Первый объект Point.
out	Phaser.Point	<необязательно>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 600)

<статический> normalize(a, out) → {Phaser.Point}

Нормализует (делает единичной длины) точку.

Параметры

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Объект Point.
out	Phaser.Point	<необязательно>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 764)

<статический> normalRightHand(a, out) → {Phaser.Point}

Нормализует точку по правилу правой руки (делает единичной длины).

Параметры

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Объект Point.
out	Phaser.Point	<необязательно>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 748)

<статический> parse(obj, xProp, yProp) → {Phaser.Point}

Парсит объект на предмет свойств x и/или y и возвращает новую Phaser.Point с соответствующими значениями.
Если объект не содержит этих свойств, возвращается Point с x/y равными нулю.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
obj	object			Объект для разбора.
xProp	string	<optional>	'x'	Свойство для установки значения Point.x.
yProp	string	<optional>	'y'	Свойство для установки значения Point.y.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 873)

<static> perp(a, out) → {Phaser.Point}

Возвращает вектор, перпендикулярный исходному (на 90 градусов).

Параметры

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Объект Point.
out	Phaser.Point	<optional>	Необязательный объект Point для хранения значения. Если не указан, создаётся новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 652)

<static> project(a, b, out) → {Phaser.Point}

Проектирует два объекта Point на другой объект Point.

Параметры

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Первый объект Point.
b	Phaser.Point		Второй объект Point.
out	Phaser.Point	<optional>	Необязательный объект Point для хранения значения. Если не указан, создаётся новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 700)

<static> projectUnit(a, b, out) → {Phaser.Point}

Проектирует два объекта Point на точку единичной длины.

Параметры

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Первый объект Point.
b	Phaser.Point		Второй объект Point.
out	Phaser.Point	<optional>	Необязательный объект Point для хранения значения. Если не указан, создаётся новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 724)

<static> rotate(a, x, y, angle, asDegrees, distance) → {Phaser.Point}

Поворачивает объект Point или любой объект с доступными свойствами x/y вокруг заданных координат на указанный угол.
Если угол между точкой и координатами был 45 градусов, а аргумент угла — 45 градусов, то результирующий угол будет 90 градусов, так как аргумент угла добавляется к текущему углу.

Расстояние позволяет задать ограничение расстояния между точкой и координатами при повороте. Если оно не задано, используется расстояние между двумя точками.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
a	Phaser.Point			Объект Point для поворота.
x	number			Координата x точки привязки.
y	number			Координата y точки привязки.
angle	number			Угол в радианах (если asDegrees не true) для поворота Point.
asDegrees	boolean	<optional>	false	Угол в радианах (false) или градусах (true)?
distance	number	<optional>		Необязательное ограничение расстояния между точкой и точкой привязки.

Возвращаемое значение

Phaser.Point -

Изменённый объект Point.

Исходный код: geom/Point.js (Строка 787)

<static> rperp(a, out) → {Phaser.Point}

Возвращает вектор, перпендикулярный исходному (на -90 градусов).

Параметры

Имя	Тип	Аргумент	Описание
a	Phaser.Point		Объект Point.
out	Phaser.Point	<optional>	Необязательный объект Point для хранения значения. Если не указан, создаётся новый объект Point.

Возвращаемое значение

Phaser.Point -

Новый объект Point.

Исходный код: geom/Point.js (Строка 668)

<static> subtract(a, b, out) → {Phaser.Point}

Вычитает координаты двух точек для создания новой точки.

Parameters

Name	Type	Argument	Description
a	Phaser.Point		Первый объект Point.
b	Phaser.Point		Второй объект Point.
out	Phaser.Point	<optional>	Необязательный объект Point для хранения значения. Если не указан, будет создан новый объект Point.

Returns

Phaser.Point -

Новый объект Point.

Source code: geom/Point.js (Line 511)

add(x, y) → {Phaser.Point}

Добавляет заданные значения x и y к этой точке.

Parameters

Name	Type	Description
x	number	Значение, которое нужно добавить к Point.x.
y	number	Значение, которое нужно добавить к Point.y.

Returns

Phaser.Point -

Этот объект Point. Полезно для объединения вызовов методов.

Source code: geom/Point.js (Line 106)

angle(a, asDegrees) → {number}

Возвращает угол между этим объектом Point и другим объектом со свойствами public x и y.

Parameters

Name	Type	Argument	Default	Description
a	Phaser.Point | any			Объект, от которого нужно получить угол до этой точки.
asDegrees	boolean	<optional>	false	Указанный угол в радианах (false) или градусах (true)?

Returns

number -

Угол между двумя объектами.

Source code: geom/Point.js (Line 281)

ceil() → {Phaser.Point}

Math.ceil() для обоих свойств x и y этой точки.

Returns

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 463)

clamp(min, max) → {Phaser.Point}

Зажимает значения этого объекта Point в диапазоне между заданными min и max.

Parameters

Name	Type	Description
min	number	Минимальное значение для зажима этой точки.
max	number	Максимальное значение для зажима этой точки.

Returns

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 200)

clampX(min, max) → {Phaser.Point}

Зажимает значение x этой точки в диапазоне между заданными min и max.

Parameters

Name	Type	Description
min	number	Минимальное значение для зажима этой точки.
max	number	Максимальное значение для зажима этой точки.

Returns

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 170)

clampY(min, max) → {Phaser.Point}

Зажимает значение y этой точки в диапазоне между заданными min и max.

Parameters

Name	Type	Description
min	number	Минимальное значение для зажима этой точки.
max	number	Максимальное значение для зажима этой точки.

Returns

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 185)

clone(output) → {Phaser.Point}

Создает копию данной точки.

Parameters

Name	Type	Argument	Description
output	Phaser.Point	<optional>	Необязательный объект Point. Если указан, значения будут установлены в этот объект, в противном случае будет создан и возвращен совершенно новый объект Point.

Returns

Phaser.Point -

Новый объект Point.

Source code: geom/Point.js (Line 216)

copyFrom(source) → {Phaser.Point}

Копирует свойства x и y из любого заданного объекта в эту точку.

Parameters

Name	Type	Description
source	any	Объект для копирования.

Returns

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 43)

copyTo(dest) → {object}

Копирует свойства x и y из этого объекта Point в любой заданный объект.

Параметры

Имя	Тип	Описание
dest	любой	Объект, в который нужно скопировать.

Возвращает

объект -

Объект dest.

Исходный код: geom/Point.js (Строка 238)

cross(a) → {число}

Векторное произведение этого и другого объекта Point.

Параметры

Имя	Тип	Описание
a	Phaser.Point	Объект Point, с которым нужно вычислить векторное произведение.

Возвращает

число -

Результат.

Исходный код: geom/Point.js (Строка 402)

distance(dest, round) → {число}

Возвращает расстояние между этим объектом Point и заданным объектом (может быть Circle, Point или чем-то с свойствами x/y)

Параметры

Имя	Тип	Аргумент	Описание
dest	объект		Целевой объект. Должен иметь видимые свойства x и y, представляющие центр объекта.
round	boolean	<необязательно>	Округлить расстояние до ближайшего целого числа (по умолчанию false).

Возвращает

число -

Расстояние между этим объектом Point и объектом Point назначения.

Исходный код: geom/Point.js (Строка 254)

divide(x, y) → {Phaser.Point}

Делит Point.x и Point.y на заданные значения x и y.

Параметры

Имя	Тип	Описание
x	число	Значение для деления Point.x.
y	число	Значение для деления Point.x.

Возвращает

Phaser.Point -

Этот объект Point. Полезно для цепочки вызовов методов.

Исходный код: geom/Point.js (Строка 154)

dot(a) → {число}

Скалярное произведение этого и другого объекта Point.

Параметры

Имя	Тип	Описание
a	Phaser.Point	Объект Point, с которым нужно вычислить скалярное произведение.

Возвращает

число -

Результат.

Исходный код: geom/Point.js (Строка 389)

equals(a) → {boolean}

Определяет, равны ли значения x/y заданных объектов этому объекту Point.

Параметры

Имя	Тип	Описание
a	Phaser.Point | любой	Объект для сравнения с этим объектом Point.

Возвращает

boolean -

Значение true, если точки x и y равны, в противном случае false.

Исходный код: geom/Point.js (Строка 268)

floor() → {Phaser.Point}

Функция Math.floor() для свойств x и y этого объекта Point.

Возвращает

Phaser.Point -

Этот объект Point.

Исходный код: geom/Point.js (Строка 451)

getMagnitude() → {число}

Вычисляет длину объекта Point.

Возвращает

число -

Длина объекта Point.

Исходный код: geom/Point.js (Строка 321)

getMagnitudeSq() → {число}

Вычисляет квадрат длины объекта Point.

Возвращает

число -

Квадрат длины объекта Point.

Исходный код: geom/Point.js (Строка 333)

invert() → {Phaser.Point}

Инвертирует значения x и y этого объекта Point.

Возвращает

Phaser.Point -

Этот объект Point.

Исходный код: geom/Point.js (Строка 56)

isZero() → {boolean}

Определяет, находится ли эта точка в координатах 0,0.

Возвращает

boolean -

True, если эта точка 0,0, иначе false.

Исходный код: geom/Point.js (Строка 377)

multiply(x, y) → {Phaser.Point}

Умножает Point.x и Point.y на заданные значения x и y. Иногда известно как Scale.

Параметры

Имя	Тип	Описание
x	число	Значение для умножения Point.x.
y	число	Значение для умножения Point.x.

Возвращает

Phaser.Point -

Этот объект Point. Полезно для цепочки вызовов методов.

Source code: geom/Point.js (Line 138)

normalize() → {Phaser.Point}

Изменяет объект Point таким образом, что его длина равна 1, но направление сохраняется.

Возвращает

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 358)

normalRightHand() → {Phaser.Point}

Нормализация (приведение к единичной длине) этого объекта Point по правилу правой руки.

Возвращает

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 439)

perp() → {Phaser.Point}

Делает этот объект Point перпендикулярным (поворот на 90 градусов).

Возвращает

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 415)

rotate(x, y, angle, asDegrees, distance) → {Phaser.Point}

Поворачивает этот объект Point вокруг заданных координат x/y на указанный угол.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
x	number			Координата x точки привязки.
y	number			Координата y точки привязки.
angle	number			Угол в радианах (если asDegrees не true) на который нужно повернуть Point.
asDegrees	boolean	<optional>	false	Задан угол в радианах (false) или градусах (true)?
distance	number	<optional>		Необязательное ограничение расстояния между Point и точкой привязки.

Возвращает

Phaser.Point -

Измененный объект point.

Source code: geom/Point.js (Line 304)

rperp() → {Phaser.Point}

Делает этот объект Point перпендикулярным (-90 градусов поворот).

Возвращает

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 427)

set(x, y) → {Phaser.Point}

Устанавливает значения x и y этого объекта Point на заданные значения.
Если вы опустите значение y, то значение x будет применено к обоим, например:
Point.set(2) — то же самое, что и Point.set(2, 2)

Параметры

Имя	Тип	Аргумент	Описание
x	number		Горизонтальное значение этой точки.
y	number	<optional>	Вертикальное значение этой точки. Если не указано, используется значение x.

Возвращает

Phaser.Point -

Этот объект Point. Полезно для цепочки вызовов методов.

Source code: geom/Point.js (Line 87)

setMagnitude(magnitude) → {Phaser.Point}

Изменяет длину объекта Point без изменения направления.

Параметры

Имя	Тип	Описание
magnitude	number	Желаемая величина результирующего объекта Point.

Возвращает

Phaser.Point -

Этот объект Point.

Source code: geom/Point.js (Line 345)

setTo(x, y) → {Phaser.Point}

Устанавливает значения x и y этого объекта Point на заданные значения.
Если вы опустите значение y, то значение x будет применено к обоим, например:
Point.setTo(2) — то же самое, что и Point.setTo(2, 2)

Параметры

Имя	Тип	Аргумент	Описание
x	number		Горизонтальное значение этой точки.
y	number	<optional>	Вертикальное значение этой точки. Если не указано, используется значение x.

Возвращает

Phaser.Point -

Этот объект Point. Полезно для цепочки вызовов методов.

Source code: geom/Point.js (Line 68)

subtract(x, y) → {Phaser.Point}

Вычитает заданные значения x и y из этого объекта Point.

Параметры

Имя	Тип	Описание
x	number	Значение, вычитаемое из Point.x.
y	number	Значение, вычитаемое из Point.y.

Возвращает

Phaser.Point -

Этот объект Point. Полезно для цепочки вызовов методов.

Source code: geom/Point.js (Line 122)

toString() → {string}

Возвращает строковое представление этого объекта.

Возвращает

string -

Строковое представление экземпляра.

Исходный код: geom/Point.js (Строка 475)