aboutsummaryrefslogtreecommitdiff
path: root/doc/Manual/ru/BH_Box2f.pod
blob: 072fc6acb79c4ed31294dba6edf3c65cb848b072 (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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
=encoding UTF-8


=head1 НАИМЕНОВАНИЕ

BH_Box2f - двухмерный ограничивающий прямоугольник


=head1 СИНТАКСИС

 #include <BH/Math/Box2f.h>

 cc prog.c -o prog -lbh


=head1 ОПИСАНИЕ

Модуль BH_Box2f предоставляет функции для работы с двухмерными ограничивающими 
прямоугольниками. Он включает в себя операции объединения, пересечения, проверки
вхождения точки в прямоугольник и вычисления ограничивающего прямоугольника по
набору точек.


=head1 API ВЫЗОВЫ


=head2 BH_Box2fUnion

 void BH_Box2fUnion(const float aMin[2],
                    const float aMax[2],
                    const float bMin[2],
                    const float bMax[2],
                    float outMin[2],
                    float outMax[2]);

Объединяет два ограничивающих прямоугольника A и B.

Параметры I<aMin> и I<aMax> описывают ограничивающий прямоугольник A.

Параметры I<bMin> и I<bMax> описывают ограничивающий прямоугольник B.

Параметры I<outMin> и I<outMax> описывают результирующий ограничивающий 
прямоугольник.


=head2 BH_Box2fIntersect

 int BH_Box2fIntersect(const float aMin[2],
                       const float aMax[2],
                       const float bMin[2],
                       const float bMax[2],
                       float outMin[2],
                       float outMax[2]);

Вычисляет пересечение двух ограничивающих прямоугольников A и B.

Параметры I<aMin> и I<aMax> описывают ограничивающий прямоугольник A.

Параметры I<bMin> и I<bMax> описывают ограничивающий прямоугольник B.

Параметры I<outMin> и I<outMax> описывают результирующий ограничивающий 
прямоугольник.

Возвращает 0 в случае успешного пересечения или код ошибки.


=head2 BH_Box2fContains

 int BH_Box2fContains(const float aMin[2],
                      const float aMax[2],
                      const float point[2]);

Проверяет, находится ли точка I<point> внутри ограничивающего прямоугольника.

Параметры I<aMin> и I<aMax> описывают ограничивающий прямоугольник.

Параметр I<point> описывает точку.

Возвращает 0, если точка находится внутри прямоугольника, или код ошибки.


=head2 BH_Box2fEnclose

 int BH_Box2fEnclose(const float *points,
                     size_t size,
                     float outMin[2],
                     float outMax[2]);

Вычисляет ограничивающий прямоугольник по заданным точкам I<points>.

Параметры I<points> и I<size> описывают входной массив точек.

Параметры I<outMin> и I<outMax> описывают результирующий ограничивающий 
прямоугольник.

Возвращает 0 в случае успешного вычисления или код ошибки.


=head1 СМ. ТАКЖЕ

L<BH>,
L<BH_Box3f>