geometry.base.LinearRing

Расширяет IBaseLinearRingGeometry .

Базовая геометрия "Замкнутый контур".

Конструктор | Поля | События | Методы

Конструктор

geometry.base.LinearRing([coordinates[, fillRule]])

Параметры:

Параметр Значение по умолчанию Описание
coordinates []

Тип: Number[][]

Координаты геометрии.

fillRule "evenOdd"

Тип: String

Строковый идентификатор, определяющий алгоритм заливки многоугольника. Может принимать одно из двух значений:
  • evenOdd - алгоритм, определяющий, находится ли точка в области заполнения, путем рисования луча от этой точки до бесконечности в любом направлении и подсчета количества сегментов контура в пределах заданной фигуры, которые пересекает этот луч. Если это число нечетное, точка находится внутри; если четное, точка находится снаружи.
  • nonZero - алгоритм, определяющий, находится ли точка в области заполнения, путем рисования луча от этой точки до бесконечности в любом направлении и проверки точек, в которых сегмент фигуры пересекает этот луч. Начиная с нуля, добавляется единица каждый раз, когда сегмент пересекает луч слева направо, и вычитается единица каждый раз, когда сегмент пересекает луч справа налево. Если после подсчета пересечений результат равен нулю, точка находится снаружи контура. В противном случае она находится внутри.

Пример:

var linearRing = new ymaps.geometry.base.LinearRing([
    [0, 0], [0, 10], [10, 10], [10, 0], [0, 0]
]);
//...
linearRing.set(1, [5, 10]);

Поля

Имя Тип Описание
events event.Manager

Менеджер событий геометрии.

События

Имя Описание
change
Изменение координат. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • oldCoordinates — старые координаты;
  • newCoordinates - новые координаты;
  • oldFillRule - старый алгоритм заливки;
  • newFillRule - новые алгоритм заливки.

Унаследовано от ILinearRingGeometryAccess .

Методы

Имя Возвращает Описание
contains (position)

Boolean

Проверяет, лежит ли переданная точка внутри контура.

Унаследован от ILinearRingGeometryAccess .

freeze ()

IFreezable

Переводит объект в "замороженный" режим.

Унаследован от IFreezable .

get (index)

Number[]

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

Унаследован от ILinearRingGeometryAccess .

getBounds ()

Number[][]|null

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

Унаследован от IBaseGeometry .

getChildGeometry (index)

IPointGeometryAccess

Создает и возвращает объект IPointGeometryAccess для заданной вершины ломаной линии.

Унаследован от ILinearRingGeometryAccess .

getClosest (anchorPosition)

Object

Ищет на контуре точку, ближайшую к anchorPosition.

Унаследован от ILinearRingGeometryAccess .

getCoordinates ()

Number[][]

Возвращает массив координат геометрии.

Унаследован от ILinearRingGeometryAccess .

getFillRule ()

String

Возвращает идентификатор алгоритма заливки.

Унаследован от ILinearRingGeometryAccess .

getLength ()

Integer

Возвращает количество точек в геометрии.

Унаследован от ILinearRingGeometryAccess .

getType ()

String

Возвращает строку "LinearRing".

Унаследован от IBaseLinearRingGeometry .

insert (index, coordinates)

ILinearRingGeometryAccess

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

Унаследован от ILinearRingGeometryAccess .

isFrozen ()

Boolean

Возвращает true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от IFreezable .

remove (index)

Number[]

Удаляет точку с заданным индексом.

Унаследован от ILinearRingGeometryAccess .

set (index, coordinates)

ILinearRingGeometryAccess

Задает координаты точки c заданным индексом.

Унаследован от ILinearRingGeometryAccess .

setCoordinates (coordinates)

ILinearRingGeometryAccess

Задает массив координат геометрии.

Унаследован от ILinearRingGeometryAccess .

setFillRule (fillRule)

ILinearRingGeometryAccess

Задает алгоритм заливки контура.

Унаследован от ILinearRingGeometryAccess .

splice (index, number)

Number[][]

Удаляет определенное число точек начиная с заданного индекса. При этом на место удаляемых точек могут быть добавлены новые. Координаты новых точек можно передавать дополнительными аргументами после параметра number.

Унаследован от ILinearRingGeometryAccess .

unfreeze ()

IFreezable

Переводит объект в активный режим.

Унаследован от IFreezable .

Описание полей

events

{
              event.Manager
            } events

Менеджер событий геометрии.