Класс: Phaser.Rectangle

Конструктор

new Rectangle(x, y, width, height)

Параметры

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

Общедоступные свойства

bottom : number

Сумма свойств y и height. Изменение свойства bottom объекта Rectangle не влияет на свойства x, y и width, но изменяет свойство height.

Source code: geom/Rectangle.js (Line 478)

bottomLeft : Phaser.Point

Расположение нижнего левого угла прямоугольника как объект Point. Получает или устанавливает расположение нижнего левого угла прямоугольника как объект Point.

Source code: geom/Rectangle.js (Line 504)

bottomRight : Phaser.Point

Расположение нижнего правого угла прямоугольника как объект Point. Получает или устанавливает расположение нижнего правого угла прямоугольника как объект Point.

Source code: geom/Rectangle.js (Line 522)

centerX : number

Координата x центра прямоугольника.

Source code: geom/Rectangle.js (Line 611)

centerY : number

Координата y центра прямоугольника.

Source code: geom/Rectangle.js (Line 628)

empty : boolean

Определяет, пуст ли этот объект Rectangle. Объект Rectangle пуст, если его ширина или высота меньше или равны 0.
Если установлено в true, все свойства прямоугольника устанавливаются в 0. Получает или устанавливает состояние пустоты прямоугольника.

Source code: geom/Rectangle.js (Line 736)

[readonly] halfHeight : number

Половина высоты прямоугольника.

Source code: geom/Rectangle.js (Line 465)

[readonly] halfWidth : number

Половина ширины прямоугольника.

Source code: geom/Rectangle.js (Line 452)

height : number

Высота прямоугольника. Это значение никогда не должно быть отрицательным.

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

left : number

Координата x левой стороны прямоугольника. Изменение свойства left объекта Rectangle не влияет на свойства y и height. Однако оно влияет на свойство width, в то время как изменение значения x не влияет на свойство width.

Source code: geom/Rectangle.js (Line 540)

[readonly] perimeter : number

Размер периметра прямоугольника. Это сумма всех 4 сторон.

Source code: geom/Rectangle.js (Line 597)

randomX : number

Случайное значение между значениями left и right (включительно) прямоугольника.

Source code: geom/Rectangle.js (Line 645)

randomY : number

Случайное значение между значениями top и bottom (включительно) прямоугольника.

Source code: geom/Rectangle.js (Line 661)

right : number

Сумма свойств x и width. Изменение свойства right объекта Rectangle не влияет на свойства x, y и height, но влияет на свойство width.

Source code: geom/Rectangle.js (Line 562)

top : number

Координата y верхней стороны прямоугольника. Изменение свойства top объекта Rectangle не влияет на свойства x и width.
Однако оно влияет на свойство height, в то время как изменение значения y не влияет на свойство height.

Source code: geom/Rectangle.js (Line 677)

topLeft : Phaser.Point

Расположение верхнего левого угла прямоугольника как объект Point.

Source code: geom/Rectangle.js (Line 700)

topRight : Phaser.Point

Расположение верхнего правого угла прямоугольника как объект Point. Расположение верхнего левого угла прямоугольника как объект Point.

Source code: geom/Rectangle.js (Line 718)

[readonly] type : number

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

Source code: geom/Rectangle.js (Line 49)

[readonly] volume : number

Объем прямоугольника, вычисленный как width * height.

Source code: geom/Rectangle.js (Line 583)

width : number

Ширина прямоугольника. Это значение никогда не должно быть отрицательным.

Source code: geom/Rectangle.js (Line 38)

x : number

Координата x верхнего левого угла прямоугольника.

Source code: geom/Rectangle.js (Line 28)

y : number

Координата y верхнего левого угла прямоугольника.

Source code: geom/Rectangle.js (Line 33)

Методы

<static> clone(a, output) → {Phaser.Rectangle}

Возвращает новый объект Rectangle с теми же значениями для свойств x, y, width и height, что и у исходного объекта Rectangle.

Parameters

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

Returns

Phaser.Rectangle -

Source code: geom/Rectangle.js (Line 815)

<static> contains(a, x, y) → {boolean}

Определяет, содержатся ли указанные координаты в области, определенной этим объектом Rectangle.

Parameters

