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