.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEShape

.. meta::
   :keywords: OEHermiteOverlayOptions, HermiteOverlayOptions


.. _OEShape_OEHermiteOverlayOptions:

.. oe:class:: OEHermiteOverlayOptions
   
   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHermiteOverlayOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for :ref:`OEHermiteOverlay <OEShape_OEHermiteOverlay>`.

   The :ref:`OEHermiteOverlayOptions <OEShape_OEHermiteOverlayOptions>` class defines the following public methods:
    * :oe:meth:`GetHermiteOptions<OEShape::OEHermiteOverlayOptions::GetHermiteOptions>` and
      :oe:meth:`SetHermiteOptions<OEShape::OEHermiteOverlayOptions::SetHermiteOptions>`
    * :oe:meth:`GetMaxOptSteps<OEShape::OEHermiteOverlayOptions::GetMaxOptSteps>` and
      :oe:meth:`SetMaxOptSteps<OEShape::OEHermiteOverlayOptions::SetMaxOptSteps>`
    * :oe:meth:`GetStarts<OEShape::OEHermiteOverlayOptions::GetStarts>` and 
      :oe:meth:`SetStarts<OEShape::OEHermiteOverlayOptions::SetStarts>`
   
   
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHermiteOverlayOptions()
            OEHermiteOverlayOptions(const OEHermiteOverlayOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEHermiteOverlayOptions() -> OEHermiteOverlayOptions
            OEHermiteOverlayOptions(arg2: OEHermiteOverlayOptions) -> OEHermiteOverlayOptions

      Default and copy constructors.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEHermiteOverlayOptions &operator=(const OEHermiteOverlayOptions &)

.. _OEShape_OEHermiteOverlayOptions_GetHermiteOptions:

      Assignment operator.


   .. oe:method:: GetHermiteOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEHermiteOptions& GetHermiteOptions()
            const OEHermiteOptions& GetHermiteOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetHermiteOptions() -> OEHermiteOptions

      See the :oe:meth:`SetHermiteOptions<OEShape::OEHermiteOverlayOptions::SetHermiteOptions>` method.

.. _OEShape_OEHermiteOverlayOptions_GetMaxOptSteps:

   .. oe:method:: GetMaxOptSteps

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned GetMaxOptSteps() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxOptSteps() -> int

      See the :oe:meth:`SetMaxOptSteps<OEShape::OEHermiteOverlayOptions::SetMaxOptSteps>` method.

.. _OEShape_OEHermiteOverlayOptions_GetStarts:

   .. oe:method:: GetStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEStarts& GetStarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetStarts() -> OEStarts

      See the :oe:meth:`SetStarts<OEShape::OEHermiteOverlayOptions::SetStarts>` method.

.. _OEShape_OEHermiteOverlayOptions_SetHermiteOptions:

   .. oe:method:: SetHermiteOptions

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetHermiteOptions(const OEHermiteOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetHermiteOptions(opts: OEHermiteOptions) -> None

      Sets the Hermite parameters that control the :ref:`Hermite expansion <shapetk_hermite_section>` of reference and fit objects via the :ref:`OEHermiteOptions <OEShape_OEHermiteOptions>` class.

.. _OEShape_OEHermiteOverlayOptions_SetMaxOptSteps:

   .. oe:method:: SetMaxOptSteps

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetMaxOptSteps(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxOptSteps(value: int) -> bool

      Sets the maximum number of optimization iteration steps.
      Default: `200`.

.. _OEShape_OEHermiteOverlayOptions_SetStarts:

   .. oe:method:: SetStarts

      .. oe:language:: c++ java csharp

         .. oe:api::

            void SetStarts(const OEStarts&)

      .. oe:language:: python

         .. oe:api:: python

            SetStarts(argStarts: OEStarts) -> None

      Set the starts by passing in an :ref:`OEStarts <OEShape_OEStarts>`
      instance. This defines the starts to be used for optimization.