Name	Type	Description
a	Phaser.Rectangle	Объект Rectangle.
x	number	Координата x точки для проверки.
y	number	Координата y точки для проверки.

Returns

boolean -

Значение true, если объект Rectangle содержит указанную точку; в противном случае false.

Source code: geom/Rectangle.js (Line 837)

<static> containsPoint(a, point) → {boolean}

Определяет, содержится ли указанная точка в прямоугольной области, определенной этим объектом Rectangle. Этот метод похож на метод Rectangle.contains(), за исключением того, что он принимает в качестве параметра объект Point.

Parameters

Name	Type	Description
a	Phaser.Rectangle	Объект Rectangle.
point	Phaser.Point	Проверяемый точечный объект. Может быть Point или любой объект со значениями .x и .y.

Returns

boolean -

Значение true, если объект Rectangle содержит указанную точку; в противном случае false.

Source code: geom/Rectangle.js (Line 873)

<static> containsRaw(rx, ry, rw, rh, x, y) → {boolean}

Определяет, содержатся ли указанные координаты в области, определенной заданными необработанными значениями.

Parameters

Name	Type	Description
rx	number	Координата x левого верхнего угла области.
ry	number	Координата y левого верхнего угла области.
rw	number	Ширина области.
rh	number	Высота области.
x	number	Координата x точки для проверки.
y	number	Координата y точки для проверки.

Returns

boolean -

Значение true, если объект Rectangle содержит указанную точку; в противном случае false.

Source code: geom/Rectangle.js (Line 856)

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

Определяет, полностью ли первый объект Rectangle содержится во втором объекте Rectangle.
Объект Rectangle считается содержащим другой, если второй объект Rectangle полностью попадает в границы первого.

Parameters

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

Returns

boolean -

Значение true, если объект Rectangle содержит указанную точку; в противном случае false.

Source code: geom/Rectangle.js (Line 886)

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

Определяет, равны ли два прямоугольника.
Этот метод сравнивает свойства x, y, width и height каждого Rectangle.

Parameters

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

Returns

boolean -

Значение true, если два прямоугольника имеют точно такие же значения для свойств x, y, width и height; в противном случае false.

Source code: geom/Rectangle.js (Line 906)

<static> inflate(a, dx, dy) → {Phaser.Rectangle}

Увеличивает размер объекта Rectangle на указанные значения. Центральная точка объекта Rectangle остается той же, а его размер увеличивается влево и вправо на значение dx и вверх и вниз на значение dy.

Parameters

Name	Type	Description
a	Phaser.Rectangle	Объект Rectangle.
dx	number	Значение, которое нужно добавить к левой стороне Rectangle.
dy	number	Значение, которое нужно добавить к нижней стороне Rectangle.

Returns

Phaser.Rectangle -

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

Source code: geom/Rectangle.js (Строка 761)

<static> inflatePoint(a, point) → {Phaser.Rectangle}

Увеличивает размер объекта Rectangle. Этот метод аналогичен методу Rectangle.inflate(), за исключением того, что он принимает объект Point в качестве параметра.

Parameters

Name	Type	Описание
a	Phaser.Rectangle	Объект Rectangle.
point	Phaser.Point	Свойство x этого объекта Point используется для увеличения горизонтальной размерности объекта Rectangle. Свойство y используется для увеличения вертикальной размерности объекта Rectangle.

Returns

Phaser.Rectangle -

Объект Rectangle.

Source code: geom/Rectangle.js (Строка 780)

<static> intersection(a, b, output) → {Phaser.Rectangle}

Если объект Rectangle, указанный в параметре toIntersect, пересекается с этим объектом Rectangle, возвращает площадь пересечения в виде объекта Rectangle. Если прямоугольники не пересекаются, этот метод возвращает пустой объект Rectangle со свойствами, установленными в 0.

Parameters

Name	Type	Аргумент	Описание
a	Phaser.Rectangle		Первый объект Rectangle.
b	Phaser.Rectangle		Второй объект Rectangle.
output	Phaser.Rectangle	<optional>	Необязательный объект Rectangle. Если он задан, значения пересечения будут установлены в этот объект; в противном случае будет создан и возвращён новый объект Rectangle.

Returns

Phaser.Rectangle -

