.. oe:namespace:: OESystem


.. meta::
   :keywords: OEExponentColorGradient, ExponentColorGradient


.. _OESystem_OEExponentColorGradient:

.. oe:class:: OEExponentColorGradient

   .. oe:api::

      class OEExponentColorGradient : public OEColorGradientBase

   The :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` class interpolates between colors that
   are defined by using the OEColorStop class.
   The :oe:meth:`OESystem::OEExponentColorGradient::TransformValue` method
   defines the transformation that is performed before returning an
   interpolated color associated with a floating point value.
   The :ref:`Figure: Example of various exponent color gradients
   <figure_OEExponentColorGradient>`
   illustrates the difference between :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>`
   objects constructed with the same color stops but with different *exponent* values.
   An :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` object constructed with `1.0`
   *exponent* value is equivalent to an :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
   object constructed with the same color stops.

   .. _figure_OEExponentColorGradient:

   .. figure:: ../images/OEExponentAndLinearColorGradient.*
      :align:  center

      **Example of various exponent color gradients** generated with (-2.0, OERed), (0.0,
      OEWhite) and (+2.0, OEBlue) color stops

   .. seealso::

      * :ref:`OEColorStop <OESystem_OEColorStop>` class
      * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` class
      * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class
      * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` class


   The following methods are publicly inherited from :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`:

   ======================================================================= ======================================================================= ========================================================================
   :oe:meth:`operator=<OESystem::OEColorGradientBase::operator=>`          :oe:meth:`GetMaxColor<OESystem::OEColorGradientBase::GetMaxColor>`      :oe:meth:`GetStops<OESystem::OEColorGradientBase::GetStops>`            
   :oe:meth:`AddStop<OESystem::OEColorGradientBase::AddStop>`              :oe:meth:`GetMaxValue<OESystem::OEColorGradientBase::GetMaxValue>`      :oe:meth:`IsEmpty<OESystem::OEColorGradientBase::IsEmpty>`              
   :oe:meth:`DeleteStop<OESystem::OEColorGradientBase::DeleteStop>`        :oe:meth:`GetMinColor<OESystem::OEColorGradientBase::GetMinColor>`      :oe:meth:`NumStops<OESystem::OEColorGradientBase::NumStops>`            
   :oe:meth:`GetColorAt<OESystem::OEColorGradientBase::GetColorAt>`        :oe:meth:`GetMinValue<OESystem::OEColorGradientBase::GetMinValue>`      :oe:meth:`TransformValue<OESystem::OEColorGradientBase::TransformValue>`
   ======================================================================= ======================================================================= ========================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OEExponentColorGradient(double exponent)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentColorGradient(exponent: float) -> OEExponentColorGradient

      Constructor that creates an "empty" color gradient with the given
      *exponent* value.

      *exponent*
        The given value is clamped into the range of ``[0.1, 10.0]``.

      .. note::

         An "empty" color gradient always returns the :oe:const:`OEBlack<OESystem::OESystem::OEBlack>`
         color, when calling the :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`,
         the :oe:meth:`OESystem::OEColorGradientBase::GetMinColor` or
         the :oe:meth:`OESystem::OEColorGradientBase::GetMaxColor` methods.

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

         .. oe:api::

            OEExponentColorGradient(double exponent, const OEColorStop& oneStop)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentColorGradient(exponent: float, oneStop: OEColorStop) -> OEExponentColorGradient

      Creates an :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` object with
      one color stop and an *exponent* value.
      An :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>`  object that
      has only one color stop will always return that color when calling the
      :oe:meth:`OESystem::OEColorGradientBase::GetColorAt` method.

      *exponent*
        The given value is clamped into the range of ``[0.1, 10.0]``.

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

         .. oe:api::

            OEExponentColorGradient(double exponent,
                                    const OEColorStop& bgnStop,
                                    const OEColorStop& endStop)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentColorGradient(exponent: float, bgnStop: OEColorStop,
                                    endStop: OEColorStop) -> OEExponentColorGradient

      Creates an :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` object with
      interpolation range between the two specified color stops using the
      given *exponent* value.

      *exponent*
        The given value is clamped into the range of ``[0.1, 10.0]``.

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

         .. oe:api::

            OEExponentColorGradient(const OEExponentColorGradient& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEExponentColorGradient(rhs: OEExponentColorGradient) -> OEExponentColorGradient

      Copy constructors.


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

      .. oe:api::

         OEExponentColorGradient &operator=(const OEExponentColorGradient &rhs)


      Assignment operator.

   .. oe:method:: GetExponent

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

         .. oe:api::

            double GetExponent() const

      .. oe:language:: python

         .. oe:api:: python

            GetExponent() -> float

      Returns the *exponent* value used in the
      :oe:meth:`OESystem::OEExponentColorGradient::TransformValue` method.


   .. oe:method:: SetExponent

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

         .. oe:api::

            void SetExponent(double exponent)

      .. oe:language:: python

         .. oe:api:: python

            SetExponent(exponent: float) -> None

      Sets the *exponent* value used in the
      :oe:meth:`OESystem::OEExponentColorGradient::TransformValue` method.

      *exponent*
        The given value is clamped into the range of ``[0.1, 10.0]``.


   .. oe:method:: TransformValue

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

         .. oe:api::

            double TransformValue(double value) const

      .. oe:language:: python

         .. oe:api:: python

            TransformValue(value: float) -> float

      Performs a
      :math:`f(x) = -x^y` transformation when x is less than 0.0 and
      :math:`f(x) = x^y` transformation when x is greater than 0.0, where
      the :math:`y` is the exponent returned by
      :oe:meth:`OESystem::OEExponentColorGradient::GetExponent` method.
      This method is called by :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`
      method to transform a value before performing color interpolation.
