aboutsummaryrefslogtreecommitdiff
path: root/doc/Manual/ru/BH_Line.pod
diff options
context:
space:
mode:
Diffstat (limited to 'doc/Manual/ru/BH_Line.pod')
-rw-r--r--doc/Manual/ru/BH_Line.pod60
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/Manual/ru/BH_Line.pod b/doc/Manual/ru/BH_Line.pod
new file mode 100644
index 0000000..ea25dbb
--- /dev/null
+++ b/doc/Manual/ru/BH_Line.pod
@@ -0,0 +1,60 @@
+=encoding UTF-8
+
+
+=head1 НАИМЕНОВАНИЕ
+
+BH_Line - прямая на плоскости.
+
+
+=head1 СИНТАКСИС
+
+ #include <BH/Math.h>
+
+ cc prog.c -o prog -lbh
+
+
+=head1 ОПИСАНИЕ
+
+Модуль BH_Line предоставляет функции для работы с прямыми на плоскости. Он
+позволяет вычислять коэффициенты прямой по двум точкам, находить расстояние от
+точки до прямой и определять ближайшую точку на прямой к заданной точке.
+
+
+=head1 API ВЫЗОВЫ
+
+
+=head2 BH_LineFromPoints
+
+ int BH_LineFromPoints(const float a[2],
+ const float b[2],
+ float out[3]);
+
+Вычисляет коэффициенты прямой на плоскости по двум точкам I<a> и I<b>.
+
+Параметр I<out> описывает результирующую прямую на плоскости.
+
+В случае успеха функция возвращает 0, в противном случае - код ошибки.
+
+
+=head2 BH_LineDistance
+
+ float BH_LineDistance(const float line[3],
+ const float point[2]);
+
+Вычисляет расстояние от точки I<point> до прямой I<line>.
+
+
+=head2 BH_LineClosestPoint
+
+ void BH_LineClosestPoint(const float line[3],
+ const float point[2],
+ float out[2]);
+
+Вычисляет ближайшую точку на прямой I<line> к другой точке I<point>.
+
+Параметр I<out> описывает результирующую точку.
+
+
+=head1 СМ. ТАКЖЕ
+
+L<BH>