Объект Rectangle, равный площади пересечения. Если прямоугольники не пересекаются, этот метод возвращает пустой объект Rectangle; то есть, Rectangle со свойствами x, y, width и height, установленными в 0.

Source code: geom/Rectangle.js (Строка 933)

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

Определяет, пересекаются ли два прямоугольника.
Этот метод проверяет свойства x, y, width и height прямоугольников.

Parameters

Name	Type	Описание
a	Phaser.Rectangle	Первый объект Rectangle.
b	Phaser.Rectangle	Второй объект Rectangle.

Returns

boolean -

Значение true, если указанный объект пересекается с этим объектом Rectangle; в противном случае false.

Source code: geom/Rectangle.js (Строка 960)

<static> intersectsRaw(left, right, top, bottom, tolerance) → {boolean}

Определяет, пересекается ли указанный объект с заданными значениями.

Parameters

Name	Type	Описание
left	number	Координата x левой стороны области.
right	number	Координата правой стороны области.
top	number	Координата y области.
bottom	number	Координата нижней стороны области.
tolerance	number	Значение допуска для проверки пересечения с отступом, по умолчанию 0

Returns

boolean -

Значение true, если указанный объект пересекается с Rectangle; в противном случае false.

Source code: geom/Rectangle.js (Строка 979)

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

Определяет, имеют ли два объекта (либо Rectangle, либо похожие на Rectangle) одинаковые значения ширины и высоты при строгом равенстве.

Parameters

Name	Type	Описание
a	Rectangle-like	Первый объект Rectangle.
b	Rectangle-like	Второй объект Rectangle.

Returns

boolean -

True, если у объекта есть эквивалентные значения для свойств width и height.

Source code: geom/Rectangle.js (Строка 920)

<static> size(a, output) → {Phaser.Point}

Размер объекта Rectangle, выраженный как объект Point со значениями свойств width и height.

Parameters

Name	Type	Аргумент	Описание
a	Phaser.Rectangle		Объект Rectangle.
output	Phaser.Point	<optional>	Необязательный объект Point. Если он задан, значения будут установлены в объект; в противном случае будет создан и возвращён новый объект Point.

Returns

Phaser.Point -

Размер объекта Rectangle

Source code: geom/Rectangle.js (Строка 793)

<static> union(a, b, output) → {Phaser.Rectangle}

Объединяет два прямоугольника, создавая новый объект Rectangle, заполняя горизонтальное и вертикальное пространство между двумя прямоугольниками.

Parameters

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

Возвращает

Phaser.Rectangle -

Объект Rectangle, являющийся объединением двух объектов Rectangle.

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

aabb(points, out) → {Phaser.Rectangle}

Вычисляет прямоугольник минимальной обводки (aabb) по массиву точек.

Параметры

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

Возвращает

Phaser.Rectangle -

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

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

ceil()

Применяет Math.ceil() к значениям x и y этого прямоугольника.

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

ceilAll()

Применяет Math.ceil() к значениям x, y, width и height этого прямоугольника.

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

centerOn(x, y) → {Phaser.Rectangle}

Центрирует этот прямоугольник, так что координаты центра совпадают с заданными значениями x и y.

Параметры

Имя	Тип	Описание
x	number	Координата x, по которой нужно расположить центр прямоугольника.
y	number	Координата y, по которой нужно расположить центр прямоугольника.

Возвращает

Phaser.Rectangle -

Этот объект Rectangle

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

clone(output) → {Phaser.Rectangle}

Возвращает новый объект Rectangle с теми же значениями для свойств x, y, width и height, что и у исходного объекта Rectangle.

Параметры

Имя	Тип	Аргумент	Описание
output	Phaser.Rectangle	<optional>	Необязательный объект Rectangle. Если задан, значения будут установлены в этот объект; в противном случае будет создан и возвращен новый объект Rectangle.

Возвращает

Phaser.Rectangle -

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

contains(x, y) → {boolean}

Определяет, содержатся ли заданные координаты в области, определяемой этим объектом Rectangle.

Параметры

Имя	Тип	Описание
x	number	Координата x точки для проверки.
y	number	Координата y точки для проверки.

Возвращает

boolean -

Значение true, если объект Rectangle содержит указанную точку; в противном случае false.

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

