aboutsummaryrefslogtreecommitdiff
path: root/doc/Manual/ru/BH_Line.pod
blob: ea25dbb80299a17a75cb3fa207ec1e2a7b891465 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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>