proglib/documentation/drawing/point.md

Многофункциональная библиотека

# Point
Представляет упорядоченную пару чисел — координат `Х` и `Y`, определяющую точку на двумерной плоскости.

## Инициализация
```js
const Drawing = require('proglib').Drawing;
const Point = Drawing.Point;
const Size = Drawing.Size;

// Инициализирует новый экземпляр класса Point с указанными координатами.
//
// Параметры:
//    X
//       Положение точки по горизонтали.
//
//    Y
//       Положение точки по вертикали.
let _point = new Point(X, Y);

// Инициализирует новый экземпляр класса Point, используя в качестве координат указанное целое значение.
//
// Параметры:
//    dw
//       32-разрядное целое число, задающее координаты для нового объекта Point.
let _point = new Point(dw);

// Инициализирует новый экземпляр класса Point из Size.
//
// Параметры:
//    size
//       Size, задающий координаты нового объекта Point.
let _point = new Point(size);
```

## Свойства
```js
// Получает значение, определяющее, пуст ли объект Point.
// 
// Возврат
//    Boolean
_point.IsEmpty;
```

## Методы
```js
// Округляет значения текущего объекта Point до ближайших целых чисел.
_point.Round();

// Смещает точку Point на указанную точку Point.
//    pt
//       Точка Point, полученная смещением на значения точки Point.
_point.Offset(pt);

// Проверяет, является ли указанный объект с таким же координатами, что и объект Point.
//    pt
//       Объект Point для проверки.
_point.Equals(pt);

// Преобразует объект Point в строку, доступную для чтения.
// 
// Возврат:
//    String
_point.toString();

// Возвращает тип для текущего экземпляра.
// 
// Возврат:
//    String
_point.GetType();
```

```js
// Получает объект Point, имеющую значения X и Y, равные 0.
// 
// Возврат:
//    Point
Point.Empty();

// Добавляет заданный размер Size к точке Point.
// 
// Параметры:
//    pt
//       Добавляемый объект Point.
//    sz
//       Объект Size для добавления.
// 
// Возврат:
//    Point
Point.Add(pt, sz);

// Округляет значения объекта Point до ближайших целых чисел.
// 
// Параметры:
//    pt
//       Округляемый объект Point.
// 
// Возврат:
//    Point
Point.Round(pt);

// Возвращает результат вычитания заданного размера Size из заданной точки Point.
// 
// Параметры:
//    pt
//       Точка Point, из которой осуществляется вычитание.
//    sz
//       Размер Size, вычитаемый из точки Point.
// 
// Возврат:
//    Point
Point.Subtract(pt, sz);
```