IPixelPolygonGeometry
Расширяет IPixelGeometry.
Интерфейс пиксельной геометрии "Многоугольник".
Конструктор | Поля | Методы
Конструктор
IPixelPolygonGeometry(coordinates, fillRule[, metaData])
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
coordinates * | — | Тип: Number[][][] Координаты многоугольника. |
fillRule * | — | Тип: String Строковый идентификатор, определяющий алгоритм заливки многоугольника.
Может принимать одно из двух значений:
|
metaData | — | Тип: Object метаданные |
Параметр | Значение по умолчанию | Описание |
---|---|---|
coordinates * | — | Тип: Number[][][] Координаты многоугольника. |
fillRule * | — | Тип: String Строковый идентификатор, определяющий алгоритм заливки многоугольника.
Может принимать одно из двух значений:
|
metaData | — | Тип: Object метаданные |
* Обязательный параметр/опция.
Поля
Имя | Тип | Описание |
---|---|---|
events | IEventManager | Менеджер событий. Унаследовано от IEventEmitter. |
Имя | Тип | Описание |
---|---|---|
events | IEventManager | Менеджер событий. Унаследовано от IEventEmitter. |
Методы
Имя | Возвращает | Описание |
---|---|---|
contains(position) | Boolean | Проверяет лежит ли переданная точка внутри многоугольника. |
getBounds() | Number[][]|null | Returns координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - угол с наименьшими значениями координат относительно остальных точек области; второй элемент - угол с наибольшими значениями координат. Унаследован от IBaseGeometry. |
getClosest(anchorPosition) | Object | Ищет на контуре многоугольника точку, ближайшую к anchorPosition. |
getCoordinates() | Number[][][] | Returns координаты многоугольника. |
getFillRule() | String | Returns идентификатор алгоритма заливки многоугольника. |
getLength() | Integer | Returns количество контуров в многоугольнике. |
getMetaData() | Object | Returns метаданные пиксельной геометрии. Унаследован от IPixelGeometry. |
getType() | String | Returns идентификатор типа геометрии. Унаследован от IBaseGeometry. |
scale(factor) | Создает отмасштабированную копию геометрии. Унаследован от IPixelGeometry. | |
shift(offset) | Создает копию геометрии сдвинутую на заданную величину. Унаследован от IPixelGeometry. |
Имя | Возвращает | Описание |
---|---|---|
contains(position) | Boolean | Проверяет лежит ли переданная точка внутри многоугольника. |
getBounds() | Number[][]|null | Returns координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - угол с наименьшими значениями координат относительно остальных точек области; второй элемент - угол с наибольшими значениями координат. Унаследован от IBaseGeometry. |
getClosest(anchorPosition) | Object | Ищет на контуре многоугольника точку, ближайшую к anchorPosition. |
getCoordinates() | Number[][][] | Returns координаты многоугольника. |
getFillRule() | String | Returns идентификатор алгоритма заливки многоугольника. |
getLength() | Integer | Returns количество контуров в многоугольнике. |
getMetaData() | Object | Returns метаданные пиксельной геометрии. Унаследован от IPixelGeometry. |
getType() | String | Returns идентификатор типа геометрии. Унаследован от IBaseGeometry. |
scale(factor) | Создает отмасштабированную копию геометрии. Унаследован от IPixelGeometry. | |
shift(offset) | Создает копию геометрии сдвинутую на заданную величину. Унаследован от IPixelGeometry. |
Описание методов
contains
{Boolean} contains(position)
Проверяет лежит ли переданная точка внутри многоугольника.
Returns признак принадлежности точки многоугольнику.
Параметры:
* Обязательный параметр/опция.
getClosest
{Object} getClosest(anchorPosition)
Ищет на контуре многоугольника точку, ближайшую к anchorPosition.
- position - точка на контуре многоугольника ближайшая к anchorPosition;
- distance - расстояние от anchorPosition до position;
- closestPointIndex - индекс вершины многоугольника, ближайшей к position;
- nextPointIndex - индекс вершины многоугольника, следующей за position;
- prevPointIndex - индекс вершины многоугольника, предшествующей position;
- pathIndex - индекс контура многоугольника, к которому относится найденная точка.
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
anchorPosition * | — | Тип: Number[] Координаты точки, для которой расчитывается ближайшая точка на контуре многоугольника. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
anchorPosition * | — | Тип: Number[] Координаты точки, для которой расчитывается ближайшая точка на контуре многоугольника. |
* Обязательный параметр/опция.
getCoordinates
{Number[][][]} getCoordinates()
Returns координаты многоугольника.
getFillRule
{String} getFillRule()
Returns идентификатор алгоритма заливки многоугольника.
getLength
{Integer} getLength()
Returns количество контуров в многоугольнике.