containsRect(b) → {boolean}

Определяет, полностью ли первый объект Rectangle содержится во втором объекте Rectangle.
Объект Rectangle считается содержащим другой, если второй объект Rectangle полностью попадает в границы первого.

Параметры

Имя	Тип	Описание
b	Phaser.Rectangle	Второй объект Rectangle.

Возвращает

boolean -

Значение true, если объект Rectangle содержит указанную точку; в противном случае false.

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

copyFrom(source) → {Phaser.Rectangle}

Копирует свойства x, y, width и height из любого заданного объекта в этот прямоугольник.

Параметры

Имя	Тип	Описание
source	any	Объект для копирования.

Возвращает

Phaser.Rectangle -

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

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

copyTo(source) → {object}

Копирует свойства x, y, width и height из этого прямоугольника в любой заданный объект.

Параметры

Имя	Тип	Описание
source	any	Объект для копирования.

Возвращает

object -

Этот объект.

Source code: geom/Rectangle.js (Line 199)

equals(b) → {boolean}

Определяет, равны ли два прямоугольника.
Этот метод сравнивает свойства x, y, width и height каждого прямоугольника.

Parameters

Имя	Тип	Описание
b	Phaser.Rectangle	Второй объект прямоугольника.

Returns

boolean -

Значение true, если два прямоугольника имеют точно такие же значения для свойств x, y, width и height; в противном случае false.

Source code: geom/Rectangle.js (Line 297)

floor()

Применяет Math.floor() к значениям x и y этого прямоугольника.

Source code: geom/Rectangle.js (Line 139)

floorAll()

Применяет Math.floor() к значениям x, y, width и height этого прямоугольника.

Source code: geom/Rectangle.js (Line 150)

getPoint(position, out) → {Phaser.Point}

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

Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER,
Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER
и Phaser.BOTTOM_RIGHT.

Этот метод возвращает такие же значения, как вызов Rectangle.bottomLeft и т. д., но эти вызовы всегда создают новый объект Point, в то время как этот позволяет использовать ваш собственный.

Parameters

Имя	Тип	Аргумент	Описание
position	integer	<optional>	Одна из констант позиции Phaser, например, Phaser.TOP_RIGHT.
out	Phaser.Point	<optional>	Объект Phaser.Point, в котором будут заданы значения. Если объект не предоставлен, будет создан новый объект Phaser.Point. В высокопроизводительных областях следует избегать этого, повторно используя существующий объект.

Returns

Phaser.Point -

Объект, содержащий точку в свойствах x и y.

Source code: geom/Rectangle.js (Line 386)

inflate(dx, dy) → {Phaser.Rectangle}

Увеличивает размеры объекта Rectangle на указанные значения. Центральная точка объекта Rectangle остается неизменной, а его размер увеличивается влево и вправо на значение dx, и вверх и вниз на значение dy.

Parameters

Имя	Тип	Описание
dx	number	Значение, добавляемое к левой стороне прямоугольника.
dy	number	Значение, добавляемое к нижней стороне прямоугольника.

Returns

Phaser.Rectangle -

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

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

intersection(b, out) → {Phaser.Rectangle}

Если объект Rectangle, указанный в параметре toIntersect, пересекается с этим объектом Rectangle, возвращает область пересечения как объект Rectangle. Если прямоугольники не пересекаются, этот метод возвращает пустой объект Rectangle со значениями свойств, равными 0.

Parameters

Имя	Тип	Описание
b	Phaser.Rectangle	Второй объект прямоугольника.
out	Phaser.Rectangle	Необязательный объект Rectangle. Если он передан, значения пересечения будут установлены в этот объект, иначе будет создан и возвращен новый объект Rectangle.

Returns

Phaser.Rectangle -

Объект Rectangle, равный области пересечения. Если прямоугольники не пересекаются, этот метод возвращает пустой объект Rectangle; т. е. объект Rectangle со свойствами x, y, width и height, равными 0.

Source code: geom/Rectangle.js (Line 310)

intersects(b) → {boolean}

Определяет, пересекаются ли этот прямоугольник и другой заданный прямоугольник.
Этот метод проверяет свойства x, y, width и height двух прямоугольников.

Parameters

