Актуализация документации по проекту
This commit is contained in:
parent
ed404690ed
commit
8ba075b557
16 changed files with 279 additions and 222 deletions
|
|
@ -1,24 +1,24 @@
|
|||
# Указание координат трёхмерного вектора
|
||||
# Задание координат трёхмерного вектора.
|
||||
|
||||
[English version / Английская версия](set-values-eng.md)
|
||||
[English version / Английская версия](set-values-eng.md)
|
||||
|
||||
Указать координаты векторов можно как напрямую, так и спомощью функций.
|
||||
Принципиальной разницы нет, но функции указания координат позволяют сделать это
|
||||
одной строкой.
|
||||
|
||||
Функция для **BGC_FP32_Vector3**:
|
||||
Функция для **BGC_FP32_Vector3**:
|
||||
|
||||
```c
|
||||
inline void bgc_fp32_vector3_set_values(BGC_FP32_Vector3* const destination, const float x, const float y, const float z);
|
||||
```
|
||||
|
||||
Функция для **BGC_FP64_Vector3**:
|
||||
Функция для **BGC_FP64_Vector3**:
|
||||
|
||||
```c
|
||||
inline void bgc_fp64_vector3_set_values(BGC_FP64_Vector3* const destination, const double x, const double y, const double z);
|
||||
```
|
||||
|
||||
Каждая из данных функции эквивалентна следующим строкам кода:
|
||||
Данные функции позволяют задать значения координат вектора одной строкой.
|
||||
|
||||
Такая возможность может быть удобна, когда нужно указать значения координат с помощью числовых констант как в примере ниже.
|
||||
|
||||
Каждая из функций аналогична следующим трём строкам кода:
|
||||
|
||||
```c
|
||||
destination->x = x;
|
||||
|
|
@ -26,14 +26,18 @@ destination->y = y;
|
|||
destination->z = z;
|
||||
```
|
||||
|
||||
В параметре **destination** не следует передавать некорректные указатели.
|
||||
Значение NULL (0) также считается некорректным.
|
||||
### Параметры
|
||||
|
||||
Данная функция хорошо подходит для заданя значений координат вектора одной
|
||||
строкой. Особенно если надо указать фиксированные значения координат как
|
||||
в примере ниже.
|
||||
| Параметр | Направление | Описание |
|
||||
| ----------- | ----------- | -------------------------------------------------------------- |
|
||||
| destination | исходящий | Указатель на вектор, координаты которого будут заданы функцией |
|
||||
| x | входящий | Значение координаты X |
|
||||
| y | входящий | Значение координаты Y |
|
||||
| z | входящий | Значение координаты Z |
|
||||
|
||||
Пример применения:
|
||||
Параметр *destination* должен быть корректным указателем. Значение NULL (0) считается некорректным.
|
||||
|
||||
### Пример
|
||||
|
||||
```c
|
||||
#include <stdio.h>
|
||||
|
|
@ -43,7 +47,7 @@ int main()
|
|||
{
|
||||
BGC_FP32_Vector3 v;
|
||||
|
||||
bgc_fp32_vector3_set_values(&v, -2.2f, 7.1f, 10.01f);
|
||||
bgc_fp32_vector3_set_values(&v, -2.2f, 7.8f, 10.01f);
|
||||
|
||||
printf("x = %f, y = %f, z = %f\n", v.x, v.y, v.z);
|
||||
|
||||
|
|
@ -51,4 +55,4 @@ int main()
|
|||
}
|
||||
```
|
||||
|
||||
[Документация](../intro-rus.md) / [3D векторы](../vector3-rus.md)
|
||||
[Документация](../intro-rus.md) / [Трёхмерные векторы](../vector3-rus.md)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue