merged AI doc, some new pages
This commit is contained in:
@@ -1,9 +1,8 @@
|
||||
/*! \file piline.h
|
||||
* \ingroup Math
|
||||
* \brief
|
||||
* \~english Two-dimensional line class
|
||||
* \~russian Класс отрезка двумерной линии
|
||||
*/
|
||||
//! \~\file piline.h
|
||||
//! \~\ingroup Math
|
||||
//! \~\brief
|
||||
//! \~english Two-dimensional line segment type
|
||||
//! \~russian Тип двумерного отрезка
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Two-dimensional line class
|
||||
@@ -28,155 +27,164 @@
|
||||
#include "pipoint.h"
|
||||
|
||||
|
||||
/*! \brief
|
||||
* \~english Two-dimensional line class
|
||||
* \~russian Класс отрезка двумерной линии
|
||||
* \~\details
|
||||
* \~russian
|
||||
* Этот класс описывает линию на плоскости в прямоугольной системе координат
|
||||
*/
|
||||
//! \~\ingroup Math
|
||||
//! \~\brief
|
||||
//! \~english Two-dimensional line segment.
|
||||
//! \~russian Двумерный отрезок.
|
||||
//! \~\details
|
||||
//! \~english Stores start and end points of a segment on a plane.
|
||||
//! \~russian Хранит начальную и конечную точки отрезка на плоскости.
|
||||
template<typename Type>
|
||||
class PIP_EXPORT PILine {
|
||||
static_assert(std::is_arithmetic<Type>::value, "Type must be arithmetic");
|
||||
|
||||
public:
|
||||
//! \~english Segment start point.
|
||||
//! \~russian Начальная точка отрезка.
|
||||
PIPoint<Type> p0;
|
||||
|
||||
//! \~english Segment end point.
|
||||
//! \~russian Конечная точка отрезка.
|
||||
PIPoint<Type> p1;
|
||||
|
||||
//! \~russian
|
||||
//! Пустой конструктор.
|
||||
//! \details
|
||||
//! При выполнении пустого конструктора координаты не изменяются.
|
||||
//! Начало и конец совпадают.
|
||||
//! \~english Constructs empty segment.
|
||||
//! \~russian Создает пустой отрезок.
|
||||
PILine() {}
|
||||
|
||||
//! \~russian
|
||||
//! Создает линию по двум принятым точкам \a PIPoint начала и конца.
|
||||
//! \~english Constructs segment from two points.
|
||||
//! \~russian Создает отрезок по двум точкам.
|
||||
PILine(const PIPoint<Type> & p0_, const PIPoint<Type> & p1_) {
|
||||
p0 = p0_;
|
||||
p1 = p1_;
|
||||
}
|
||||
|
||||
//! \~russian
|
||||
//! Создает линию по принятым координатам начала и конца.
|
||||
//! \~english Constructs segment from endpoint coordinates.
|
||||
//! \~russian Создает отрезок по координатам концов.
|
||||
PILine(Type x0, Type y0, Type x1, Type y1) {
|
||||
p0.set(x0, y0);
|
||||
p1.set(x1, y1);
|
||||
}
|
||||
|
||||
//! \~russian
|
||||
//! Задать новые координаты начала и конца по двум принятым точкам \a PIPoint.
|
||||
//! \~english Sets segment endpoints from two points.
|
||||
//! \~russian Задает концы отрезка по двум точкам.
|
||||
PILine<Type> & set(const PIPoint<Type> & p0_, const PIPoint<Type> & p1_) {
|
||||
p0 = p0_;
|
||||
p1 = p1_;
|
||||
return *this;
|
||||
}
|
||||
|
||||
//! \~russian
|
||||
//! Задать новые координаты начала и конца.
|
||||
//! \~english Sets segment endpoints from coordinates.
|
||||
//! \~russian Задает концы отрезка по координатам.
|
||||
PILine<Type> & set(Type x0, Type y0, Type x1, Type y1) {
|
||||
p0.set(x0, y0);
|
||||
p1.set(x1, y1);
|
||||
return *this;
|
||||
}
|
||||
|
||||
//! \~russian
|
||||
//! Проверить на совпадение координат начала и конца.
|
||||
//! \~english Returns `true` if segment endpoints are equal.
|
||||
//! \~russian Возвращает `true`, если концы отрезка совпадают.
|
||||
bool isEmpty() const { return (p0 == p1); }
|
||||
|
||||
//! \~russian
|
||||
//! Вычислить ширину прямоугольника, диагональю которого является данный отрезок.
|
||||
//! \~english Returns horizontal span between endpoints.
|
||||
//! \~russian Возвращает горизонтальный размах между концами.
|
||||
Type width() const { return piAbs<Type>(p1.x - p0.x); }
|
||||
|
||||
//! \~russian
|
||||
//! Вычислить высоту прямоугольника, диагональю которого является данный отрезок.
|
||||
//! \~english Returns vertical span between endpoints.
|
||||
//! \~russian Возвращает вертикальный размах между концами.
|
||||
Type height() const { return piAbs<Type>(p1.y - p0.y); }
|
||||
|
||||
//! \~russian
|
||||
//! Сдвинуть линию на \a x, \a y.
|
||||
//! \~english Shifts the segment by `x` and `y`.
|
||||
//! \~russian Сдвигает отрезок на `x` и `y`.
|
||||
PILine<Type> & translate(Type x, Type y) {
|
||||
p0.translate(x, y);
|
||||
p1.translate(x, y);
|
||||
return *this;
|
||||
}
|
||||
|
||||
//! \~russian
|
||||
//! Сдвинуть линию на значение координат точки \a PIPoint.
|
||||
//! \~english Shifts the segment by a point offset.
|
||||
//! \~russian Сдвигает отрезок на смещение, заданное точкой.
|
||||
PILine<Type> & translate(const PIPoint<Type> & p) {
|
||||
p0.translate(p);
|
||||
p1.translate(p);
|
||||
return *this;
|
||||
}
|
||||
|
||||
//! Создать копию отрезка и сдвинуть её на `x` и `y`.
|
||||
//! \~english Returns translated copy of the segment.
|
||||
//! \~russian Возвращает смещенную копию отрезка.
|
||||
PILine<Type> translated(Type x, Type y) const {
|
||||
PILine<Type> l(*this);
|
||||
l.translate(x, y);
|
||||
return l;
|
||||
}
|
||||
|
||||
//! \~russian
|
||||
//! Создать копию отрезка и сдвинуть её на значение координат точки \a PIPoint.
|
||||
//! \~english Returns copy shifted by a point offset.
|
||||
//! \~russian Возвращает копию, смещенную на точку.
|
||||
PILine<Type> translated(const PIPoint<Type> & p) const {
|
||||
PILine<Type> l(*this);
|
||||
l.translate(p);
|
||||
return l;
|
||||
}
|
||||
|
||||
//! \~russian
|
||||
//! Сдвинуть линию на \a x, \a y.
|
||||
//! \details Является копией метода \a translate().
|
||||
//! \~english Same as \a translate().
|
||||
//! \~russian Синоним \a translate().
|
||||
PILine<Type> & move(Type x, Type y) { return translate(x, y); }
|
||||
|
||||
//! \~russian
|
||||
//! Сдвинуть линию на значение координат точки \a PIPoint.
|
||||
//! \details Является копией метода \a translate().
|
||||
//! \~english Same as \a translate().
|
||||
//! \~russian Синоним \a translate().
|
||||
PILine<Type> & move(const PIPoint<Type> & p) { return translate(p); }
|
||||
|
||||
//! \~russian
|
||||
//! Создать копию отрезка и сдвинуть её на \a x, \a y.
|
||||
//! \details Является копией метода \a translated().
|
||||
//! \~english Same as \a translated().
|
||||
//! \~russian Синоним \a translated().
|
||||
PILine<Type> moved(Type x, Type y) const {
|
||||
PILine<Type> l(*this);
|
||||
l.translate(x, y);
|
||||
return l;
|
||||
}
|
||||
|
||||
//! \~russian
|
||||
//! Создать копию отрезка и сдвинуть её на значение координат точки \a PIPoint.
|
||||
//! \details Является копией метода \a translated().
|
||||
//! \~english Same as \a translated().
|
||||
//! \~russian Синоним \a translated().
|
||||
PILine<Type> moved(const PIPoint<Type> & p) const {
|
||||
PILine<Type> l(*this);
|
||||
l.translate(p);
|
||||
return l;
|
||||
}
|
||||
|
||||
//! \~russian Сдвинуть линию по двум координатам на значение \a x.
|
||||
//! \~english Shifts both coordinates by `x`.
|
||||
//! \~russian Сдвигает обе координаты на `x`.
|
||||
void operator+=(Type x) { translate(x, x); }
|
||||
|
||||
//! \~russian Сдвинуть линию по двум координатам на величину координат точки \a PIPoint.
|
||||
//! \~english Shifts the segment by a point offset.
|
||||
//! \~russian Сдвигает отрезок на смещение, заданное точкой.
|
||||
void operator+=(const PIPoint<Type> & p) { translate(p); }
|
||||
|
||||
//! \~russian Сдвинуть линию по двум координатам на значение \a x.
|
||||
//! \~english Shifts both coordinates by `-x`.
|
||||
//! \~russian Сдвигает обе координаты на `-x`.
|
||||
void operator-=(Type x) { translate(-x, -x); }
|
||||
|
||||
//! \~russian Сдвинуть линию по двум координатам на величину координат точки \a PIPoint.
|
||||
//! \~english Shifts the segment by the negated point offset.
|
||||
//! \~russian Сдвигает отрезок на отрицательное смещение точки.
|
||||
void operator-=(const PIPoint<Type> & p) { translate(-p); }
|
||||
|
||||
//! \~russian Сдвинуть линию по двум координатам на величину координат точки \a PIPoint.
|
||||
//! \~english Returns segment shifted by a point offset.
|
||||
//! \~russian Возвращает отрезок, смещенный на точку.
|
||||
PILine<Type> operator+(const PIPoint<Type> & p) { return translated(p); }
|
||||
|
||||
//! \~russian Сдвинуть линию по двум координатам на величину координат точки \a PIPoint.
|
||||
//! \~english Returns segment shifted by the negated point offset.
|
||||
//! \~russian Возвращает отрезок, смещенный на отрицательное смещение точки.
|
||||
PILine<Type> operator-(const PIPoint<Type> & p) { return translated(-p); }
|
||||
|
||||
//! \~russian Проверить равенство координат двух отрезков.
|
||||
//! \~english Checks whether segment endpoints are equal.
|
||||
//! \~russian Проверяет равенство концов отрезков.
|
||||
bool operator==(const PILine<Type> & r) const { return (p0 == r.p0 && p1 == r.p1); }
|
||||
|
||||
//! \~russian Проверить неравенство координат двух отрезков.
|
||||
//! \~english Checks whether segments differ.
|
||||
//! \~russian Проверяет различие отрезков.
|
||||
bool operator!=(const PILine<Type> & r) const { return (p1 != r.p1 || p1 != r.p1); }
|
||||
};
|
||||
|
||||
//! \~russian Перегруженный оператор для вывода координат в \a PICout.
|
||||
//! \relatesalso PICout
|
||||
//! \~english Writes segment coordinates to \a PICout.
|
||||
//! \~russian Выводит координаты отрезка в \a PICout.
|
||||
template<typename Type>
|
||||
PICout operator<<(PICout & s, const PILine<Type> & v) {
|
||||
s.space();
|
||||
@@ -186,9 +194,20 @@ PICout operator<<(PICout & s, const PILine<Type> & v) {
|
||||
return s;
|
||||
}
|
||||
|
||||
//! \~english Alias for segment with `int` coordinates.
|
||||
//! \~russian Псевдоним отрезка с координатами типа `int`.
|
||||
typedef PILine<int> PILinei;
|
||||
|
||||
//! \~english Alias for segment with `uint` coordinates.
|
||||
//! \~russian Псевдоним отрезка с координатами типа `uint`.
|
||||
typedef PILine<uint> PILineu;
|
||||
|
||||
//! \~english Alias for segment with `float` coordinates.
|
||||
//! \~russian Псевдоним отрезка с координатами типа `float`.
|
||||
typedef PILine<float> PILinef;
|
||||
|
||||
//! \~english Alias for segment with `double` coordinates.
|
||||
//! \~russian Псевдоним отрезка с координатами типа `double`.
|
||||
typedef PILine<double> PILined;
|
||||
|
||||
#endif // PILINE_H
|
||||
|
||||
Reference in New Issue
Block a user