Имя	Тип	Описание
b	Phaser.Rectangle	Второй объект прямоугольника.

Returns

boolean -

Значение true, если указанный объект пересекается с этим объектом Rectangle; в противном случае false.

Source code: geom/Rectangle.js (Line 323)

intersectsRaw(left, right, top, bottom, tolerance) → {boolean}

Определяет, пересекаются ли заданные координаты с этим прямоугольником.

Parameters

Имя	Тип	Описание
left	number	Координата x левой стороны области.
right	number	Координата правой стороны области.
top	number	Координата y верхней стороны области.
bottom	number	Координата нижней стороны области.
tolerance	number	Значение допуска для проверки пересечения с отступом, по умолчанию 0.

Returns

boolean -

Значение true, если указанный объект пересекается с прямоугольником; в противном случае false.

Source code: geom/Rectangle.js (Line 337)

offset(dx, dy) → {Phaser.Rectangle}

Изменяет положение объекта Rectangle, определяемое его верхним левым углом, на указанные значения.

Параметры

Имя	Тип	Описание
dx	число	Смещает значение x объекта Rectangle на это значение.
dy	число	Смещает значение y объекта Rectangle на это значение.

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

Phaser.Rectangle -

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

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

offsetPoint(point) → {Phaser.Rectangle}

Изменяет положение объекта Rectangle, используя объект Point в качестве параметра. Этот метод аналогичен методу Rectangle.offset(), но принимает в качестве параметра объект Point.

Параметры

Имя	Тип	Описание
point	Phaser.Point	Объект Point, используемый для смещения объекта Rectangle.

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

Phaser.Rectangle -

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

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

random(out) → {Phaser.Point}

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

Параметры

Имя	Тип	Аргумент	Описание
out	Phaser.Point | объект	<необязательно>	Объект Phaser.Point или любой объект с общедоступными свойствами x/y, в которые будут установлены значения. Если объект не предоставлен, будет создан новый объект Phaser.Point. В высокопроизводительных областях избегайте этого, повторно используя существующий объект.

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

Phaser.Point -

Объект, содержащий случайную точку в своих свойствах x и y.

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

resize(width, height) → {Phaser.Rectangle}

Изменяет размеры прямоугольника, указав новую ширину и высоту.
Позиции x и y остаются неизменными.

Параметры

Имя	Тип	Описание
width	число	Ширина прямоугольника. Должна быть либо нулевой, либо положительной.
height	число	Высота прямоугольника. Должна быть либо нулевой, либо положительной.

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

Phaser.Rectangle -

Этот объект Rectangle

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

scale(x, y) → {Phaser.Rectangle}

Масштабирует ширину и высоту этого прямоугольника на заданные значения.

Параметры

Имя	Тип	Аргумент	Описание
x	число		Величина масштабирования ширины прямоугольника. Значение 0,5 уменьшит его вдвое, значение 2 удвоит ширину и т.д.
y	число	<необязательно>	Величина масштабирования высоты прямоугольника. Значение 0,5 уменьшит его вдвое, значение 2 удвоит высоту и т.д.

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

Phaser.Rectangle -

Этот объект Rectangle

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

setTo(x, y, width, height) → {Phaser.Rectangle}

Устанавливает члены Rectangle в указанные значения.

Параметры

Имя	Тип	Описание
x	число	Координата x верхнего левого угла прямоугольника.
y	число	Координата y верхнего левого угла прямоугольника.
width	число	Ширина прямоугольника. Должна быть либо нулевой, либо положительной.
height	число	Высота прямоугольника. Должна быть либо нулевой, либо положительной.

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

Phaser.Rectangle -

Этот объект Rectangle

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

size(output) → {Phaser.Point}

Размер объекта Rectangle, представленный как объект Point со значениями свойств width и height.

Параметры

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

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

Phaser.Point -

Размер объекта Rectangle.

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

toString() → {string}

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

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

строка -

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

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

union(b, out) → {Phaser.Rectangle}

Объединяет два прямоугольника, создавая новый объект Rectangle, заполняя горизонтальное и вертикальное пространство между двумя прямоугольниками.

Параметры

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

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

Phaser.Rectangle -

Объект Rectangle, являющийся объединением двух Rectangles.

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