Spec-Zone.ru › Phaser

Класс: Phaser.Circle

Конструктор

new Circle(x, y, diameter)

Создаёт новый объект Circle с координатами центра, заданными параметрами x и y, и диаметром, заданным параметром diameter.
Если вы вызываете эту функцию без параметров, создаётся окружность с x, y, diameter и radius, установленные в 0.

Параметры
Имя Тип Аргумент По умолчанию Описание
x number <optional>
0

Координата x центра окружности.

y number <optional>
0

Координата y центра окружности.

diameter number <optional>
0

Диаметр окружности.

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

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

[только для чтения] area : number

Площадь этой окружности.

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

bottom : number

Сумма свойств y и radius. Изменение свойства bottom объекта Circle не влияет на свойства x и y, но изменяет диаметр. Возвращает или задаёт нижнюю границу окружности.

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

diameter : number

Наибольшее расстояние между двумя точками на окружности. То же самое, что radius * 2. Возвращает или задаёт диаметр окружности.

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

empty : boolean

Определяет, пустой ли объект Circle. Возвращает true, если диаметр окружности меньше или равен 0, иначе false.
Если установлено в true, сбросит все свойства объекта Circle в 0. Объект Circle пустой, если его диаметр меньше или равен 0. Возвращает или задаёт состояние пустоты окружности.

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

left

Координата x самой левой точки окружности. Изменение свойства left объекта Circle не влияет на свойства x и y. Однако оно влияет на диаметр, в то время как изменение значения x не влияет на свойство диаметра.

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

radius : number

Длина линии, соединяющей центр окружности с любой точкой на окружности. То же самое, что половина диаметра. Возвращает или задаёт радиус окружности.

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

right : number

Координата x самой правой точки окружности. Изменение свойства right объекта Circle не влияет на свойства x и y. Однако оно влияет на диаметр, в то время как изменение значения x не влияет на свойство диаметра. Возвращает или задаёт значение самой правой точки окружности.

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

top : number

Сумма свойств y минус radius. Изменение свойства top объекта Circle не влияет на свойства x и y, но изменяет диаметр. Возвращает или задаёт верхнюю границу окружности.

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

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

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

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

x : number

Координата x центра окружности.

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

y : number

Координата y центра окружности.

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

Общедоступные методы

<static> circumferencePoint(a, angle, asDegrees, out) → {Phaser.Point}

Возвращает объект Point, содержащий координаты точки на окружности круга, основанные на заданном угле.

Parameters
Name Type Argument Default Description
a Phaser.Circle

Первый объект Circle.

angle number

Угол в радианах (если asDegrees не true) для получения точки.

asDegrees boolean <optional>
false

Заданный угол в радианах (false) или градусах (true)?

out Phaser.Point <optional>

Необязательный объект Point для помещения результата. Если не указан, будет создан новый объект Point.

Returns
Phaser.Point -

Объект Point, содержащий результат.

Source code: geom/Circle.js (Line 510)

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

Возвращает true, если заданные координаты x/y находятся внутри объекта Circle.

Parameters
Name Type Description
a Phaser.Circle

Проверяемый круг.

x number

Значение X координаты для проверки.

y number

Значение Y координаты для проверки.

Returns
boolean -

True, если координаты находятся внутри круга, иначе false.

Source code: geom/Circle.js (Line 458)

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

Определяет, совпадают ли два объекта Circle. Этот метод сравнивает свойства x, y и диаметр.

Parameters
Name Type Description
a Phaser.Circle

Первый объект Circle.

b Phaser.Circle

Второй объект Circle.

Returns
boolean -

Значение true, если у объекта точно такие же значения для свойств x, y и диаметр, как у этого объекта Circle, иначе false.

Source code: geom/Circle.js (Line 483)

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

Определяет, пересекаются ли два объекта Circle.
Этот метод проверяет расстояния радиусов между двумя объектами Circle, чтобы определить, пересекаются ли они.

Parameters
Name Type Description
a Phaser.Circle

Первый объект Circle.

b Phaser.Circle

Второй объект Circle.

Returns
boolean -

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

Source code: geom/Circle.js (Line 496)

<static> intersectsRectangle(c, r) → {boolean}

Проверяет, пересекаются ли заданные объекты Circle и Rectangle.

Parameters
Name Type Description
c Phaser.Circle

Объект Circle для проверки.

r Phaser.Rectangle

Объект Rectangle для проверки.

Returns
boolean -

True, если два объекта пересекаются, иначе false.

Source code: geom/Circle.js (Line 536)

circumference() → {number}

Длина окружности круга.

Returns
number -

Длина окружности круга.

Source code: geom/Circle.js (Line 60)

circumferencePoint(angle, asDegrees, out) → {Phaser.Point}

Возвращает объект Point, содержащий координаты точки на окружности круга, основанные на заданном угле.

Parameters
Name Type Argument Default Description
angle number

Угол в радианах (если asDegrees не true) для получения точки.

asDegrees boolean <optional>
false

Заданный угол в радианах (false) или градусах (true)?

out Phaser.Point <optional>

Необязательный объект Point для помещения результата. Если не указан, будет создан новый объект Point.

Returns
Phaser.Point -

Объект Point, содержащий результат.

Source code: geom/Circle.js (Line 205)

clone(output) → {Phaser.Circle}

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

Parameters
Имя Тип Описание
output Phaser.Circle

Необязательный объект Circle. Если указан, значения будут установлены в объект; в противном случае будет создан и возвращён новый объект Circle.

Возвращаемое значение
Phaser.Circle -

Клонированный объект Circle.

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

contains(x, y) → {boolean}

Возвращает true, если заданные координаты x/y находятся внутри этого объекта Circle.

Параметры
Имя Тип Описание
x number

Значение X координаты для проверки.

y number

Значение Y координаты для проверки.

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

True, если координаты находятся внутри круга, иначе false.

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

copyFrom(source) → {Circle}

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

Параметры
Имя Тип Описание
source any

Объект для копирования.

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

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

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

copyTo(dest) → {object}

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

Параметры
Имя Тип Описание
dest any

Объект для копирования.

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

Объект dest.

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

distance(dest, round) → {number}

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
dest object

Целевой объект. Должен иметь видимые свойства x и y, представляющие центр объекта.

round boolean <необязательный>
false

Округлить расстояние до ближайшего целого числа.

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

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

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

getBounds() → {Phaser.Rectangle}

Возвращает ограничивающую прямоугольную область круга как объект Phaser.Rectangle.

Возвращаемое значение
Phaser.Rectangle -

Пределы Circle.

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

offset(dx, dy) → {Circle}

Изменяет положение объекта Circle, определяемое координатами центра, на указанные значения.

Параметры
Имя Тип Описание
dx number

Смещает значение x объекта Circle на это значение.

dy number

Смещает значение y объекта Circle на это значение.

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

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

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

offsetPoint(point) → {Circle}

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

Параметры
Имя Тип Описание
point Point

Объект Point для смещения объекта Circle (или любой допустимый объект с открытыми свойствами x и y).

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

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

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

random(out) → {Phaser.Point}

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

Параметры
Имя Тип Аргумент Описание
out Phaser.Point | object <необязательный>

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

Возвращаемое значение
Phaser.Point -

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

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

setTo(x, y, diameter) → {Circle}

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

Параметры
Имя Тип Описание
x число

Координата x центра окружности.

y число

Координата y центра окружности.

diameter число

Диаметр окружности.

Возвращаемое значение
Круг -

Объект этой окружности.

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

toString() → {строка}

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

Возвращаемое значение
строка -

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

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

© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Circle.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API