.. role:: blue
   :class: blue

Построение двумерной косинусоиды
================================
.. _Constructing_Two-Dimensional_Cosine_Wave:

.. версия ядра: 118058

Функция  

.. code-block:: cpp

   MbResultType Cosinusoid( const MbCartPoint & point0,
                            const MbCartPoint & point1,
                                  MbCartPoint & point2,
                                  double        phase,
                                  double        waveLength,
                                  MbCurve *&    result );

выполняет построение косинусоиды (двумерной гармонической кривой).

Входными параметрами функции являются:

- **point0** — начало локальной системы координат;
- **point1** — точка на оси X локальной системы координат;
- **point2** — точка, определяющая ось Y локальной системы координат;
- **phase** — сдвиг фазы гармонической кривой (в радианах);
- **waveLength** — длина волны косинусоиды в единицах локальной системы координат.

Выходным параметром функции является указатель **result** на построенную двумерную кривую типа :blue:`MbCurve`, представляющую косинусоиду.

При успешном завершении работы функция возвращает :blue:`rt_Success`, в противном случае функция возвращает код ошибки из перечисления :ref:`MbResultType <MbResultType>`.

Функция объявлена в файле *action_curve.h*.

Точки **point0**, **point1** и **point2** определяют локальную систему координат косинусоиды. Начало локальной системы координат косинусоиды будет расположено в точке **point0**, ось **axisX** локальной системы координат будет направлена из точки **point0** в точку **point1**, ось **axisY** локальной системы координат будет ортогональна оси **axisX** и направлена из точки **point0** в сторону точки **point2**.

Точки **point0**, **point1** и **point2** не должны совпадать или лежать на одной прямой.

Двумерная косинусоида описана в параграфе :ref:`Двумерная косинусоида MbCosinusoid <MbCosinusoid_Two-Dimensional_Cosine_Wave>`.

Амплитуда косинусоиды равна длине проекции вектора (**point2** − **point0**) на ось **axisY**. Длина волны косинусоиды равна **waveLength**. Число волн косинусоиды определяется расстоянием между точками **point0** и **point1**.

Параметр **phase** определяет сдвиг фазы косинусоиды:

.. figure:: /MODELER/TWO-DIMENSIONAL_CURVE_CONSTRUCTION_METHODS/pictures/M.3.6.1.png
   :width: 15cm
   :align: center